Merge pull request #4 from Avivbens/improve-implementation

improve implementation

.eslintignore

@@ -8,5 +8,6 @@ coverage
 packages
 # don't line the docs
 docs
-.eslintrc.js
-reset.d.ts
+.eslintrc.cjs
+reset.d.ts
+commitlint.config.js

.eslintrc.cjs

@@ -1,16 +1,28 @@
+/**
+ * @type {import('eslint').Linter.Config}
+ */
 module.exports = {
+    $schema: 'http://json.schemastore.org/eslintrc',
     parser: '@typescript-eslint/parser',
     parserOptions: {
         project: 'tsconfig.json',
         sourceType: 'module',
+        ecmaVersion: 2020,
     },
-    plugins: ['@typescript-eslint/eslint-plugin', 'jest', 'prettier'],
-    extends: ['plugin:@typescript-eslint/recommended', 'eslint:recommended', 'plugin:prettier/recommended', 'prettier'],
+    plugins: ['@typescript-eslint/eslint-plugin', 'jest', 'prettier', 'deprecation', 'unused-imports'],
+    extends: [
+        'plugin:@typescript-eslint/recommended',
+        'eslint:recommended',
+        'plugin:prettier/recommended',
+        'prettier',
+        'plugin:jsonc/recommended-with-jsonc',
+    ],
     root: true,
     env: {
         node: true,
         jest: true,
     },
+    ignorePatterns: ['.eslintrc.js'],
     rules: {
         '@typescript-eslint/interface-name-prefix': 'off',
         '@typescript-eslint/explicit-function-return-type': 'off',
@@ -24,6 +36,8 @@ module.exports = {
                 endOfLine: 'auto',
             },
         ],
+        'deprecation/deprecation': 'warn',
+        'unused-imports/no-unused-imports': 'error',
     },
     overrides: [
         {
@@ -34,5 +48,14 @@ module.exports = {
                 'jest/prefer-expect-assertions': 0,
             },
         },
+        {
+            files: ['*.json'],
+            parser: 'jsonc-eslint-parser',
+            extends: ['plugin:jsonc/recommended-with-jsonc'],
+            rules: {
+                'deprecation/deprecation': 'off',
+                '@typescript-eslint/consistent-type-imports': 'off',
+            },
+        },
     ],
 }

.github/workflows/health-check/action.yaml

@@ -36,15 +36,8 @@ inputs:
 runs:
     using: composite
     steps:
-        - name: 🖥️ Setup Node
-          uses: actions/setup-node@v3
-          with:
-              node-version: 16
-
-        - name: 🔗 Install Dependencies
-          shell: bash
-          run: |
-              npm ci --no-fund --no-audit --ignore-scripts --force
+        - name: 🖥️ Setup Env
+          uses: ./.github/workflows/install
 
         - name: 🧪 Test
           if: ${{ inputs.run-tests == 'true' }}

.github/workflows/install/action.yaml

@@ -0,0 +1,16 @@
+---
+name: '☑️ Install deps'
+description: 'Install dependencies and setup node'
+
+runs:
+    using: composite
+    steps:
+        - name: 🖥️ Setup Node
+          uses: actions/setup-node@v4
+          with:
+              node-version: 20
+
+        - name: 🔗 Install Dependencies
+          shell: bash
+          run: |
+              npm ci --no-fund --no-audit --no-progress --ignore-scripts --force

.github/workflows/release-master.yaml

@@ -6,10 +6,14 @@ on:
         branches:
             - master
 
-permissions: write-all
+permissions:
+    contents: write
+    pull-requests: write
+    issues: write
+    deployments: write
 
 concurrency:
-    group: ${{ github.workflow }}-${{ github.ref }}
+    group: release-master-${{ github.workflow }}-${{ github.ref }}
     cancel-in-progress: true
 
 jobs:
@@ -23,14 +27,12 @@ jobs:
 
         steps:
             - name: Checkout
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   fetch-depth: 1
 
             - name: 🧪 Check out repository code
               uses: ./.github/workflows/health-check
-              with:
-                  run-tests: 'false'
 
     release:
         name: 📦 Release Version
@@ -44,7 +46,7 @@ jobs:
 
         steps:
             - name: Checkout
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
               with:
                   fetch-depth: 0
                   persist-credentials: false
@@ -54,14 +56,8 @@ jobs:
                   git config --global user.name "github-bot"
                   git config --global user.email "github-bot@gmail.com"
 
-            - name: Setup Node
-              uses: actions/setup-node@v3
-              with:
-                  node-version: 16
-
-            - name: Install Dependencies
-              run: |
-                  npm ci --no-fund --no-audit --ignore-scripts --force
+            - name: 🖥️ Setup Env
+              uses: ./.github/workflows/install
 
             - name: Build
               run: npm run build
@@ -72,10 +68,7 @@ jobs:
 
             - name: Release
               env:
-                  # This is required to make semantic-release work with GitHub Actions
                   GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-                  # You can use this instead if no branch protection is enabled
-                  # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
                   GIT_AUTHOR_NAME: github-bot
                   GIT_AUTHOR_EMAIL: github-bot@gmail.com
                   GIT_COMMITTER_NAME: github-bot

.github/workflows/semantic-release-report.yaml

@@ -0,0 +1,98 @@
+---
+name: Semantic Release Report 📝
+on:
+    pull_request:
+        branches:
+            - master
+
+permissions:
+    contents: write
+    issues: write
+    pull-requests: write
+
+jobs:
+    PR-checks:
+        # https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow
+        runs-on: ubuntu-latest
+        name: Semantic Release Report 📝
+        steps:
+            - name: 📀 Checkout
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: 🖥️ Setup Env
+              uses: ./.github/workflows/install
+
+            - name: 🔬 Check Semantic Versioning
+              id: semantic-release
+              run: |
+                  GITHUB_REF=${{ github.head_ref }}
+                  npx semantic-release --no-ci --dry-run --plugins @semantic-release/commit-analyzer,@semantic-release/release-notes-generator --branches ${{ github.head_ref }} > output.txt
+                  REPORT=$(cat output.txt | base64 -w 0)
+
+                  VERSION=$(cat output.txt | \
+                  grep "The next release version is" | \
+                  node -e "console.log(require('fs').readFileSync(0, 'utf-8').match(/The next release version is (\d+\.\d+\.\d+(-beta\.\d+)?)/)?.[1] ?? '')")
+
+                  echo "releaseNote=$REPORT" >> $GITHUB_OUTPUT
+                  echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+            - name: 📝 Report semantic versioning
+              uses: actions/github-script@v7
+              if: ${{ steps.semantic-release.outputs.releaseNote != '' }}
+              with:
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+                  script: |
+                      // build release note
+                      const semanticReleaseOutput = Buffer.from('${{ steps.semantic-release.outputs.releaseNote }}', 'base64').toString('utf8');
+                      const semanticReleaseLogMatch = /^[[0-9:\sAMPM]+\]\s\[semantic-release\].*$/;
+                      const lines = semanticReleaseOutput.split('\n');
+                      const lastSemanticReleaseLogIndex = [...lines]
+                          .reverse()
+                          .findIndex((line) => line.match(semanticReleaseLogMatch));
+
+                      const nextVersion = '${{ steps.semantic-release.outputs.version }}';
+
+                      const releaseNoteIndex = lines.length - lastSemanticReleaseLogIndex;
+                      const releaseNote = lines.slice(releaseNoteIndex);
+
+                      let res = releaseNote.join('\n');
+                      if (!releaseNote.length || !res) {
+                          res = '### No release note would be generated.';
+                      }
+
+                      const SEMANTIC_RELEASE_BODY_HEADER = '## 📝 Semantic Release Report';
+                      const NEXT_VERSION_HEADER = `### 🚀 Next Version: ${nextVersion}`;
+                      const body = [SEMANTIC_RELEASE_BODY_HEADER, NEXT_VERSION_HEADER, res].join('\n');
+
+                      // get last comment
+                      const comments = await github.rest.issues.listComments({
+                          issue_number: context.issue.number,
+                          owner: context.repo.owner,
+                          repo: context.repo.repo
+                      });
+
+                      // find comments to delete
+                      const commentsToDelete = comments.data.filter((comment) =>
+                          comment.body.startsWith(SEMANTIC_RELEASE_BODY_HEADER)
+                      );
+
+                      // delete comments
+                      const prms = commentsToDelete.map((comment) =>
+                          github.rest.issues.deleteComment({
+                              comment_id: comment.id,
+                              owner: context.repo.owner,
+                              repo: context.repo.repo
+                          })
+                      );
+
+                      await Promise.all(prms);
+
+                      // create new comment for release note
+                      github.rest.issues.createComment({
+                          issue_number: context.issue.number,
+                          owner: context.repo.owner,
+                          repo: context.repo.repo,
+                          body
+                      });

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
 .DS_Store
+.eslintcache

.husky/commit-msg

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run pre-commit
+npx lint-staged

.lintstagedrc.cjs

@@ -0,0 +1,5 @@
+module.exports = {
+    '*.{ts,cjs,js,json}': 'npx eslint --cache --fix',
+    '**/*': 'npx prettier --cache --write --ignore-unknown',
+    'package.json': 'npx sort-package-json',
+}

.prettierrc

@@ -1,10 +1,20 @@
 {
+    "$schema": "https://json.schemastore.org/prettierrc",
     "tabWidth": 4,
     "singleQuote": true,
     "trailingComma": "all",
     "semi": false,
     "printWidth": 120,
     "importOrder": ["^@.*/(.*)$", "^[./]"],
     "importOrderSeparation": false,
-    "importOrderSortSpecifiers": true
+    "importOrderSortSpecifiers": true,
+    "plugins": ["@trivago/prettier-plugin-sort-imports"],
+    "overrides": [
+        {
+            "files": ["*.ts"],
+            "options": {
+                "importOrderParserPlugins": ["typescript", "decorators-legacy"]
+            }
+        }
+    ]
 }