Upgrade Project

.github/workflows/autofix.yml

@@ -0,0 +1,37 @@
+name: autofix.ci
+
+on:
+  pull_request:
+    branches-ignore:
+      - 'renovate/**'
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  apply:
+    name: Apply automated fixes
+    runs-on: ubuntu-latest
+    if: ${{ github.actor != 'renovate[bot]' && ! contains(github.event.head_commit.author.name , 'renovate[bot]') && ! contains(github.event.head_commit.message , 'chore(release)') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
+      - name: Install Dependencies
+        run: pnpm install
+      - name: Format code
+        run: pnpm biome check --write
+      - name: Fix package.json
+        run: pnpm syncpack fix
+      - name: Format package.json
+        run: pnpm syncpack format
+      - name: Update package lock file
+        run: pnpm install --fix-lockfile --no-frozen-lockfile
+      - name: Submit autofix
+        uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27 # v1.3.2
+        with:
+          fail-fast: false

.github/workflows/tests.yml

@@ -11,15 +11,9 @@ jobs:
     name: Lints
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: latest
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-          cache: 'pnpm'
+      - uses: actions/[email protected]
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
       - name: Install dependencies
         run: pnpm install
       - name: Prettier check
@@ -39,15 +33,8 @@ jobs:
         node: [18, 20, 21]
     steps:
       - uses: actions/checkout@v4
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: latest
-      - name: Set up Node.js ${{matrix.node}}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{matrix.node}}
-          cache: 'pnpm'
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
       - name: Install dependencies
         run: pnpm install
       - name: Run unit tests
@@ -61,19 +48,28 @@ jobs:
         environment: [edge-runtime, jsdom, happy-dom]
     steps:
       - uses: actions/checkout@v4
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: latest
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 'lts/*'
-          cache: 'pnpm'
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
       - name: Install dependencies
         run: pnpm install
       - name: Run unit tests
         run: pnpm test -- --environment=${{ matrix.environment }}
+  benchmark:
+    name: Benchmark
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
+      - name: Install Dependencies
+        run: pnpm install
+      - name: Run Benchmarks
+        uses: CodSpeedHQ/action@4348f634fa7309fe23aac9502e88b999ec90a164 # v4.3.1
+        with:
+          run: pnpm vitest bench
+          mode: 'instrumentation'
+          token: ${{ secrets.CODSPEED_TOKEN }}
   deno:
     name: Deno
     needs: lints

.syncpackrc.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "./node_modules/syncpack/schema.json",
+  "sortFirst": [
+    "name",
+    "description",
+    "version",
+    "productName",
+    "author",
+    "homepage",
+    "repository",
+    "bugs",
+    "private",
+    "publishConfig",
+    "sideEffects",
+    "type",
+    "main",
+    "module",
+    "types",
+    "exports",
+    "scripts",
+    "dependencies",
+    "devDependencies",
+    "peerDependencies",
+    "trustedDependencies",
+    "workspaces",
+    "packageManager"
+  ],
+  "sortExports": ["import", "types"],
+  "sortAz": [
+    "exports",
+    "scripts",
+    "workspaces",
+    "dependencies",
+    "devDependencies",
+    "peerDependencies",
+    "trustedDependencies"
+  ],
+  "semverGroups": [
+    {
+      "label": "All non-peer dependencies must be pinned",
+      "range": "",
+      "dependencyTypes": ["!peer"],
+      "dependencies": ["**"],
+      "packages": ["**"]
+    },
+    {
+      "label": "Allow peer deps to be equal or higher than current versions",
+      "range": ">=",
+      "dependencyTypes": ["peer"],
+      "dependencies": ["**"],
+      "packages": ["**"]
+    }
+  ],
+  "formatBugs": false,
+  "formatRepository": false
+}

README.md

@@ -1,9 +1,10 @@
 # vn-number 🇻🇳
 
-[![JSR Score](https://jsr.io/badges/@hckhanh/vn-number)](https://jsr.io/@hckhanh/vn-number)
-
 🛠 A bunch of utility functions that work with number in 🇻🇳 Vietnamese language
 
+[![NPM Downloads](https://img.shields.io/npm/dw/vn-number)](https://www.npmjs.com/package/vn-number)
+[![JSR](https://jsr.io/badges/@hckhanh/vn-number/weekly-downloads)](https://jsr.io/@hckhanh/vn-number)
+
 ## Features
 
 - [Zero dependencies](https://jsr.io/@hckhanh/vn-number/dependencies)
@@ -13,7 +14,7 @@
 
 ## Functions
 
-### Read Vietnamese number (một triệu hai trăm năm mươi nghìn)
+### Read Vietnamese number
 
 ```ts
 import { readVnNumber } from '@hckhanh/vn-number'
@@ -22,7 +23,7 @@ const result = readVnNumber(1250000)
 console.log(result) // một triệu hai trăm năm mươi nghìn
 ```
 
-### Format number in Vietnamese format (1.250.000)
+### Format number in Vietnamese format
 
 ```ts
 import { formatVnNumber } from '@hckhanh/vn-number'
@@ -31,7 +32,7 @@ const result = formatVnNumber(1250000)
 console.log(result) // 1.250.000
 ```
 
-### Format VN currency (VND) (1.250.000 ₫)
+### Format VN currency (VND - ₫)
 
 ```ts
 import { formatVnCurrency } from '@hckhanh/vn-number'
@@ -40,7 +41,7 @@ const result = formatVnCurrency(1250000)
 console.log(result) // 1.250.000 ₫
 ```
 
-### Format percentage in Vietnamese format (99,1%)
+### Format percentage in Vietnamese format
 
 ```ts
 import { formatVnPercent } from '@hckhanh/vn-number'
@@ -51,4 +52,4 @@ console.log(result) // 99,1%
 
 ## Release Notes
 
-You can go to [Releases](https://github.com/hckhanh/vn-number/releases) page to see the release notes.
+You can go to [the Releases](https://github.com/hckhanh/vn-number/releases) page to see the release notes.

biome.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "correctness": {
+        "noUnusedImports": {
+          "level": "warn",
+          "fix": "safe"
+        }
+      },
+      "style": {
+        "useTemplate": "off",
+        "useConsistentTypeDefinitions": {
+          "level": "warn",
+          "fix": "safe"
+        },
+        "useNodejsImportProtocol": {
+          "level": "warn",
+          "fix": "safe"
+        },
+        "noUnusedTemplateLiteral": {
+          "level": "warn",
+          "fix": "safe"
+        }
+      },
+      "nursery": {
+        "recommended": true
+      }
+    }
+  },
+  "assist": {
+    "enabled": true,
+    "actions": {
+      "source": {
+        "organizeImports": "on"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "arrowParentheses": "always"
+    }
+  }
+}

codecov.yml

@@ -0,0 +1,13 @@
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+
+ignore:
+  - 'docs'

jsr.json

@@ -1,19 +1,9 @@
 {
   "name": "@hckhanh/vn-number",
   "version": "0.0.0-development",
+  "license": "MIT",
   "exports": "./src/index.ts",
-  "exclude": [
-    ".github/",
-    "src/**/*.test.ts",
-    ".git*",
-    ".prettier*",
-    ".*ignore",
-    "*.yml",
-    "*.yaml",
-    "*.config.ts",
-    ".*rc.json",
-    "package.json",
-    "renovate.json",
-    "tsconfig.json"
-  ]
+  "publish": {
+    "include": ["LICENSE", "README.md", "src/**/*.ts"]
+  }
 }

mise.toml

@@ -0,0 +1,4 @@
+[tools]
+npm = "11.6.2"
+node = "24.11.0"
+pnpm = "10.20.0"

package.json

@@ -1,20 +1,29 @@
 {
   "name": "@hckhanh/vn-number",
-  "version": "0.0.0-development",
   "description": "A bunch of utility functions that work with number in Vietnamese language",
-  "type": "module",
+  "version": "0.0.0-development",
+  "author": {
+    "name": "Khánh Hoàng",
+    "email": "[email protected]",
+    "url": "https://khanh.sh"
+  },
   "private": true,
   "sideEffects": false,
+  "type": "module",
   "scripts": {
-    "test": "vitest related src/**/*.ts",
+    "format": "biome check --write",
+    "test": "vitest",
     "test:prettier": "prettier --check ."
   },
-  "author": {
-    "name": "Khánh Hoàng",
-    "email": "[email protected]",
-    "url": "https://khanh.sh"
+  "devDependencies": {
+    "@biomejs/biome": "2.3.2",
+    "@edge-runtime/vm": "3.2.0",
+    "happy-dom": "13.10.1",
+    "jsdom": "24.1.1",
+    "prettier": "3.3.3",
+    "syncpack": "14.0.0-alpha.23",
+    "vitest": "1.6.0"
   },
-  "license": "MIT",
   "keywords": [
     "reader",
     "read",
@@ -41,11 +50,5 @@
     "helper-functions",
     "helper-script"
   ],
-  "devDependencies": {
-    "@edge-runtime/vm": "3.2.0",
-    "happy-dom": "13.10.1",
-    "jsdom": "24.1.1",
-    "prettier": "3.3.3",
-    "vitest": "1.6.0"
-  }
+  "license": "MIT"
 }