✨ 📄 Added detailed metadta tp package.json and updated CI/CD workflows to utilize Bun for testing and publishing

Author: max-programming

.github/workflows/ci.yml

@@ -8,13 +8,9 @@ on:
 
 jobs:
   test:
-    name: Test
+    name: Test with Bun
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [18, 20, 22]
-
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -52,9 +48,15 @@ jobs:
           fi
           echo "Build artifacts verified successfully"
 
-  # Test with Node.js as well to ensure compatibility
-  test-node:
-    name: Test with Node.js
+      - name: Test package installation
+        run: |
+          # Pack the package to test it can be installed
+          bun pm pack
+          echo "Package packed successfully"
+
+  # Test Node.js compatibility without npm caching issues
+  test-node-compat:
+    name: Test Node.js Compatibility
     runs-on: ubuntu-latest
 
     strategy:
@@ -69,16 +71,21 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          # Remove cache to avoid bun.lock vs package-lock.json conflicts
 
-      - name: Install dependencies
+      - name: Create package-lock.json for npm
+        run: |
+          # Create a temporary package-lock for npm compatibility test
+          npm install --package-lock-only
+
+      - name: Install dependencies with npm
         run: npm ci
 
-      - name: Run tests
+      - name: Run tests with npm
         run: npm test
 
-      - name: Type check
+      - name: Type check with npm
         run: npx tsc --noEmit
 
-      - name: Build package
+      - name: Build package with npm
         run: npm run build

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   release:
-    name: Release and Publish
+    name: Release and Publish with Bun
     runs-on: ubuntu-latest
     permissions:
       contents: write # Needed to create releases
@@ -67,16 +67,15 @@ jobs:
             require('fs').writeFileSync('./package.json', JSON.stringify(pkg, null, 2) + '\n');
           "
 
-      - name: Setup Node.js for npm publishing
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-          registry-url: "https://registry.npmjs.org"
+      - name: Verify package can be packed
+        run: |
+          bun publish --dry-run
+          echo "Package dry-run successful"
 
-      - name: Publish to npm
-        run: npm publish --provenance --access public
+      - name: Publish to npm with Bun
+        run: bun publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_CONFIG_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Generate changelog
         id: changelog
@@ -136,6 +135,6 @@ jobs:
 
       - name: Notify
         run: |
-          echo "🎉 Successfully released id-ts v${{ steps.get_version.outputs.version }}"
+          echo "🎉 Successfully released id-ts v${{ steps.get_version.outputs.version }} with Bun!"
           echo "📦 Published to npm: https://www.npmjs.com/package/id-ts"
           echo "🏷️ GitHub Release: https://github.com/max-programming/id-ts/releases/tag/v${{ steps.get_version.outputs.version }}"

package.json

@@ -1,6 +1,27 @@
 {
   "name": "id-ts",
   "version": "1.0.0",
+  "description": "A lightweight, type-safe TypeScript library for generating prefixed IDs with customizable options",
+  "author": "Max Programming",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/max-programming/id-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/max-programming/id-ts/issues"
+  },
+  "homepage": "https://github.com/max-programming/id-ts#readme",
+  "keywords": [
+    "id",
+    "uuid",
+    "nanoid",
+    "typescript",
+    "prefixed-ids",
+    "type-safe",
+    "id-generation",
+    "unique-id"
+  ],
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -17,10 +38,11 @@
     "test": "vitest",
     "test:ui": "vitest --ui",
     "test:run": "vitest run",
-    "release": "npm run test:run && npm run build && npm version",
-    "release:patch": "npm run release patch && git push && git push --tags",
-    "release:minor": "npm run release minor && git push && git push --tags",
-    "release:major": "npm run release major && git push && git push --tags"
+    "publish:dry": "bun publish --dry-run",
+    "release": "bun test:run && bun run build",
+    "release:patch": "bun run release && bun version patch && git push && git push --tags",
+    "release:minor": "bun run release && bun version minor && git push && git push --tags",
+    "release:major": "bun run release && bun version major && git push && git push --tags"
   },
   "files": [
     "dist",
@@ -45,21 +67,5 @@
     "zod": {
       "optional": true
     }
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/max-programming/id-ts"
-  },
-  "homepage": "https://github.com/max-programming/id-ts#readme",
-  "bugs": {
-    "url": "https://github.com/max-programming/id-ts/issues"
-  },
-  "keywords": [
-    "id",
-    "nanoid",
-    "unique",
-    "identifier",
-    "prefix"
-  ],
-  "license": "MIT"
+  }
 }