Upgrade Project (#37)

* feat: configure project structure and add tooling setup

Added `syncpack` and `biome` configuration for consistent project dependencies and formatting. Updated `renovate.json` and introduced additional tooling files like `.syncpackrc.json`, `biome.json`, `pnpm-workspace.yaml`, and `mise.toml`. Enhanced TypeScript configurations for better compilation and bundling settings.

* ci: add autofix workflow and update test workflows

Introduced a new `autofix.ci` workflow to apply automated fixes on PRs and pushes to the main branch. Replaced individual Node.js and pnpm setup in test workflows with a unified toolchain setup using `jdx/mise-action` for consistency.

* refactor: standardize code style and fix formatting inconsistencies

Updated function syntax in test files to use arrow functions for consistency. Added trailing commas in multiline arguments and object definitions. Reorganized imports in `NumberReader.ts` and improved object method access in static methods for better clarity.

* feat: add configurations for tsdown and vitest

Introduced `tsdown.config.ts` for bundling settings with ESM output and DTS generation. Added `vitest.config.mts` with Codspeed plugin and custom exclusions for tests and coverage. Enhances development and testing workflows.

* docs: update README badges for downloads and JSR

Replaced the outdated JSR badge with separate badges for weekly downloads and JSR. Improves the README's informational clarity and visual appeal by showcasing key project metrics.

* docs: fix README formatting and minor phrasing

Adjusted formatting by moving the description above the badges for better structure. Updated a minor phrasing in the release notes section for clarity.

* docs: refine section titles in README for clarity

Simplified and standardized section titles by removing example text from headers. This improves readability and maintains a consistent structure throughout the documentation.

* feat(benchmark): add comprehensive benchmark tests

Introduced benchmarking for `formatVnNumber`, `formatVnCurrency`, `formatVnPercent`, and `readVnNumber` to evaluate performance under various scenarios. These tests help identify performance bottlenecks and ensure the reliability and efficiency of the formatting functions. Updated CI workflow to include a benchmark step using CodSpeed.

* ci: update workflows to replace Prettier with Biome

Replaced Prettier checks with Biome for formatting and added `syncpack` commands for dependency management. Updated test workflow to improve coverage reporting using Codecov, and removed obsolete Prettier configurations from the repository.

* [autofix.ci] apply automated fixes

* chore(deps): update vitest and add CodSpeed plugin

Upgraded `vitest` to 4.0.5 for compatibility and performance improvements. Added `@codspeed/vitest-plugin` to enhance benchmarking capabilities, ensuring better testing accuracy and performance analysis.

* [autofix.ci] apply automated fixes

* chore(deps): remove unused dependencies from devDependencies

Removed `@edge-runtime/vm`, `happy-dom`, and `jsdom` from `devDependencies` in `package.json` as they were no longer in use. Adjusted `pnpm-lock.yaml` to reflect these changes and marked related dependencies as optional where applicable.

* [autofix.ci] apply automated fixes

* ci: enhance autofix workflow with audit fixes and lock sync

Added a step to automatically fix audit issues using `pnpm audit --fix` for improved dependency security. Adjusted `pnpm install` step to no longer use the `--fix-lockfile` option for better compatibility and workflow stability.

* [autofix.ci] apply automated fixes

* chore(deps): add @vitest/coverage-v8 and clean overrides

Added `@vitest/coverage-v8` to `devDependencies` for enhanced test coverage reporting. Removed outdated overrides for `happy-dom` in `pnpm-lock.yaml` and `pnpm-workspace.yaml` to simplify dependency management. Adjusted the lockfile to include new transitive dependencies.

* Add Changesets setup for versioning

Introduced Changesets configuration files to support version management and publishing workflows. This setup provides tools for managing multi-package or single-package repositories, improving release processes.

* Streamline publishes workflow and removes semantic-release

Optimized the GitHub Actions workflow by simplifying and restructuring steps in the publish process. Replaced `semantic-release` with `changesets` for improved versioning and release management, and removed the obsolete `.releaserc.json` configuration. This enhances the workflow's efficiency and maintainability.

* Prepare package for publication

Added `main`, `module`, `types`, and `exports` fields in `package.json` to establish proper package entry points. Updated `files` to include `dist` for NPM publication and upgraded `version` to `1.5.7`. Enhanced the build setup with `tsdown` and `[email protected]` for improved TypeScript support.

* Rename test job to unit-test for clarity

Updated the test job name in the GitHub Actions workflow to `unit-test`. This improves job naming consistency and distinguishes unit tests from other potential test types in the workflow.

* Update vitest dependencies to 4.0.6

Bumped `vitest` and related packages (`@vitest/coverage-v8`, `@vitest/expect`, etc.) to version 4.0.6 in `package.json` and `pnpm-lock.yaml`. These updates ensure compatibility, performance improvements, and the latest features for testing.

* Remove unused coverage and exclude settings

Simplified `vitest.config.mts` by removing redundant `coverage` and `exclude` settings. These configurations are no longer applicable or needed, streamlining the test configuration.

* Upgrade esbuild and clean up dependencies

Updated `esbuild` to version 0.25.12 in `pnpm-lock.yaml`, ensuring compatibility with the latest features and bug fixes. Removed multiple unused dependencies from the lockfile, significantly simplifying and streamlining the dependency tree.

* Rename bench description for clarity

Updated the bench description in `number.bench.ts` to replace "100%" with "100 percent". This improves readability and aligns with descriptive naming conventions in benchmarks.

* Update actions and dependencies in workflow

Updated `actions/checkout` to v5.0.0 and `denoland/setup-deno` to v2.0.3 in the GitHub Actions workflows. Added descriptive step names for better readability and consistency across the workflow.

* Add `override` specifier and fix doc comments

Added the `override` specifier to `read` methods in `Billion` and `Zerofill` classes for better clarity and adherence to TypeScript standards. Updated doc comments for consistency and clarity by correcting phrasing.

* Remove unused `needs` in Deno job

Removed the `needs: lints` dependency from the Deno job in the GitHub Actions workflow. This cleanup eliminates a redundant configuration, streamlining the workflow setup without affecting functionality.

* Remove unused CODSPEED_TOKEN from workflow

Removed the `CODSPEED_TOKEN` secret from the bench job in the GitHub Actions workflow. This token is no longer necessary and its removal simplifies the job configuration.

* Downgrade vitest and related packages

Downgraded `vitest` and `@vitest/coverage-v8` to version 3.2.4 in `package.json`. This change addresses compatibility issues or aligns with project requirements by using stable, well-supported versions.

* Remove unused env variables from bench job

Removed the `NODE_OPTIONS` environment variable from the bench job in the GitHub Actions workflow. This cleanup eliminates redundant settings, simplifying the workflow configuration without affecting functionality.

* Downgrade esbuild to 0.25.11

Reverted `esbuild` from 0.25.12 to 0.25.11 in `pnpm-lock.yaml` for compatibility with `[email protected]`. Removed unused references to `[email protected]`, simplifying the lockfile and ensuring a consistent dependency tree.

* Allow non-frozen lockfile in autofix workflow

Updated the autofix workflow to use `pnpm install --no-frozen-lockfile`. This ensures flexibility in resolving dependencies, particularly when the lockfile may not align with the current environment.

* Add timeout to vitest bench command

Updated the bench command in the GitHub Actions workflow to include a `--testTimeout 10000` flag. This ensures that benchmarks have adequate time to complete without timing out in CI environments.

* Simplify benchmarking configurations

Removed redundant `--testTimeout` flag from vitest bench command in workflows. Standardized and clarified benchmark descriptions for better readability and alignment with typical usage scenarios. Streamlined batch and real-world operation setups across all benchmarks without affecting functionality.

* Reformat metric data generation loop

Refactored `metrics` data generation and number reading loops for better readability and maintainability. Ensured consistent code style and alignment with project formatting guidelines without altering functionality.

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: hckhanh

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/autofix.yml

@@ -0,0 +1,39 @@
+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 --no-frozen-lockfile
+      - 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: Fix audit issues
+        run: pnpm audit --fix
+      - name: Update package lock file
+        run: pnpm install --no-frozen-lockfile
+      - name: Submit autofix
+        uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27 # v1.3.2
+        with:
+          fail-fast: false

.github/workflows/publish.yml

@@ -12,38 +12,34 @@ jobs:
     secrets: inherit
   release:
     name: Release
-    needs: test
     runs-on: ubuntu-latest
     permissions:
+      id-token: write
       contents: write
-      issues: write
       pull-requests: write
-      id-token: write
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Install jq
-        uses: dcarbone/install-jq-action@v2
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: latest
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
+      - 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: Update npm
+        run: npm install -g npm@latest
+      - name: Create Release Pull Request or Publish to npm
+        uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3
+        id: changesets
         with:
-          node-version: 'lts/*'
-          cache: 'pnpm'
-      - name: Release on GitHub
-        run: pnpm --package conventional-changelog-conventionalcommits --package semantic-release dlx semantic-release
+          publish: 'pnpm tsdown && pnpm changeset publish'
+          commitMode: 'github-api'
+          title: 'Release new version'
+          commit: 'Bump version package'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Update version for JSR registry
+      - name: Publish to JSR
         run: |
           VERSION=$(node -p "require('./package.json').version")
           jq --arg version "$VERSION" '.version = $version' jsr.json > jsr.json.tmp
           mv jsr.json.tmp jsr.json
-          echo "VERSION=$VERSION" >> $GITHUB_ENV
-      - name: Publish package to JSR
-        if: env.VERSION != '0.0.0-development'
-        run: pnpm dlx jsr publish
+          pnpm dlx jsr publish --allow-dirty
+        if: steps.changesets.outputs.published == 'true'

.github/workflows/tests.yml

@@ -11,76 +11,70 @@ 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'
+      - name: Checkout
+        uses: actions/[email protected]
+      - name: Setup toolchains
+        uses: jdx/mise-action@be3be2260bc02bc3fbf94c5e2fed8b7964baf074 # v3.4.0
       - name: Install dependencies
         run: pnpm install
-      - name: Prettier check
-        run: pnpm test:prettier
+      - name: Biome check
+        run: pnpm biome check
+      - name: Syncpack lint
+        run: pnpm syncpack lint
+      - name: Syncpack format
+        run: pnpm syncpack format --check
       - name: Checks for known security issues with the installed packages
         run: pnpm audit
       - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
         run: pnpm npm audit signatures
       - name: Verify the package for publishing performing all checks and validations
         run: pnpm dlx jsr publish --dry-run
-  node:
-    name: Node
-    needs: lints
+  unit-test:
+    name: Unit Test
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [18, 20, 21]
+    permissions:
+      id-token: write
+      contents: read
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup pnpm
-        uses: pnpm/action-setup@v3
+      - 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 Tests
+        run: pnpm vitest --coverage --reporter=junit --outputFile=test-report.junit.xml
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
         with:
-          version: latest
-      - name: Set up Node.js ${{matrix.node}}
-        uses: actions/setup-node@v4
+          use_oidc: true
+      - name: Upload test results to Codecov
+        uses: codecov/test-results-action@47f89e9acb64b76debcd5ea40642d25a4adced9f # v1.1.1
+        if: ${{ !cancelled() }}
         with:
-          node-version: ${{matrix.node}}
-          cache: 'pnpm'
-      - name: Install dependencies
-        run: pnpm install
-      - name: Run unit tests
-        run: pnpm test -- --environment=node
-  test:
-    name: Test
-    needs: lints
+          use_oidc: true
+  benchmark:
+    name: Benchmark
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        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: Install dependencies
+      - 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 unit tests
-        run: pnpm test -- --environment=${{ matrix.environment }}
+      - name: Run Benchmarks
+        uses: CodSpeedHQ/action@4348f634fa7309fe23aac9502e88b999ec90a164 # v4.3.1
+        with:
+          run: pnpm vitest bench
+          mode: 'instrumentation'
   deno:
     name: Deno
-    needs: lints
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/[email protected]
       - name: Install Deno
-        uses: denoland/setup-deno@v1
+        uses: denoland/setup-deno@v2.0.3
       - name: Type-check the dependencies
         run: deno check src/index.ts

.prettierignore

@@ -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
+}

.prettierrc.yml

@@ -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.