V2 (#16)

* Migrate to Bun, Biome, structure changes, CI/CD update

- Migrate from PNPM to Bun (package manager)
- Migrate from Node to Bun (runtime) for /scripts
- Migrate from Prettier/ESLint to Biome
- Migrate Tests from Jest to Bun Test Runner
- Move tests closer to each tested file, also splitting them
- Update GH Action to support NPM's Trusted publishing, Bun and update used actions' versions
- Update README, CONTRIBUTING and LICENSE year

* Change formatters param signature, add new FormatStyle type with union strings, make formatters throw only when it's unable to parse.

* Add vscode workspace settings for biome and recommended extensions

* Update READMEs

* Change LICENSE to MIT

* misc script changes

* v2.0.0-beta.0

* Fix GH action permissions

* v2.0.0-beta.1

* Re: Fix GH action permissions

* v2.0.0-beta.2

* Use npm publish instead of bun

* v2.0.0-beta.3

* Update NPM step to support Trusted Publishing OIDC

* v2.0.0-beta.4

* Use bunx instead of udpating npm

* v2.0.0-beta.5

* Explicitly set tag to version on npm publish

* v2.0.0-beta.6

* Have two steps for publishing release and prerelease tags

* v2.0.0-beta.7

* Add repository field in package.json

* v2.0.0-beta.8

* Disable source maps generation

* v2.0.0-beta.9

* Update package.json

* v2.0.0-beta.10

* Update script to generate rnc/cedula with and without dashes for proper testing, also remove shuffling algo

* Refactor some of the validators, fix js docs, update RNC validator test to also use cedulas, update generate script

* Add script to generate provincias/municipios helpers, update tsconfig for import alias, update vscode settings

* Add license badge, fix EOF new line on script, add tsdown for building lib and minifying

* v2.0.0-beta.11

* Add script for calculating false negatives, update README, add exports field to package.json, update biome config

* Update README.es.md

* v2.0.0-beta.12

* Update package.json exports

* v2.0.0-beta.13

* Use "default" instead of "import" in package.json exports

* v2.0.0-beta.14

* Remove .DS_Store

* Update READMEs

* Update GH Action to mark release as prerelease if not stable version

* v2.0.0-beta.15

* Enable generate release notes on GH Action

Author: Maikuh

.eslintrc.js

@@ -5,29 +5,38 @@ on:
     tags:
       - "v*"
 
+permissions:
+  id-token: write  # Required for OIDC (NPM)
+  contents: write
+
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-
+        uses: actions/checkout@v6
       - name: Create Release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
+        with:
+          prerelease: ${{ contains(github.ref_name, '-') }}
+          generate_release_notes: true
 
   publish:
     needs: release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '16.x'
-          registry-url: 'https://registry.npmjs.org'
-
-      - run: npm install
-      
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Install bun
+        uses: oven-sh/setup-bun@v2
+      - name: Install dependencies
+        run: bun ci
+      - name: Run tests
+        run: bun test
+      - name: Publish to NPM (Pre-release)
+        run: bunx npm@latest publish --tag next
+        if: contains(github.ref_name, '-')
+      - name: Publish to NPM (Stable)
+        run: bunx npm@latest publish
+        if: "!contains(github.ref_name, '-')"
+        

.github/workflows/release-and-publish.yaml

@@ -2,3 +2,4 @@ node_modules/
 lib/
 tmp/
 coverage/
+.DS_Store

.gitignore

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["biomejs.biome", "oven.bun-vscode"]
+}

.prettierrc

@@ -0,0 +1,14 @@
+{
+  "editor.defaultFormatter": "biomejs.biome",
+  "editor.formatOnSave": true,
+  "javascript.preferences.quoteStyle": "single",
+  "typescript.preferences.quoteStyle": "single",
+  "notebook.defaultFormatter": "biomejs.biome",
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "editor.codeActionsOnSave": {
+    "source.organizeImports.biome": "explicit",
+    "source.fixAll.biome": "explicit"
+  }
+}

.vscode/extensions.json

@@ -125,4 +125,4 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 * All public API methods **must be documented**. (Details TBC). -->
 
 - All features or bug fixes **must be tested** by one or more suites.
-- We follow [Airbnb's JavaScript Style Guide](https://airbnb.io/javascript), using ESLint.
+- We are using [Biome](https://biomejs.dev/) for lint/format, meaning we don't exactly follow a style guide (anymore). Make sure to exec `bun run biome` to confirm everything's as expected.