Updates on files

Author: Alexander Rogalskiy

.upptimerc.yml

@@ -0,0 +1,34 @@
+# Change these first
+owner: AlexRogalskiy # Your GitHub organization or username, where this repository lives
+repo: java-patterns # The name of this repository
+
+sites:
+  - name: Google
+    url: https://www.google.com
+  - name: Wikipedia
+    url: https://en.wikipedia.org
+  - name: Hacker News
+    url: https://news.ycombinator.com
+  - name: Test Broken Site
+    url: https://thissitedoesnotexist.koj.co
+
+assignees: # Users to assign downtime issues (optional)
+  - AlexRogalskiy
+
+status-website:
+  # Add your custom domain name, or remove the `cname` line if you don't have a domain
+  # Uncomment the `baseUrl` line if you don't have a custom domain and add your repo name there
+#   cname: demo.upptime.js.org
+  baseUrl: /java-patterns
+  logoUrl: https://raw.githubusercontent.com/upptime/upptime.js.org/master/static/img/icon.svg
+  name: Upptime
+  introTitle: "**Upptime** is the open-source uptime monitor and status page, powered entirely by GitHub."
+  introMessage: This is a sample status page which uses **real-time** data from our [GitHub repository](https://github.com/upptime/upptime). No server required — just GitHub Actions, Issues, and Pages. [**Get your own for free**](https://github.com/upptime/upptime)
+  navbar:
+    - title: Status
+      href: /
+    - title: GitHub
+      href: https://github.com/$OWNER/$REPO
+
+# Upptime also supports notifications, assigning issues, and more
+# See https://upptime.js.org/docs/configuration

datas.csv

@@ -0,0 +1,82 @@
+{#-
+This file was automatically generated - do not edit
+-#}
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+{% set class = class ~ " md-header--lifted" %}
+{% endif %}
+<header class="{{ class }}" data-md-component="header">
+    <nav aria-label="{{ lang.t('header.title') }}" class="md-header__inner md-grid">
+        <a aria-label="{{ config.site_name }}" class="md-header__button md-logo"
+           data-md-component="logo" href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}">
+            {% include "partials/logo.html" %}
+        </a>
+        <label class="md-header__button md-icon" for="__drawer">
+            {% include ".icons/material/menu" ~ ".svg" %}
+        </label>
+        <div class="md-header__title" data-md-component="header-title">
+            <div class="md-header__ellipsis">
+                <div class="md-header__topic">
+          <span class="md-ellipsis">
+            {{ config.site_name }}
+          </span>
+                </div>
+            </div>
+        </div>
+        {% if not config.theme.palette is mapping %}
+        <form class="md-header__option" data-md-component="palette">
+            {% for option in config.theme.palette %}
+            {% set primary = option.primary | replace(" ", "-") | lower %}
+            {% set accent = option.accent | replace(" ", "-") | lower %}
+            <input %} %} %}
+                   aria-hidden="true" aria-label="{{ option.toggle.name }}" class="md-option" data-md-color-accent="{{ accent }}" data-md-color-media="{{ option.media }}" data-md-color-primary="{{ primary }}"
+                   data-md-color-scheme="{{ option.scheme }}" else endif id="__palette_{{ loop.index }}" if name="__palette" option.toggle type="radio" {%
+                   {% {%>
+            {% if option.toggle %}
+            <label class="md-header__button md-icon" for="__palette_{{ loop.index0 or loop.length }}"
+                   hidden title="{{ option.toggle.name }}">
+                {% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
+            </label>
+            {% endif %}
+            {% endfor %}
+        </form>
+        {% endif %}
+        {% if config.extra.alternate %}
+        <div class="md-header__option">
+            <div class="md-select">
+                {% set icon = config.theme.icon.alternate or "material/translate" %}
+                <button aria-label="{{ lang.t('select.language.title') }}" class="md-header__button md-icon">
+                    {% include ".icons/" ~ icon ~ ".svg" %}
+                </button>
+                <div class="md-select__inner">
+                    <ul class="md-select__list">
+                        {% for alt in config.extra.alternate %}
+                        <li class="md-select__item">
+                            <a class="md-select__link" href="{{ alt.link | url }}" hreflang="{{ alt.lang }}">
+                                {{ alt.name }}
+                            </a>
+                        </li>
+                        {% endfor %}
+                    </ul>
+                </div>
+            </div>
+        </div>
+        {% endif %}
+        {% if "search" in config["plugins"] %}
+        <label class="md-header__button md-icon" for="__search">
+            {% include ".icons/material/magnify.svg" %}
+        </label>
+        {% include "partials/search.html" %}
+        {% endif %}
+        {% if config.repo_url %}
+        <div class="md-header__source">
+            {% include "partials/source.html" %}
+        </div>
+        {% endif %}
+    </nav>
+    {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+    {% include "partials/tabs.html" %}
+    {% endif %}
+    {% endif %}
+</header>

datas.html

@@ -9,6 +9,7 @@ fontawesome-markdown>=0.2.6
 markdown-include>=0.6.0
 pymdown-extensions>=8.2
 python-markdown-math>=0.6
+mkdocs-literate-nav>=0.4.1
 mkdocs-material-extensions>=1.0
 mkdocs-git-revision-date-localized-plugin>=0.9.2
 mkdocs-awesome-pages-plugin>=2.5.0

docs/assets/images/logos/logo.svg

@@ -57,7 +57,9 @@ theme:
     - announce.dismiss
     - tabs
     - navigation.top
+    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#navigation-tabs
     - navigation.tabs.sticky
+    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/?h=navigation+tabs#anchor-tracking
     - navigation.tracking
     - navigation.sections
     - navigation.expand
@@ -126,6 +128,7 @@ plugins:
       enabled: !ENV [ENABLE_MKDOCS_SIMPLE_HOOKS, True]
       hooks:
         on_pre_build: "docs.hooks:copy_generated_files"
+  - literate-nav
 
 # Extra settings
 extra:
@@ -149,12 +152,14 @@ extra:
     default: latest
 
 # Extra css settings
+# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-css
 extra_css:
   - assets/css/customizations.css
   - assets/css/asciinema-player.css
   - assets/css/extra.css
 
 # Extra javascript settings
+# https://squidfunk.github.io/mkdocs-material/customization/?h=#additional-javascript
 extra_javascript:
   - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
   - https://unpkg.com/[email protected]/dist/mermaid.min.js
@@ -164,24 +169,29 @@ extra_javascript:
 
 # Extensions settings
 markdown_extensions:
+  # https://www.mkdocs.org/user-guide/writing-your-docs/#linking-to-pages
   - toc:
       anchorlink: true
       permalink: true
       toc_depth: 3
       slugify: !!python/name:pymdownx.slugs.uslugify
   - abbr: {}
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr#attribute-lists attr_list is required for several other features. Always enable.
   - attr_list: {}
   - def_list: {}
-  - admonition: {} # https://squidfunk.github.io/mkdocs-material/extensions/admonition/
+  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admoni
+  - admonition: {}
   - footnotes: {}
   - tables: {}
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Used for tags, setting unique templates for certain pages, and other custom frontmatter.
   - meta: {}
   - md_in_html: {}
   - mkautodoc: {}
   - codehilite: # https://squidfunk.github.io/mkdocs-material/extensions/codehilite/
       linenums: true
       use_pygments: false
       guess_lang: false
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#highlight
   - pymdownx.highlight:
       linenums: true
       extend_pygments_lang:
@@ -206,6 +216,7 @@ markdown_extensions:
       custom_checkbox: true
       clickable_checkbox: true
   - pymdownx.extra: {}
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets
   - pymdownx.snippets:
       base_path: docs/snippets
       check_paths: true
@@ -225,14 +236,18 @@ markdown_extensions:
       smart_enable: all
   - pymdownx.mark: {}
   - pymdownx.critic: {}
-  - pymdownx.inlinehilite: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#inlinehilite
-  - pymdownx.superfences: # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#superfences
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
+  - pymdownx.inlinehilite: {}
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences Superfences is required for several other features. Always enable.
+  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_div_format
-  - pymdownx.tabbed: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#tabbed
+  # 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
   - pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#configuration
       emoji_index: !!python/name:materialx.emoji.twemoji

docs/overrides/partials/footer.html renamed to docs/overrides/footer2.html

@@ -34,6 +34,7 @@
     "check-for-leaks": "^1.2.1",
     "colors": "^1.4.0",
     "conventional-changelog-cli": "^2.1.1",
+    "csvnorm": "^1.1.0",
     "danger-plugin-spellcheck": "^2.1.0",
     "deploy-to-gh-pages": "^1.3.7",
     "dockerfile_lint": "^0.3.4",
@@ -225,6 +226,7 @@
     "markdown": "markdown-link-check ./README.md ./SECURITY.md",
     "nodemon": "nodemon",
     "opencollective:install": "opencollective-postinstall || true",
+    "optimize:svgo": "find ./docs -name '*.svg' -print0 | xargs -0 -P16 -L20 npx svgo",
     "package:changelog": "npm run dev --base_dir=../../ --workspace=packages/changelog --if-present",
     "package:contributors": "npm run dev --image_dir=../../images --workspace=packages/contributors --if-present",
     "package:schema": "npm run dev --source_dir1=../../docs --source_dir2=../../docs --workspace=packages/schema --if-present",
@@ -246,7 +248,7 @@
     "script:changelog:simple": "test -f ./scripts/git_changelog.sh && . ./scripts/git_changelog.sh || echo '✔ Git changelog script is missing'",
     "script:check:branch": "test -f ./scripts/git_check_branch.sh && . ./scripts/git_check_branch.sh || echo '✔ Git check branch script is missing'",
     "script:heap": "node -e 'console.log(`node heap limit = ${require(\"v8\").getHeapStatistics().heap_size_limit / (1024 * 1024)} Mb`)'",
-    "script:history": "test -f ./scripts/git_history.sh && . ./scripts/git_history.sh && cat datas.csv | chart-csv > datas.html || echo 'Git history script is missing'",
+    "script:history": "test -f ./scripts/git_history.sh && . ./scripts/git_history.sh && csvnorm datas.csv | chart-csv > datas.html || echo 'Git history script is missing'",
     "script:name": "test -f ./scripts/package_app_name.js && node --experimental-modules --no-warnings --no-deprecation ./scripts/package_app_name.js || echo '✔ Node package name script is missing'",
     "script:notes": "test -f ./scripts/git_release_notes.sh && . ./scripts/git_release_notes.sh > NOTES.md || echo '✔ Git release notes script is missing'",
     "script:size": "test -f ./scripts/git_size.sh && . ./scripts/git_size.sh || echo '✔ Git size script is missing'",
@@ -264,6 +266,7 @@
     "test:all": "npm run test:license",
     "test:license": "license-checker --production --summary --unknown --onlyAllow=\"Apache-2.0;BSD;ISC;MIT;GPL-3.0;CC-BY-3.0;CC0-1.0;\"",
     "toc": "roadmarks",
+    "postpublish": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags",
     "treemap": "treemap du node_modules",
     "unlink-local": "yalc remove --all",
     "update": "lernaupdate",
@@ -287,4 +290,4 @@
       "packages/*"
     ]
   }
-}
+}

docs/overrides/header.html

@@ -28,6 +28,7 @@ module.exports = {
   testRunner: "jest-circus/runner",
   testPathIgnorePatterns: [
     "<rootDir>/src.*",
+    "<rootDir>/dist/",
     "<rootDir>/node_modules.*",
     "<rootDir>/__fixtures__.*",
     "<rootDir>/spec.*",
@@ -49,7 +50,8 @@ module.exports = {
     {
       displayName: "unit",
       testMatch: [
-        "**/tests/unit/**/*.[jt]s"
+        "**/tests/unit/**/__tests__/**/*.[jt]s",
+        "**/tests/unit/**/*.{spec,test}.[jt]s"
       ],
       testPathIgnorePatterns: [
         "<rootDir>/tests/unit/mock*"
@@ -96,7 +98,8 @@ module.exports = {
     {
       displayName: "e2e",
       testMatch: [
-        "**/tests/e2e/**/*.[jt]s"
+        "**/tests/e2e/**/__tests__/**/*.[jt]s",
+        "**/tests/e2e/**/*.{spec,test}.[jt]s"
       ],
       testPathIgnorePatterns: [
         "<rootDir>/tests/e2e/mock*"

docs/overrides/partials/empty.txt

@@ -0,0 +1,26 @@
+[
+  {
+    "message": "`Error` instead of `NodeApiError` or `NodeOperationError`",
+    "lintAreas": [
+      "miscellaneous"
+    ],
+    "lintIssue": "wrong",
+    "line": 100,
+    "excerpt": "new Error('Unable to find last GitHub Release tag.')",
+    "sourceFilePath": "src/index.ts",
+    "logLevel": "warning",
+    "details": "Use `NodeApiError` for unsuccessful API calls and `NodeOperationError` for functionality errors. Reference: n8n/packages/workflow/src/NodeErrors.ts"
+  },
+  {
+    "message": "@ts-ignore comment detected",
+    "lintAreas": [
+      "miscellaneous"
+    ],
+    "lintIssue": "wrong",
+    "line": 38,
+    "excerpt": "// @ts-ignore",
+    "sourceFilePath": "src/index.ts",
+    "logLevel": "warning",
+    "details": "@ts-ignore comments suppress compilation errors."
+  }
+]

docs/requirements.txt

@@ -0,0 +1,15 @@
+{
+    "target": "src/",
+    "patterns": [
+        ".ts"
+    ],
+    "sortMethod": "lineNumber",
+    "lintings": {
+        "PARAM_DESCRIPTION_MISSING_WHERE_OPTIONAL": {
+            "enabled": false
+        },
+        "NAME_WITH_NO_CAMELCASE": {
+            "enabled": false
+        }
+    }
+}