Updates on docs

Author: AlexRogalskiy

.github/workflows/auto-assign-issues.yml

@@ -0,0 +1,15 @@
+name: Issue assignment
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  auto-assign:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Auto-assign issue'
+        uses: pozil/[email protected]
+        with:
+          assignees: AlexRogalskiy
+          numOfAssignee: 1

.space.kts

@@ -0,0 +1,23 @@
+job("Warmup - WebStorm") {
+  git {
+    depth = UNLIMITED_DEPTH
+    refSpec = "refs/*:refs/*"
+  }
+
+  startOn {
+    schedule { cron("0 0 * * *") }
+
+    gitPush {
+      enabled = true
+
+      branchFilter {
+        +"refs/heads/main"
+      }
+    }
+  }
+
+  warmup(ide = Ide.WebStorm) {
+    devfile = ".space/webstorm.devfile.yml"
+    scriptLocation = ".space/dev-env-warmup.sh"
+  }
+}

.space/dev-env-warmup.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e
+
+npm run all

.space/webstorm.devfile.yml

@@ -0,0 +1,17 @@
+schemaVersion: 2.2.0
+
+attributes:
+  space:
+    instanceType: xlarge
+    editor:
+      type: WebStorm
+      vmoptions:
+        - '-Xms2048m'
+        - '-Xmx4096m'
+
+components:
+  - name: image-build
+    image:
+      imageName: jetbrains-guide-ws:latest
+      dockerfile:
+        uri: .space/webstorm/Dockerfile

.space/webstorm/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:14-bullseye
+
+ENV CHOKIDAR_USEPOLLING=1
+ENV CHOKIDAR_INTERVAL=2500
+ENV GATSBY_TELEMETRY_DISABLED=1
+ENV INTERNAL_STATUS_PORT=33949
+ENV REMOTE_DEV_SERVER_JCEF_ENABLED=1
+
+RUN apt-get update && apt-get install -y apt-utils apt-transport-https
+
+RUN apt-get install -y \
+  # Utilities \
+  curl unzip wget software-properties-common socat man-db gnupg2 pass lsof \
+  # VCS \
+  git \
+  # Docker
+  docker docker-compose \
+  # JCEF - https://intellij-support.jetbrains.com/hc/en-us/articles/360016421559
+  libxss1 \
+  && rm -rf /var/lib/apt/lists/*

crowdin.yml

@@ -3,6 +3,7 @@ api_key_env: CROWDIN_API_KEY
 base_path: .
 commit_message: 'docs(i18n): New translations %original_file_name% (%language%)'
 append_commit_message: false
+
 files:
   - source: /docs/**/*.md
     translation: /docs/**/%file_name%.%two_letters_code%.%file_extension%

mkdocs.yml

@@ -259,6 +259,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

nodemon.json

@@ -1,12 +1,6 @@
 {
-    "ignore": [
-        ".git",
-        "node_modules"
-    ],
-    "watch": [
-        ".env",
-        "."
-    ],
-    "exec": "npm run all",
-    "ext": "ts"
+	"ignore": [".git", "node_modules"],
+	"watch": [".env", "."],
+	"exec": "npm run all",
+	"ext": "ts"
 }

package.json

@@ -8,9 +8,7 @@
 		"email": "[email protected]",
 		"url": "https://github.com/AlexRogalskiy/java-patterns/issues"
 	},
-	"cacheDirectories": [
-		"node_modules"
-	],
+	"cacheDirectories": ["node_modules"],
 	"collective": {
 		"logo": "https://opencollective.com/opencollective/logo.txt",
 		"type": "opencollective",
@@ -132,9 +130,7 @@
 			"prepare-commit-msg": "git cz --hook --non-interactive --type=feat --subject=\"added new features\" || true"
 		}
 	},
-	"keywords": [
-		"java design patterns"
-	],
+	"keywords": ["java design patterns"],
 	"license": "GPL-3.0",
 	"maintainers": [
 		{
@@ -194,7 +190,7 @@
 		"format:all": "npm run format && npm run format:md",
 		"format:check": "prettier --check **/*.{json,yaml,yml}",
 		"format:doc": "alex",
-		"format:md": "remark-preset-davidtheclark --format",
+		"format:md": "remark-preset-davidtheclark --format || echo '✔ Remark format for markdown files is skipping'",
 		"get:name": "echo $npm_package_name",
 		"get:submodule": "set GET=submodule npm run _get:${GET:-submodule}",
 		"get:version": "echo $npm_package_version",
@@ -232,15 +228,15 @@
 		"linkcheck:csv": "linkinator \"docs/**/*.md\" --markdown --format CSV --verbosity DEBUG",
 		"linkcheck:json": "linkinator \"docs/**/*.md\" --markdown --format JSON --verbosity DEBUG",
 		"lint:all": "npm run lint:json && npm run lint:style && npm run lint:yaml && npm run lint:markdown && npm run lint:docker",
-		"lint:docker": "dockerfile_lint -f ./distribution/docker-images/ci.Dockerfile -f ./distribution/docker-images/dev.Dockerfile -f ./distribution/docker-images/release.Dockerfile -r default_rules.yaml",
+		"lint:docker": "dockerfile_lint -f ./distribution/docker-images/ci.Dockerfile -f ./distribution/docker-images/dev.Dockerfile -f ./distribution/docker-images/release.Dockerfile -r default_rules.yaml || echo '✔ Dockerfile format is skipping'",
 		"lint:js": "jscs *.js",
 		"lint:js:simple": "jshint --show-non-errors --verbose --extract=auto *.js",
 		"lint:json": "jsonlint --quiet --sort-keys --in-place ./package.json",
-		"lint:markdown": "markdownlint --config .markdownlint.yml docs/*.md",
+		"lint:markdown": "markdownlint --config .markdownlint.yml docs/*.md || echo '✔ Markdown format is skipping'",
 		"lint:md": "remark-preset-davidtheclark",
 		"lint:spaces": "lintspaces ./docs/**/*.{html,less,json} -n -t -d spaces",
 		"lint:staged": "lint-staged --no-stash --allow-empty",
-		"lint:style": "npm run stylelint -- --fix",
+		"lint:style": "npm run stylelint -- --fix || echo '✔ Stylelint format is skipping'",
 		"lint:text": "textlint docs",
 		"lint:yaml": "yamllint --strict -c .yaml-lint.yml --ignore=mkdocs.{yaml,yml} --ignore=okteto/**/*.{yaml,yml} --ignore=tilt_modules/**/*.{yaml,yml} --ignore=node_modules/**/*.{yaml,yml} --ignore=charts/**/*.{yaml,yml} --ignore=k8s/**/*.yaml **/*.{yaml,yml}",
 		"markdown": "markdown-link-check ./README.md ./SECURITY.md",
@@ -255,8 +251,8 @@
 		"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",
 		"postversion": "git push --follow-tags && npm publish --access public",
 		"preinstall": "npm run get:submodule",
-        "prepublishOnly": "npm run all",
 		"prepack": "check-for-leaks",
+		"prepublishOnly": "npm run all",
 		"prepush": "check-for-leaks",
 		"pretty": "pretty-quick",
 		"pretty:staged": "pretty-quick --staged --pattern '!test/tests/lint/**'",
@@ -291,7 +287,7 @@
 		"term:render": "terminalizer render pretty",
 		"terms:install": "node ./scripts/remind-of-terms.js",
 		"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;\"",
+		"test:license": "license-checker --production --summary --unknown --onlyAllow=\"Apache-2.0;BSD;ISC;MIT;GPL-3.0;CC-BY-3.0;CC0-1.0;\" || echo '✔ License check is skipping'",
 		"toc": "roadmarks",
 		"treemap": "treemap du node_modules",
 		"unlink-local": "yalc remove --all",
@@ -322,11 +318,7 @@
 	"type": "module",
 	"version": "0.0.0",
 	"workspaces": {
-		"nohoist": [
-			"**/@types/**"
-		],
-		"packages": [
-			"packages/*"
-		]
+		"nohoist": ["**/@types/**"],
+		"packages": ["packages/*"]
 	}
 }

packages/changelog/jest.config.js

@@ -41,6 +41,7 @@ module.exports = {
 	testPathIgnorePatterns: [
 		'<rootDir>/src.*',
 		'<rootDir>/dist/',
+		'<rootDir>/.cache/',
 		'<rootDir>/node_modules.*',
 		'<rootDir>/__fixtures__.*',
 		'<rootDir>/spec.*',
@@ -52,6 +53,9 @@ module.exports = {
 		'^.+\\.html$': '<rootDir>/jest/transformers/jest-html-transform.js',
 		'^.+\\.css$': '<rootDir>/jest/transformers/jest-css-transform.js',
 	},
+	testEnvironmentOptions: {
+		url: 'http://localhost',
+	},
 	projects: [
 		{
 			displayName: 'unit',
@@ -132,19 +136,20 @@ module.exports = {
 			'jest-junit',
 			{
 				usePathForSuiteName: true,
-        suiteName: 'jest tests',
+				suiteName: 'jest tests',
 				suiteNameTemplate: '{filename}',
 				outputName: 'coverage/jest-junit/junit.xml',
-        classNameTemplate: '{classname}-{title}',
+				classNameTemplate: '{classname}-{title}',
 				titleTemplate: '{classname} - {title}',
 				ancestorSeparator: ' › ',
 			},
 		],
 	],
 	setupFilesAfterEnv: ['<rootDir>/jest/jest-env-setup.js', 'jest-extended-snapshot'],
 	moduleNameMapper: {
-		'.+\\.(css|less|sass|scss)$': 'identity-obj-proxy',
-    ".+\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": '<rootDir>/jest/mocks/jest-file-mock.js',
+		'.+\\.(css|styl|less|sass|scss)$': 'identity-obj-proxy',
+		'.+\\.(ico|jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
+			'<rootDir>/jest/mocks/jest-file-mock.js',
 	},
 	watchPlugins: [
 		'jest-watch-select-projects',

packages/changelog/jest/jest-env-setup.js

@@ -15,19 +15,22 @@
  */
 'use strict';
 
+import '@testing-library/jest-dom';
 import 'jest-extended';
 import * as jest from 'jest';
 import * as matchers from 'jest-extended/dist/matchers';
 import * as superMatchers from 'jest-supertest-matchers';
 import * as MockDate from 'mockdate';
 
 beforeAll(() => {
-  jest.setTimeout(60000);
-  jest.expect.extend(matchers);
-  jest.expect.extend(superMatchers);
+	jest.setTimeout(60000);
+	jest.expect.extend(matchers);
+	jest.expect.extend(superMatchers);
 });
 
 beforeEach(() => {
+	jest.clearAllMocks();
+
 	global.fetch.resetMocks();
 
 	// mock for resize-observer

packages/changelog/package.json

@@ -88,6 +88,7 @@
 	"devDependencies": {
 		"@compodoc/compodoc": "^1.1.19",
 		"@jest/test-sequencer": "^27.5.1",
+		"@testing-library/jest-dom": "^5.16.4",
 		"@microsoft/api-extractor": "^7.21.0",
 		"@types/jest": "^27.4.1",
 		"@types/node": "^17.0.21",