Merge pull request #11 from namecheap/feature/publish-package

ci: release package, git commit hooks, update devDependencies

.github/workflows/ci.yml

@@ -20,19 +20,44 @@ jobs:
                 node-version: [16.x, 18.x, 20.x]
 
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
             - name: Use Node.js ${{ matrix.node-version }}
-              uses: actions/setup-node@v3
+              uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node-version }}
                   cache: 'npm'
             - run: npm ci
+            - if: github.event_name == 'pull_request'
+              name: Lint commit messages
+              run: npx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose
             - run: npm run check-format
-            - run: npm run lint
+            - if: matrix.node-version != '16.x' # eslint v9 requires node >= 18
+              run: npm run lint
             - run: npm run build
             - run: npm test
             - if: matrix.node-version == '20.x'
               uses: actions/upload-artifact@v3
               with:
                   name: Code coverage
                   path: coverage/
+
+    publish:
+        name: 'Publish'
+        needs: build
+        runs-on: ubuntu-latest
+        environment: npm_publish
+        if: github.ref == 'refs/heads/master'
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 20.x
+                  cache: 'npm'
+            - run: npm ci
+            - name: Publish new version
+              env:
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: npx semantic-release

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,2 @@
+npx lint-staged
+npm test

commitlint.config.js

@@ -0,0 +1,6 @@
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+};

eslint.config.mjs

@@ -0,0 +1,34 @@
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import jest from 'eslint-plugin-jest';
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all,
+});
+
+export default [
+    ...compat.extends('eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:jest/recommended'),
+    {
+        plugins: {
+            '@typescript-eslint': typescriptEslint,
+            jest,
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.browser,
+            },
+
+            parser: tsParser,
+        },
+    },
+];

lint-staged.config.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import('lint-staged').Config}
+ */
+module.exports = {
+    '*': 'prettier --ignore-unknown --write',
+    '*.{ts, tsx}': 'npm run lint -- --fix',
+};