Merge pull request #42 from yousifalraheem/chore/cleanup

Code cleanup

Author: yousifalraheem

.commitlintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

.github/workflows/node.js.yml

@@ -1,27 +1,31 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+# Release workflow powered by semantic-release.
+# Only publishes when conventional commits since last release warrant a release.
 
-name: Node.js Package
+name: Release
 
 on:
-  release:
-    types: [created]
   push:
     branches: [ "main" ]
+  workflow_dispatch:
 
 jobs:
-  publish-npm:
+  release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
           registry-url: https://registry.npmjs.org/
-      - run: yarn install
-      - run: yarn install:ci
+      - name: Enable Corepack (Yarn 4)
+        run: corepack enable
+      - run: yarn install --immutable
       - run: yarn tsc
       - run: yarn build
-      - run: npm publish
+      - name: Run semantic-release
+        run: yarn release
         env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/npm-publish.yml

@@ -0,0 +1,26 @@
+# Verify workflow runs on PRs to validate build and tests, and preview release outcome in dry-run.
+name: Verify
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Enable Corepack (Yarn 4)
+        run: corepack enable
+      - run: yarn install --immutable
+      - run: yarn tsc
+      - run: yarn build
+      - run: yarn test:ci

.github/workflows/verify.yaml

@@ -20,3 +20,13 @@ dist-types
 
 # run
 /run
+
+# Yarn files
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+.yarn-integrity

.gitignore

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Lint commit message using commitlint (conventional commits)
+yarn commitlint --edit "$1"

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn lint && yarn tsc
+yarn format:staged && yarn lint && yarn tsc

.husky/pre-commit

@@ -0,0 +1,13 @@
+# Build and dependencies
+dist-types
+dist
+node_modules
+coverage
+
+# Configs
+.github
+.vscode
+.idea
+.codacy
+.husky
+.yarn

.prettierignore

@@ -0,0 +1,21 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
+    [
+      "@semantic-release/github",
+      {
+        "assets": [
+          {"path": "dist", "label": "Distribution"}
+        ]
+      }
+    ]
+  ]
+}