chore: synchronizing with typescript-demo-lib

Author: CMCDragonkai

.editorconfig

@@ -5,4 +5,4 @@ end_of_line = lf
 indent_style = space
 indent_size = 2
 insert_final_newline = true
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true

.eslintrc

@@ -22,7 +22,7 @@
   },
   "rules": {
     "linebreak-style": ["error", "unix"],
-    "no-empty": 0,
+    "no-empty": 1,
     "no-useless-catch": 1,
     "no-prototype-builtins": 1,
     "no-constant-condition": 0,
@@ -142,6 +142,10 @@
         "format": ["PascalCase"],
         "trailingUnderscore": "allowSingleOrDouble"
       },
+      {
+        "selector": "enumMember",
+        "format": ["PascalCase", "UPPER_CASE"]
+      },
       {
         "selector": "objectLiteralProperty",
         "format": null

.github/workflows/codesee-arch-diagram.yml

@@ -0,0 +1,87 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request_target:
+    types: [opened, synchronize, reopened]
+
+name: CodeSee Map
+
+jobs:
+  test_map_action:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    name: Run CodeSee Map Analysis
+    steps:
+      - name: checkout
+        id: checkout
+        uses: actions/checkout@v2
+        with:
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          ref: ${{ github.event.pull_request.head.ref }}
+          fetch-depth: 0
+
+      # codesee-detect-languages has an output with id languages.
+      - name: Detect Languages
+        id: detect-languages
+        uses: Codesee-io/codesee-detect-languages-action@latest
+
+      - name: Configure JDK 16
+        uses: actions/setup-java@v2
+        if: ${{ fromJSON(steps.detect-languages.outputs.languages).java }}
+        with:
+          java-version: '16'
+          distribution: 'zulu'
+
+      # CodeSee Maps Go support uses a static binary so there's no setup step required.
+
+      - name: Configure Node.js 14
+        uses: actions/setup-node@v2
+        if: ${{ fromJSON(steps.detect-languages.outputs.languages).javascript }}
+        with:
+          node-version: '14'
+
+      - name: Configure Python 3.x
+        uses: actions/setup-python@v2
+        if: ${{ fromJSON(steps.detect-languages.outputs.languages).python }}
+        with:
+          python-version: '3.10'
+          architecture: 'x64'
+
+      - name: Configure Ruby '3.x'
+        uses: ruby/setup-ruby@v1
+        if: ${{ fromJSON(steps.detect-languages.outputs.languages).ruby }}
+        with:
+          ruby-version: '3.0'
+
+      # We need the rust toolchain because it uses rustc and cargo to inspect the package
+      - name: Configure Rust 1.x stable
+        uses: actions-rs/toolchain@v1
+        if: ${{ fromJSON(steps.detect-languages.outputs.languages).rust }}
+        with:
+          toolchain: stable
+
+      - name: Generate Map
+        id: generate-map
+        uses: Codesee-io/codesee-map-action@latest
+        with:
+          step: map
+          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
+          github_ref: ${{ github.ref }}
+          languages: ${{ steps.detect-languages.outputs.languages }}
+
+      - name: Upload Map
+        id: upload-map
+        uses: Codesee-io/codesee-map-action@latest
+        with:
+          step: mapUpload
+          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
+          github_ref: ${{ github.ref }}
+
+      - name: Insights
+        id: insights
+        uses: Codesee-io/codesee-map-action@latest
+        with:
+          step: insights
+          api_token: ${{ secrets.CODESEE_ARCH_DIAG_API_TOKEN }}
+          github_ref: ${{ github.ref }}

.gitignore

@@ -2,7 +2,13 @@
 /dist
 .env*
 !.env.example
+# nix
 /result*
+/builds
+# node-gyp
+/build
+# prebuildify
+/prebuilds
 
 # Logs
 logs

.npmignore

@@ -1,15 +1,15 @@
 .*
+/*.nix
 /nix
-/pkgs.nix
-/default.nix
-/shell.nix
-/release.nix
 /tsconfig.json
 /tsconfig.build.json
 /jest.config.js
+/scripts
 /src
 /tests
 /tmp
 /docs
 /benches
+/build
+/builds
 /dist/tsbuildinfo

jest.config.js

@@ -1,24 +1,58 @@
+const path = require('path');
 const { pathsToModuleNameMapper } = require('ts-jest');
 const { compilerOptions } = require('./tsconfig');
 
+const moduleNameMapper = pathsToModuleNameMapper(compilerOptions.paths, {
+  prefix: '<rootDir>/src/',
+});
+
+// Global variables that are shared across the jest worker pool
+// These variables must be static and serializable
+const globals = {
+  // Absolute directory to the project root
+  projectDir: __dirname,
+  // Absolute directory to the test root
+  testDir: path.join(__dirname, 'tests'),
+  // Default asynchronous test timeout
+  defaultTimeout: 20000,
+  // Timeouts rely on setTimeout which takes 32 bit numbers
+  maxTimeout: Math.pow(2, 31) - 1,
+};
+
+// The `globalSetup` and `globalTeardown` cannot access the `globals`
+// They run in their own process context
+// They can however receive the process environment
+// Use `process.env` to set variables
+
 module.exports = {
+  testEnvironment: 'node',
   verbose: true,
-  roots: [
-    "<rootDir>/tests"
-  ],
-  testMatch: [
-    "**/?(*.)+(spec|test|unit.test).+(ts|tsx|js)"
-  ],
+  collectCoverage: false,
+  cacheDirectory: '<rootDir>/tmp/jest',
+  coverageDirectory: '<rootDir>/tmp/coverage',
+  roots: ['<rootDir>/tests'],
+  testMatch: ['**/?(*.)+(spec|test|unit.test).+(ts|tsx|js|jsx)'],
   transform: {
-    "^.+\\.tsx?$": "ts-jest"
+    '^.+\\.tsx?$': 'ts-jest',
+    '^.+\\.jsx?$': 'babel-jest',
   },
-  setupFiles: [
-    "<rootDir>/tests/setup.ts"
+  reporters: [
+    'default',
+    ['jest-junit', { outputDirectory: '<rootDir>/tmp/junit' }],
   ],
-  globalSetup: "<rootDir>/tests/globalSetup.ts",
-  globalTeardown: "<rootDir>/tests/globalTeardown.ts",
-  moduleNameMapper: pathsToModuleNameMapper(
-    compilerOptions.paths,
-    { prefix: "<rootDir>/src/" }
-  )
+  collectCoverageFrom: ['src/**/*.{ts,tsx,js,jsx}', '!src/**/*.d.ts'],
+  coverageReporters: ['text', 'cobertura'],
+  globals,
+  // Global setup script executed once before all test files
+  globalSetup: '<rootDir>/tests/globalSetup.ts',
+  // Global teardown script executed once after all test files
+  globalTeardown: '<rootDir>/tests/globalTeardown.ts',
+  // Setup files are executed before each test file
+  // Can access globals
+  setupFiles: ['<rootDir>/tests/setup.ts'],
+  // Setup files after env are executed before each test file
+  // after the jest test environment is installed
+  // Can access globals
+  setupFilesAfterEnv: ['<rootDir>/tests/setupAfterEnv.ts'],
+  moduleNameMapper: moduleNameMapper,
 };

package-lock.json

@@ -12,12 +12,13 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "prepare": "tsc -p ./tsconfig.build.json",
-    "build": "rm -r ./dist || true; tsc -p ./tsconfig.build.json",
+    "build": "rimraf ./dist && tsc -p ./tsconfig.build.json",
+    "postversion": "npm install --package-lock-only --ignore-scripts --silent",
     "ts-node": "ts-node -r tsconfig-paths/register",
     "test": "jest",
     "lint": "eslint '{src,tests,benches}/**/*.{js,ts}'",
     "lintfix": "eslint '{src,tests,benches}/**/*.{js,ts}' --fix",
-    "docs": "rm -r ./docs || true; typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src"
+    "docs": "rimraf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src"
   },
   "dependencies": {
     "@matrixai/async-locks": "^2.3.1",
@@ -34,7 +35,9 @@
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.0.0",
     "jest": "^27.2.5",
+    "jest-junit": "^13.2.0",
     "prettier": "^2.6.2",
+    "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
     "ts-node": "^10.4.0",
     "tsconfig-paths": "^3.9.0",