Updates on docs

Author: AlexRogalskiy

.pre-commit-config.yaml

@@ -1,5 +1,8 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
 ---
-# https://pre-commit.com/
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
 default_stages: [commit, push]
 default_language_version:
   # force all unspecified Python hooks to run python3

.yaml-lint.yml

@@ -1,18 +1,32 @@
+# -*- coding: utf-8 -*-
+# vim: ft=yaml
 ---
 # https://yamllint.readthedocs.io/en/stable/index.html
 # yamllint --strict -c .yaml-lint.yml .
 
-extends: default
+# Extend the `default` configuration provided by `yamllint`
+extends: 'default'
 
 locale: en_US.UTF-8
 
+# Files to ignore completely
+# 1. All YAML files under directory `node_modules/'
+# 2. All YAML files under directory `tilt_modules/'
+# 3. All YAML files under directory `okteto/'
+# 4. All YAML files under directory `charts/'
+# 5. All YAML files under directory `k8s/'
 ignore: |
   node_modules/
   tilt_modules/
   okteto/
   charts/
   k8s/
 
+yaml-files:
+  # Default settings
+  - '*.yaml'
+  - '*.yml'
+
 rules:
   # 150 chars should be enough, but don't fail if a line is longer
   line-length:
@@ -39,14 +53,18 @@ rules:
   comments-indentation:
     level: warning
   empty-lines: enable
-  empty-values: disable
   hyphens: enable
   key-duplicates: enable
   key-ordering: disable
   new-line-at-end-of-file: enable
   new-lines: enable
-  octal-values: disable
+  octal-values:
+    forbid-implicit-octal: true
+    forbid-explicit-octal: true
   quoted-strings: disable
   trailing-spaces: enable
   truthy:
     level: warning
+  empty-values:
+    forbid-in-block-mappings: true
+    forbid-in-flow-mappings: true

README.md

@@ -51,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>

commitlint.config.js

@@ -15,4 +15,11 @@
  */
 'use strict';
 
-module.exports = { extends: ['@commitlint/config-conventional'] };
+module.exports = {
+	extends: ['@commitlint/config-conventional'],
+	rules: {
+		'body-max-line-length': [2, 'always', 120],
+		'footer-max-line-length': [2, 'always', 120],
+		'header-max-length': [2, 'always', 72],
+	},
+};

docs/README.md

@@ -51,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>

mkdocs.yml

@@ -104,7 +104,8 @@ plugins:
       version_selector: true # set to false to leave out the version selector
       css_dir: css # the directory to put the version selector's CSS
       javascript_dir: js # the directory to put the version selector's JS
-      canonical_version: null # the version for <link rel="canonical">; `null`
+      canonical_version:
+        null # the version for <link rel="canonical">; `null`
         # uses the version specified via `mike deploy`
   - mermaid2
   - search:
@@ -251,6 +252,8 @@ markdown_extensions:
           class: mermaid
           format:
             !!python/name:pymdownx.superfences.fence_div_format # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#tabbed
+
+
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.details: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#details

package.json

@@ -40,14 +40,15 @@
 		"check-for-leaks": "^1.2.1",
 		"colors": "^1.4.0",
 		"conventional-changelog-cli": "^2.1.1",
+		"cost-of-modules": "1.0.1",
 		"csvnorm": "^1.1.0",
 		"danger-plugin-spellcheck": "^2.1.0",
 		"deploy-to-gh-pages": "^1.3.7",
 		"dockerfile_lint": "^0.3.4",
 		"execa": "^5.1.1",
 		"git-cz": "^4.7.6",
 		"gitbook-cli": "^2.3.2",
-        "github-contributors-list": "^1.2.5",
+		"github-contributors-list": "^1.2.5",
 		"husky": "^7.0.1",
 		"import-conductor": "^2.4.0",
 		"is-ci": "^3.0.1",
@@ -163,7 +164,8 @@
 		"contribs": "all-contributors",
 		"contribs:add": "all-contributors add",
 		"contribs:generate": "all-contributors generate && cp .all-contributorsrc ./docs/contributors.json",
-        "contributors": "githubcontrib --repo java-patterns --owner AlexRogalskiy --format html --sortOrder desc > docs/contributors.html",
+		"contributors": "githubcontrib --repo java-patterns --owner AlexRogalskiy --format html --sortOrder desc > docs/contributors.html",
+		"cost-of-modules": "cost-of-modules --less --no-install --include-dev",
 		"crowdin:download": "crowdin --config crowdin.yml download -b $(git rev-parse --abbrev-ref HEAD)",
 		"crowdin:pull": "crowdin pull --skip-untranslated-strings",
 		"crowdin:upload": "crowdin --config crowdin.yml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",