Refactor package

.eslintrc.json

@@ -2,25 +2,21 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 12,
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": "./tsconfig.json"
   },
-  "plugins": [
-    "@typescript-eslint"
-  ],
+  "plugins": ["@typescript-eslint"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
     "prettier"
   ],
   "rules": {
     "@typescript-eslint/no-unused-vars": "error",
-    "@typescript-eslint/consistent-type-definitions": [
-      "error",
-      "type"
-    ]
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"]
   },
   "env": {
     "browser": true,
     "es2021": true
   }
-}
+}

.github/workflows/publish.yml

@@ -0,0 +1,64 @@
+name: Compile and publish package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+    permissions:
+      packages: write
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Compile Typescript
+        run: yarn build
+
+      - name: Update package.json version
+        run: |
+          release_version=${GITHUB_REF_NAME#v}
+          jq ".version = \"$release_version\"" package.json > package.json.tmp
+          mv package.json.tmp package.json
+
+      - name: Commit updated package.json
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add package.json
+          git commit -m "chore: sync version with release $release_version"
+          git push
+
+      - name: Validate release version
+        run: |
+            release_version=${GITHUB_REF_NAME#v}
+            current_version=$(jq -r '.version' package.json)
+            if [ "$release_version" != "$current_version" ]; then
+              echo "Version mismatch: release tag ($release_version) does not match package.json ($current_version)."
+              exit 1
+            fi
+
+      - name: Setup .yarnrc.yml
+        run: |
+          yarn config set npmAlwaysAuth true
+          yarn config set npmAuthToken $NPM_AUTH_TOKEN
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
+
+      - name: Publish to NPM Registry
+        run: yarn npm publish --access public

.github/workflows/test.yml

@@ -22,13 +22,13 @@ jobs:
           node-version: '18'
 
       - name: Install dependencies
-        run: npm install
+        run: yarn
 
       - name: Linting Typescript
-        run: npm run lint
+        run: yarn lint
 
       - name: Compile Typescript
-        run: npm run build
+        run: yarn build
 
       - name: Run tests
-        run: npm run test
+        run: yarn test

.gitignore

@@ -1,10 +1,24 @@
-.env
-node_modules
-tmp
-logs
-*.log
-npm-debug.log*
-.npm
-.eslintcache
-dist
-.DS_Store
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you don't wish to use zero-installs
+# Documentation here: https://yarnpkg.com/features/zero-installs
+!.yarn/cache
+#.pnp.*
+
+# Compiled typescript
+dist/*
+
+.DS_Store
+
+# local files
+*.local.*
+
+# Jetbrains ide
+.idea
+
+.env

.npmignore

@@ -0,0 +1,6 @@
+/src/
+/.vscode/
+/.yarn/
+.todo/
+*.env
+*.example