Updates on docs

Author: AlexRogalskiy

.pre-commit-config.yaml

@@ -11,6 +11,23 @@ repos:
     hooks:
       - id: pip-compile-multi-verify
 
+  - repo: https://github.com/lovesegfault/beautysh
+    rev: v6.1.0
+    hooks:
+      - id: beautysh
+        args: [-i, '2']
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+      - id: python-use-type-annotations
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.8.0
+    hooks:
+      - id: isort
+        args: [--profile=black, -l=99]
+
   - repo: meta
     hooks:
       - id: identity
@@ -30,16 +47,19 @@ repos:
       - id: fix-byte-order-marker
       - id: mixed-line-ending
       - id: trailing-whitespace
+
   # - repo: https://github.com/Lucas-C/pre-commit-hooks
   #  rev: v1.1.10
   #  hooks:
   #    - id: forbid-tabs
   #    - id: remove-tabs
+
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 2.1.5
     hooks:
       - id: shellcheck
       # - id: shfmt
+
   - repo: https://github.com/codespell-project/codespell
     rev: v2.0.0
     hooks:
@@ -56,6 +76,7 @@ repos:
   #      entry: markdownlint -c .github/linters/.markdown-lint.yml .
   #      types: [markdown]
   #      files: \.(md|mdown|markdown)$
+
   # - repo: https://github.com/adrienverge/yamllint
   #  rev: v1.26.1
   #  hooks:

.pre-commit-hooks.yaml

@@ -6,3 +6,9 @@
   pass_filenames: false
   require_serial: true
   types: [file, non-executable, text]
+- id: dead-url
+  name: Dead URL Checker
+  entry: scripts/link-check.sh
+  language: script
+  types: [text]
+  description: This hook searches for problematic URLs.

.restyled.yaml

@@ -0,0 +1,56 @@
+enabled: true
+auto: false
+
+# Open Restyle PRs?
+pull_requests: true
+
+# Leave comments on the original PR linking to the Restyle PR?
+comments: true
+
+# Set commit statuses on the original PR?
+statuses:
+  # Red status in the case of differences found
+  differences: true
+  # Green status in the case of no differences found
+  no_differences: true
+  # Red status if we encounter errors restyling
+  error: true
+
+# Request review on the Restyle PR?
+#
+# Possible values:
+#
+#   author: From the author of the original PR
+#   owner: From the owner of the repository
+#   none: Don't
+#
+# One value will apply to both origin and forked PRs, but you can also specify
+# separate values.
+#
+#   request_review:
+#     origin: author
+#     forked: owner
+#
+request_review: author
+
+# Add labels to any created Restyle PRs
+#
+# These can be used to tell other automation to avoid our PRs.
+#
+labels: ['Skip CI']
+
+# Labels to ignore
+#
+# PRs with any of these labels will be ignored by Restyled.
+#
+# ignore_labels:
+#   - restyled-ignore
+
+# Restylers to run, and how
+restylers:
+  - name: prettier
+    image: restyled/restyler-prettier:v1.19.1-2
+    arguments: ['--write']
+    include:
+      - 'assets/*.json'
+      - './**/*.{yaml,yml,md,json}'

.zenodo.json

@@ -0,0 +1,39 @@
+{
+	"description": "\ud83c\udfc6 Java4You Design patterns",
+	"license": "GPL-3.0",
+	"title": "Java Design Patterns Documentation",
+	"version": "v1.6",
+	"upload_type": "software",
+	"publication_date": "2022-04-28",
+	"keywords": ["java", "design-patterns", "java4you"],
+	"contributors": [
+		{
+			"name": "Alexander Rogalsky",
+			"type": "Other",
+			"affiliation": "SensibleMetrics, Inc."
+		}
+	],
+	"creators": [
+		{
+			"affiliation": "WildBees.Labs",
+			"name": "Alexander"
+		},
+		{
+			"affiliation": "@whitesource",
+			"name": "WhiteSource Renovate"
+		}
+	],
+	"access_right": "open",
+	"related_identifiers": [
+		{
+			"scheme": "url",
+			"identifier": "https://github.com/AlexRogalskiy/java-patterns/tree/v1.6",
+			"relation": "isSupplementTo"
+		},
+		{
+			"scheme": "doi",
+			"identifier": "10.5281/zenodo.6502338",
+			"relation": "isVersionOf"
+		}
+	]
+}

README.md

@@ -33,6 +33,8 @@
 ![GitHub Repository branches](https://badgen.net/github/branches/AlexRogalskiy/java-patterns)
 ![GitHub Repository dependents](https://badgen.net/github/dependents-repo/AlexRogalskiy/java-patterns)
 
+[![Discuss](https://img.shields.io/badge/-Discuss-blue)](https://github.com/AlexRogalskiy/java-patterns/discussions)
+[![DOI](https://zenodo.org/badge/329967283.svg)](https://zenodo.org/badge/latestdoi/329967283)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FAlexRogalskiy%2Fjava-patterns.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FAlexRogalskiy%2Fjava-patterns?ref=badge_shield)
 [![Renovatebot](https://badgen.net/badge/renovate/enabled/green?cache=300)](https://renovatebot.com/)
 [![Dependabot](https://img.shields.io/badge/dependabot-enabled-1f8ceb.svg?style=flat-square)](https://dependabot.com/)
@@ -49,34 +51,36 @@
 ## 🎹 _Table of contents_
 
 <!--ts-->
-   * [Java Design Patterns](#java-design-patterns)
-      * [<em>Table of contents</em>](#-table-of-contents)
-      * [<em>Summary</em>](#-summary)
-      * [<em>Documentation</em>](#-documentation)
-      * [<em>Kubernetes</em>](#-kubernetes)
-      * [<em>Statistics</em>](#-statistics)
-      * [<em>Versioning</em>](#-versioning)
-      * [<em>Authors</em>](#-authors)
-      * [<em>Contributing</em>](#-contributing)
-      * [<em>Visitor stats</em>](#-visitor-stats)
-      * [<em>Licensing</em>](#-licensing)
-      * [<em>Development Support</em>](#-development-support)
-      * [<em>Acknowledgement</em>](#-acknowledgement)
-      * [<em>OpenGraph Card</em>](#-opengraph-card)
-      * [<em>Feeds and Podcasts</em>](#-feeds-and-podcasts)
-         * [<em>Reddit posts</em>](#reddit-posts)
-         * [<em>InfoWorld posts</em>](#infoworld-posts)
-         * [<em>Let's talk posts</em>](#lets-talk-posts)
-         * [<em>Random thoughts posts</em>](#random-thoughts-posts)
-         * [<em>Better code posts</em>](#better-code-posts)
-         * [<em>Inside Java posts</em>](#inside-java-posts)
-         * [<em>Java programmer posts</em>](#java-programmer-posts)
-         * [<em>Dreamix posts</em>](#dreamix-posts)
-         * [<em>Plumbr posts</em>](#plumbr-posts)
-         * [<em>Thorben Janssen posts</em>](#thorben-janssen-posts)
-         * [<em>Redhat posts</em>](#redhat-posts)
-         * [<em>JavaCodeGeeks posts</em>](#javacodegeeks-posts)
-         * [<em>DevCases posts</em>](#devcases-posts)
+
+-   [Java Design Patterns](#java-design-patterns)
+    -   [<em>Table of contents</em>](#-table-of-contents)
+    -   [<em>Summary</em>](#-summary)
+    -   [<em>Documentation</em>](#-documentation)
+    -   [<em>Kubernetes</em>](#-kubernetes)
+    -   [<em>Statistics</em>](#-statistics)
+    -   [<em>Versioning</em>](#-versioning)
+    -   [<em>Authors</em>](#-authors)
+    -   [<em>Contributing</em>](#-contributing)
+    -   [<em>Visitor stats</em>](#-visitor-stats)
+    -   [<em>Licensing</em>](#-licensing)
+    -   [<em>Development Support</em>](#-development-support)
+    -   [<em>Acknowledgement</em>](#-acknowledgement)
+    -   [<em>OpenGraph Card</em>](#-opengraph-card)
+    -   [<em>Feeds and Podcasts</em>](#-feeds-and-podcasts)
+        -   [<em>Reddit posts</em>](#reddit-posts)
+        -   [<em>InfoWorld posts</em>](#infoworld-posts)
+        -   [<em>Let's talk posts</em>](#lets-talk-posts)
+        -   [<em>Random thoughts posts</em>](#random-thoughts-posts)
+        -   [<em>Better code posts</em>](#better-code-posts)
+        -   [<em>Inside Java posts</em>](#inside-java-posts)
+        -   [<em>Java programmer posts</em>](#java-programmer-posts)
+        -   [<em>Dreamix posts</em>](#dreamix-posts)
+        -   [<em>Plumbr posts</em>](#plumbr-posts)
+        -   [<em>Thorben Janssen posts</em>](#thorben-janssen-posts)
+        -   [<em>Redhat posts</em>](#redhat-posts)
+        -   [<em>JavaCodeGeeks posts</em>](#javacodegeeks-posts)
+        -   [<em>DevCases posts</em>](#devcases-posts)
+
 <!--te-->
 
 <div style="text-align: right"><a href="#java-design-patterns"><i>(back to top)</i></a></div>

makefiles/common.mk

@@ -213,6 +213,10 @@ else
 	override DOCKER_CPU_OPTIONS =
 endif
 
+ifeq ($(DOCKER_COMPOSE_OPTS),)
+  override DOCKER_COMPOSE_OPTS = --ansi=never
+endif
+
 ifdef DOCKER_REGISTRY
 	override DOCKER_REGISTRY = $(DOCKER_REGISTRY)/
 endif
@@ -334,6 +338,7 @@ _list-env:
 	$(AT)echo "DOCKER_ORG="$(DOCKER_ORG);
 	$(AT)echo "DOCKER_VERSION="$(DOCKER_VERSION);
 	$(AT)echo "DOCKER_CPU_OPTIONS="$(DOCKER_CPU_OPTIONS);
+	$(AT)echo "DOCKER_COMPOSE_OPTS="$(DOCKER_COMPOSE_OPTS);
 	$(AT)echo
 	$(AT)echo "==========================================";
 	$(AT)echo

package.json

@@ -7,9 +7,7 @@
 	"bugs": {
 		"url": "https://github.com/AlexRogalskiy/java-patterns/issues"
 	},
-    "cacheDirectories": [
-        "node_modules"
-    ],
+	"cacheDirectories": ["node_modules"],
 	"collective": {
 		"logo": "https://opencollective.com/opencollective/logo.txt",
 		"type": "opencollective",

scripts/docker-compose-logs.sh

@@ -22,7 +22,9 @@ set -o pipefail
 ## setup base directory
 BASE_DIR=$(dirname "$0")/..
 # DOCKER_COMPOSE_CMD stores docker compose command
-DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose || command -v docker compose)}
+DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose 2> /dev/null || command -v docker compose 2> /dev/null || type -p docker-compose)}
+# DOCKER_COMPOSE_OPTS stores docker compose options
+DOCKER_COMPOSE_OPTS=${DOCKER_COMPOSE_OPTS:-"--ansi=never"}
 
 _exit() {
   (($# > 1)) && echo "${@:2}"
@@ -32,7 +34,7 @@ _exit() {
 main() {
   echo ">>> Logging docker containers..."
 
-  $DOCKER_COMPOSE_CMD --file "${BASE_DIR}/docker-compose.yml" logs -t --follow
+  $DOCKER_COMPOSE_CMD $DOCKER_COMPOSE_OPTS --file "${BASE_DIR}/docker-compose.yml" logs -t --follow
 }
 
 main "$@"

scripts/docker-compose-ps.sh

@@ -22,12 +22,14 @@ set -o pipefail
 ## setup base directory
 BASE_DIR=$(dirname "$0")/..
 # DOCKER_COMPOSE_CMD stores docker compose command
-DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose || command -v docker compose)}
+DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose 2> /dev/null || command -v docker compose 2> /dev/null || type -p docker-compose)}
+# DOCKER_COMPOSE_OPTS stores docker compose options
+DOCKER_COMPOSE_OPTS=${DOCKER_COMPOSE_OPTS:-"--ansi=never"}
 
 main() {
   echo ">>> Processing status of docker containers..."
 
-  $DOCKER_COMPOSE_CMD --file "${BASE_DIR}/docker-compose.yml" ps
+  $DOCKER_COMPOSE_CMD $DOCKER_COMPOSE_OPTS --file "${BASE_DIR}/docker-compose.yml" ps
 }
 
 main "$@"

scripts/docker-compose-pull.sh

@@ -22,12 +22,14 @@ set -o pipefail
 ## setup base directory
 BASE_DIR=$(dirname "$0")/..
 # DOCKER_COMPOSE_CMD stores docker compose command
-DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose || command -v docker compose)}
+DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose 2> /dev/null || command -v docker compose 2> /dev/null || type -p docker-composee)}
+# DOCKER_COMPOSE_OPTS stores docker compose options
+DOCKER_COMPOSE_OPTS=${DOCKER_COMPOSE_OPTS:-"--ansi=never"}
 
 main() {
   echo ">>> Pulling docker containers..."
 
-  $DOCKER_COMPOSE_CMD --file "${BASE_DIR}/docker-compose.yml" pull --include-deps --quiet
+  $DOCKER_COMPOSE_CMD $DOCKER_COMPOSE_OPTS --file "${BASE_DIR}/docker-compose.yml" pull --include-deps --quiet
 }
 
 main "$@"

scripts/docker-compose-start.sh

@@ -22,12 +22,14 @@ set -o pipefail
 ## setup base directory
 BASE_DIR=$(dirname "$0")/..
 # DOCKER_COMPOSE_CMD stores docker compose command
-DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose || command -v docker compose)}
+DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose 2> /dev/null || command -v docker compose 2> /dev/null || type -p docker-compose)}
+# DOCKER_COMPOSE_OPTS stores docker compose options
+DOCKER_COMPOSE_OPTS=${DOCKER_COMPOSE_OPTS:-"--ansi=never"}
 
 main() {
   echo ">>> Starting docker containers..."
 
-  $DOCKER_COMPOSE_CMD --file "${BASE_DIR}/docker-compose.yml" up --detach --build --force-recreate --renew-anon-volumes
+  $DOCKER_COMPOSE_CMD $DOCKER_COMPOSE_OPTS --file "${BASE_DIR}/docker-compose.yml" up --detach --build --force-recreate --renew-anon-volumes
 }
 
 main "$@"

scripts/docker-compose-stop.sh

@@ -22,12 +22,14 @@ set -o pipefail
 ## setup base directory
 BASE_DIR=$(dirname "$0")/..
 # DOCKER_COMPOSE_CMD stores docker compose command
-DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose || command -v docker compose)}
+DOCKER_COMPOSE_CMD=${DOCKER_COMPOSE_CMD:-$(command -v docker-compose 2> /dev/null || command -v docker compose 2> /dev/null || type -p docker-compose)}
+# DOCKER_COMPOSE_OPTS stores docker compose options
+DOCKER_COMPOSE_OPTS=${DOCKER_COMPOSE_OPTS:-"--ansi=never"}
 
 main() {
   echo ">>> Stopping docker containers..."
 
-  $DOCKER_COMPOSE_CMD --file "${BASE_DIR}/docker-compose.yml" down --remove-orphans --volumes
+  $DOCKER_COMPOSE_CMD $DOCKER_COMPOSE_OPTS --file "${BASE_DIR}/docker-compose.yml" down --remove-orphans --volumes
 }
 
 main "$@"