0.0.12 Release (#151)

* chore(release): prepare next release * npm: bump @actions/github from 3.0.0 to 4.0.0 Bumps [@actions/github](https://github.com/actions/toolkit/tree/HEAD/packages/github) from 3.0.0 to 4.0.0. - [Release notes](https://github.com/actions/toolkit/releases) - [Changelog](https://github.com/actions/toolkit/blob/master/packages/github/RELEASES.md) - [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/github) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/eslint-plugin from 3.4.0 to 3.5.0 Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 3.4.0 to 3.5.0. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.5.0/packages/eslint-plugin) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/parser from 3.4.0 to 3.5.0 Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 3.4.0 to 3.5.0. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.5.0/packages/parser) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump typescript from 3.9.5 to 3.9.6 Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.9.5 to 3.9.6. - [Release notes](https://github.com/Microsoft/TypeScript/releases) - [Commits](https://github.com/Microsoft/TypeScript/commits) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump eslint from 7.3.1 to 7.4.0 Bumps [eslint](https://github.com/eslint/eslint) from 7.3.1 to 7.4.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md) - [Commits](eslint/eslint@v7.3.1...v7.4.0) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump eslint-plugin-jest from 23.17.1 to 23.18.0 Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 23.17.1 to 23.18.0. - [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases) - [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/master/CHANGELOG.md) - [Commits](jest-community/eslint-plugin-jest@v23.17.1...v23.18.0) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/parser from 3.5.0 to 3.6.0 Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 3.5.0 to 3.6.0. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.6.0/packages/parser) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @types/jest from 26.0.3 to 26.0.4 Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 26.0.3 to 26.0.4. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/eslint-plugin from 3.5.0 to 3.6.0 Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 3.5.0 to 3.6.0. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.6.0/packages/eslint-plugin) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/eslint-plugin from 3.6.0 to 3.6.1 Bumps [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) from 3.6.0 to 3.6.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.6.1/packages/eslint-plugin) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @typescript-eslint/parser from 3.6.0 to 3.6.1 Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 3.6.0 to 3.6.1. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v3.6.1/packages/parser) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump ts-jest from 26.1.1 to 26.1.3 Bumps [ts-jest](https://github.com/kulshekhar/ts-jest) from 26.1.1 to 26.1.3. - [Release notes](https://github.com/kulshekhar/ts-jest/releases) - [Changelog](https://github.com/kulshekhar/ts-jest/blob/master/CHANGELOG.md) - [Commits](kulshekhar/ts-jest@v26.1.1...v26.1.3) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @octokit/rest from 18.0.0 to 18.0.1 Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 18.0.0 to 18.0.1. - [Release notes](https://github.com/octokit/rest.js/releases) - [Commits](octokit/rest.js@v18.0.0...v18.0.1) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump typescript from 3.9.6 to 3.9.7 Bumps [typescript](https://github.com/Microsoft/TypeScript) from 3.9.6 to 3.9.7. - [Release notes](https://github.com/Microsoft/TypeScript/releases) - [Commits](microsoft/TypeScript@v3.9.6...v3.9.7) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump @types/jest from 26.0.4 to 26.0.5 Bumps [@types/jest](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jest) from 26.0.4 to 26.0.5. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jest) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump eslint-plugin-unicorn from 20.1.0 to 21.0.0 Bumps [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) from 20.1.0 to 21.0.0. - [Release notes](https://github.com/sindresorhus/eslint-plugin-unicorn/releases) - [Commits](sindresorhus/eslint-plugin-unicorn@v20.1.0...v21.0.0) Signed-off-by: dependabot[bot] <[email protected]> * npm: bump eslint from 7.4.0 to 7.5.0 Bumps [eslint](https://github.com/eslint/eslint) from 7.4.0 to 7.5.0. - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md) - [Commits](eslint/eslint@v7.4.0...v7.5.0) Signed-off-by: dependabot[bot] <[email protected]> * chore(quality): add codacy and codeclimate * refactor(vscode): refactor vscode config * refactor(build): refactor GitHub CI * refactor(docs): refactor docs * refactor(test): move test utils * docs(SECURITY): update * refactor(eslint): fix complexity issue * chore(docs): update docs * chore(dependencies): update dependencie * chore(buildf): add build path * chore(release): 0.0.10 release * docs(changelog): update changelog * chore(dependencies): update dev dependencies * chore(dependencies): update dev dependencies * chore(dependencies): update dependnencies * chore(dependencies): update dev dependencies * chore(release): bump version * chore(CHANGELOG): update changelog * chore(release): bump version * chore(dependencies): update dependencies * chore(dist): update dist * chore(codequality): renamed variable * chore(codequality): renamed variable, find to some * chore(docs): update README * chore(docs): update SECURITY * chore(docs): update CHANGELOG * build(dependencies): ➕ introduces conventional commit Updates husky and lint-stage dependencies and introduces conventional commit. * chore(dependencies): ⬆️ updates jest dependencies * chore(dependencies): ⬆️ updates ncc dependency Replaces @zeit/ncc with @vercel/ncc. * build(dependencies): ➖ removes jest typing * chore(dependencies): ⬆️ updates eslint dependencies Updates eslint related configurations * build(dependencies): ➖ removes ts-code dependency * chore(dependencies): ⬆️ updates typescript dependency * chore(dependencies): ⬆️ updates @actions/core dependency * refactor: 🔨 refactors build scripts * fix(action): 🐛 fixes action Adds type to error * docs(docs): 📝 updates documentation * ci(workflows): 👷 updates GitHub workflows * build(action): ⬆️ uses node16 for action * build(action): 🚨 configure method complexity for codeclimate * docs(docs): 📝 updates codeclimate related documentation * build(vscode): ➕ adds vscode extensions Removes brackets extension * chore(action): 📦 updates action package * ci(workflows): 🐛 fixes GitHub workflows * chore(dependencies): ⬆️ updates @octokit/rest dependency Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
gregoranders · Feb 2, 2022 · cb6182d · cb6182d
1 parent 892b7c0
commit cb6182d
Show file tree

Hide file tree

Showing 24 changed files with 374 additions and 153 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -6,13 +6,16 @@ plugins:
     enabled: false
   eslint:
     enabled: true
-    channel: 'eslint-6'
     config:
       config: .eslintrc-cc.json
   fixme:
     enabled: true
   git-legal:
     enabled: true
+checks:
+  method-complexity:
+    config:
+      threshold: 8
 exclude_patterns:
   - '**/.github'
   - '**/.circleci'
@@ -22,3 +25,6 @@ exclude_patterns:
   - '**/test'
   - '**/docs'
   - '**/node_modules/'
+  - '**/fixtures'
+  - '**/.husky'
+  - '**/commitlint.config.js'
diff --git a/.eslintrc-cc.json b/.eslintrc-cc.json
@@ -1,19 +1,25 @@
 {
   "root": true,
-  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["prettier", "jest", "unicorn", "@typescript-eslint"],
+  "extends": [
+    "plugin:jest/recommended",
+    "plugin:unicorn/recommended",
+    "plugin:prettier/recommended"
+  ],
   "parserOptions": {
     "ecmaVersion": 2020,
     "sourceType": "module",
     "ecmaFeatures": {}
   },
   "env": {
     "node": true,
-    "browser": true,
-    "es2020": true
+    "es6": true,
+    "browser": false,
+    "jest": true
   },
   "rules": {
-    "complexity": ["error", 8]
+    "@typescript-eslint/explicit-module-boundary-types": "off"
   },
-  "settings": {},
-  "globals": {}
+  "settings": {}
 }
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -3,11 +3,9 @@
   "parser": "@typescript-eslint/parser",
   "plugins": ["prettier", "jest", "unicorn", "@typescript-eslint"],
   "extends": [
-    "plugin:@typescript-eslint/recommended",
     "plugin:jest/recommended",
     "plugin:unicorn/recommended",
-    "plugin:prettier/recommended",
-    "prettier/@typescript-eslint"
+    "plugin:prettier/recommended"
   ],
   "parserOptions": {
     "ecmaVersion": 2020,
@@ -21,7 +19,6 @@
     "jest": true
   },
   "rules": {
-    "complexity": ["error", 8],
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "sort-imports": [
       "error",

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
 <!--- Provide a general summary of your changes in the Title above -->
 
-## Description
+# Description
 
 <!--- Describe your changes in detail -->
 
@@ -21,7 +21,7 @@
 <!--- Include details of your testing environment, and the tests you ran to -->
 <!--- see how your change affects other areas of the code, etc. -->
 
-## Screenshots (if appropriate):
+## Screenshots (if appropriate)
 
 ## Types of changes
 
@@ -32,7 +32,7 @@
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to change)
 
-## Checklist:
+## Checklist
 
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,5 +1,18 @@
 version: 2
 updates:
+
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    labels:
+      - 'npm dependencies'
+    commit-message:
+      prefix: 'github-actions'
+    assignees:
+      - 'gregoranders'
+    target-branch: 'development'
+
   - package-ecosystem: 'npm'
     directory: '/'
     schedule:

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,36 @@
+name: "CodeQL"
+on:
+  push:
+    branches: [ main, development, feature/* ]
+  pull_request:
+    branches: [ main, development, feature/* ]
+  schedule:
+    - cron: '43 7 * * 0'
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+      - name: Echo Node.js version
+        run: node --version
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml
@@ -19,40 +19,41 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [12.x]
+        node-version: [16.x]
 
     steps:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
       - name: Use Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: nodejs project info
         id: projectinfo
-        uses: gregoranders/nodejs-create-release@master
+        uses: gregoranders/nodejs-project-info@master
       - name: npm install
         run: |
           npm install
-      - name: npm run build
-        run: |
-          npm run build
       - name: npm test
         run: |
           npm test
+      - name: npm run build
+        run: |
+          npm run build
       - name: code coverage
+        if: matrix.os == 'ubuntu-latest'
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: ./test/coverage/lcov.info
       - name: publish code coverage to code climate
         if: matrix.os == 'ubuntu-latest'
-        uses: paambaati/codeclimate-action@v2.6.0
+        uses: paambaati/codeclimate-action@v3.0.0
         env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+          CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE }}
         with:
-          coverageCommand: npm run test
+          coverageCommand: npm test
           coverageLocations: |
             ./test/coverage/lcov.info:lcov
       - name: run codacy-coverage-reporter
@@ -61,3 +62,8 @@ jobs:
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: ./test/coverage/lcov.info
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action/composite@v1
+        with:
+          check_name: Unit Test Results node${{ matrix.node-version }}-${{ matrix.os }}
+          files: test/junit.xml
diff --git a/.github/workflows/feature.yml b/.github/workflows/feature.yml
@@ -0,0 +1,69 @@
+name: Feature CI
+
+on:
+  push:
+    branches:
+      - feature/*
+
+env:
+  CI: true
+  GITHUB_BRANCH: ${{ github.ref }}
+  GITHUB_HEAD_REF: ${{ github.head_ref }}
+  GITHUB_BASE_REF: ${{ github.base_ref }}
+  GITHUB_COMMIT: ${{ github.sha }}
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Use Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: nodejs project info
+        id: projectinfo
+        uses: gregoranders/nodejs-project-info@master
+      - name: npm install
+        run: |
+          npm install
+      - name: npm test
+        run: |
+          npm test
+      - name: npm run build
+        run: |
+          npm run build
+      - name: code coverage
+        if: matrix.os == 'ubuntu-latest'
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./test/coverage/lcov.info
+      - name: publish code coverage to code climate
+        if: matrix.os == 'ubuntu-latest'
+        uses: paambaati/[email protected]
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE }}
+        with:
+          coverageCommand: npm test
+          coverageLocations: |
+            ./test/coverage/lcov.info:lcov
+      - name: run codacy-coverage-reporter
+        if: matrix.os == 'ubuntu-latest'
+        uses: codacy/codacy-coverage-reporter-action@master
+        with:
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          coverage-reports: ./test/coverage/lcov.info
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action/composite@v1
+        with:
+          check_name: Unit Test Results node${{ matrix.node-version }}-${{ matrix.os }}
+          files: test/junit.xml
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
@@ -19,14 +19,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        node-version: [12.x]
+        node-version: [16.x]
 
     steps:
       - uses: actions/checkout@v2
         with:
           submodules: recursive
       - name: Use Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
       - name: nodejs project info
@@ -35,12 +35,12 @@ jobs:
       - name: npm install
         run: |
           npm install
-      - name: npm run build
-        run: |
-          npm run build
       - name: npm test
         run: |
           npm test
+      - name: npm run build
+        run: |
+          npm run build
       - name: code coverage
         if: matrix.os == 'ubuntu-latest'
         uses: coverallsapp/github-action@master
@@ -49,11 +49,11 @@ jobs:
           path-to-lcov: ./test/coverage/lcov.info
       - name: publish code coverage to code climate
         if: matrix.os == 'ubuntu-latest'
-        uses: paambaati/codeclimate-action@v2.6.0
+        uses: paambaati/codeclimate-action@v3.0.0
         env:
-          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+          CC_TEST_REPORTER_ID: ${{ secrets.CODE_CLIMATE }}
         with:
-          coverageCommand: npm run test
+          coverageCommand: npm test
           coverageLocations: |
             ./test/coverage/lcov.info:lcov
       - name: run codacy-coverage-reporter
@@ -62,6 +62,11 @@ jobs:
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: ./test/coverage/lcov.info
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action/composite@v1
+        with:
+          check_name: Unit Test Results node${{ matrix.node-version }}-${{ matrix.os }}
+          files: test/junit.xml
       - name: create release
         if: matrix.os == 'ubuntu-latest'
         id: createrelease

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+lint-staged && npm test && npm run build
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,6 +1,7 @@
 {
   "recommendations": [
-    "coenraads.bracket-pair-colorizer",
+    "davidanson.vscode-markdownlint",
+    "vivaxy.vscode-conventional-commits",
     "editorconfig.editorconfig",
     "dbaeumer.vscode-eslint",
     "orta.vscode-jest",