Merge pull request #49 from nats-io/cover

Update package structure and configurations

.github/workflows/deno.yml

@@ -0,0 +1,51 @@
+name: test esm
+
+on:
+  push:
+    tags:
+      - "*"
+    branches:
+      - "*"
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        deno-version: [2.1.x]
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout nuid
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+      - name: Use Deno Version ${{ matrix.deno-version }}
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: ${{ matrix.deno-version }}
+      - name: lint
+        run: |
+          deno fmt --check src/ test/
+          deno lint
+
+      - name: test
+        env:
+          TMPDIR: ${{ runner.temp }}
+          CI: true
+        run: |
+          deno task clean
+          deno task test
+          deno task cover
+
+      - name: Upload coverage
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          file: ./coverage/out.lcov

.github/workflows/natsjs.yml → .github/workflows/node.yml

@@ -1,11 +1,11 @@
-name: NUID CI
+name: test cjs
 
 on:
   push:
     tags:
-      - '*'
+      - "*"
     branches:
-      - '*'
+      - "*"
   pull_request:
     branches: [main]
 
@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         node-version: [22.x]
-        deno-version: [1.43.5]
+        deno-version: [2.1.x]
 
     runs-on: ubuntu-latest
 
@@ -31,17 +31,16 @@ jobs:
         uses: denoland/setup-deno@v1
         with:
           deno-version: ${{ matrix.deno-version }}
-      - run: npm ci
-      - run: npm run prepack
-      - run: npm test
+      - name: lint
+        run: |
+          deno fmt --check src/ test/
+          deno lint
+
+      - name: test
         env:
+          TMPDIR: ${{ runner.temp }}
           CI: true
-#      - name: Gather coverage
-#        if: matrix.node-version == '21.x'
-#        run: npm run coveralls
-#      - name: Upload coverage
-#        uses: coverallsapp/[email protected]
-#        if: matrix.node-version == '21.x'
-#        with:
-#          github-token: ${{ secrets.github_token }}
-#          path-to-lcov: ./coverage/lcov.info
+        run: |
+          npm ci
+          npm run prepack
+          npm test

.github/workflows/npm.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         node-version: [22.x]
-        deno-version: [1.43.5]
+        deno-version: [2.1.x]
 
     runs-on: ubuntu-latest
     permissions:
@@ -43,7 +43,3 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       - run: npx jsr publish
-
-
-
-

.gitignore

@@ -1,6 +1,6 @@
 esm/index.mjs
-lib/nuid.d.ts
-lib/nuid.js
+lib/
+coverage/
 
 # Dependency directories
 node_modules

README.md

@@ -1,33 +1,44 @@
 # Nuid.js
 
-[![license](https://img.shields.io/github/license/nats-io/node-nuid.svg)](https://www.apache.org/licenses/LICENSE-2.0)
-[![npm](https://img.shields.io/npm/v/nuid.svg)](https://www.npmjs.com/package/nuid)
-[![npm](https://img.shields.io/npm/dt/nuid.svg)](https://www.npmjs.com/package/nuid)
-[![npm](https://img.shields.io/npm/dm/nuid.svg)](https://www.npmjs.com/package/nuid)
+[![License](https://img.shields.io/badge/Licence-Apache%202.0-blue.svg)](./LICENSE)
+![node](https://github.com/nats-io/nuid.js/actions/workflows/node.yml/badge.svg)
+![deno](https://github.com/nats-io/nuid.js/actions/workflows/deno.yml/badge.svg)
+[![coverage](https://coveralls.io/repos/github/nats-io/nuid.js/badge.svg?branch=main)](https://coveralls.io/github/nats-io/nuid.js?branch=main)
+[![JSDoc](https://img.shields.io/badge/JSDoc-reference-blue)](https://nats-io.github.io/nuid.js/index.html)
+
+[![JSR](https://jsr.io/badges/@nats-io/nuid)](https://jsr.io/@nats-io/nuid.js)
+[![JSR](https://jsr.io/badges/@nats-io/nuid/score)](https://jsr.io/@nats-io/nuid.js)
+
+[![npm](https://img.shields.io/npm/v/%40nats-io%2Fnuid)](https://www.npmjs.com/package/@nats-io/nuid.js)
+[![npm](https://img.shields.io/npm/dt/%40nats-io%2Fnuid)](https://www.npmjs.com/package/@nats-io/nuid.js)
+[![npm](https://img.shields.io/npm/dm/%40nats-io%2Fnuid)](https://www.npmjs.com/package/@nats-io/nuid.js)
 
 A highly performant unique identifier generator for JavaScript.
 
 ## Installation
 
-Import the library for node/bun:
+For web and deno you can use the JSR bundle:
 
 ```bash
-npm install nuid
+npx jsr add @nats-io/nuid
+// or
+deno add @nats-io/nuid
 ```
 
-For web and deno you can also:
-
-```bash
-npx jsr add @nats-io/nuid
+```typescript
+import { next, Nuid } from "jsr:@nats-io/nuid";
 ```
 
-## Basic Usage
+import { next
 
-Reference the library in your code. If using you can `import` or `require` the
-npm nuid library supports both Common JS and ESM:
+In node/bun:
+
+```bash
+npm install nuid
+```
 
 ```javascript
-const { nuid, Nuid } = require("nuid");
+const { next, Nuid } = require("nuid");
 // or
 import { next, Nuid } from "nuid";
 
@@ -36,6 +47,8 @@ import { next, Nuid } from "nuid";
 // `new Nuid()`.
 ```
 
+## Basic Usage
+
 ```javascript
 // To generate a bunch of nuids:
 let id = nuid.next();

deno.json

@@ -0,0 +1,28 @@
+{
+  "name": "@nats-io/nuid",
+  "version": "2.0.1",
+  "exports": {
+    ".": "./src/nuid.ts"
+  },
+  "include": [
+    "src/nuid.ts",
+    "LICENSE",
+    "README.md",
+    "MAINTAINERS.md",
+    "CODE-OF-CONDUCT.md"
+  ],
+
+  "tasks": {
+    "clean": "rm -rf ./lib ./coverage",
+    "test-cover": "deno task clean && deno task test && deno task cover && deno task view-cover",
+    "test": "deno test -A --parallel --reload --coverage=coverage test/",
+    "cover": "deno coverage ./coverage --lcov > ./coverage/out.lcov",
+    "view-cover": "genhtml -o ./coverage/html ./coverage/out.lcov && open ./coverage/html/index.html"
+  },
+  "fmt": {
+    "exclude": ["lib/", "docs/"]
+  },
+  "lint": {
+    "exclude": ["lib/", "docs/"]
+  }
+}