Move library structure to single entry-point dynamical loading

.gitattributes

@@ -1,4 +1,4 @@
-# Automatically convert to native line endings
+# Automatically convert to native line endings, in case people don't have core.autocrlf set
 * text=auto
 
 # Force Unix (LF) line endings

.github/workflows/npm-publish.yml

@@ -10,19 +10,21 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
 
-    - name: Setup Node.js v19
-      uses: actions/setup-node@v3
-      with:
-        node-version: 19
-        registry-url: 'https://registry.npmjs.org'
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
 
-    - run: npm ci
-    - run: npm run lint
-    - run: npm run build
+      - run: npm ci
+      - run: npm run build
+      - run: npm run build:types
 
-    - name: Publish to NPM
-      run: npm publish
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,44 +1,51 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  push:
+    tags-ignore:
+      - v*
+  pull_request:
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node: [16, 18, 19, 20]
+        node: [18, 20, 22]
 
     steps:
-    - uses: actions/checkout@v3
-
-    - name: Setup Node.js ${{ matrix.node }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node }}
-        cache: 'npm'
-
-    - run: npm ci
-    - run: npm run lint
-    - run: npm run build
-    - run: npm run coverage
-
-    - name: Coveralls Parallel
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        flag-name: ${{ matrix.node }}
-        parallel: true
-
-    - run: npm publish --dry-run
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Setup Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+          cache: 'npm'
+
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build
+      - run: npm run coverage
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{ matrix.node }}
+          parallel: true
+
+      - run: npm publish --dry-run
 
   finish:
     needs: build
     runs-on: ubuntu-latest
     steps:
-    - name: Coveralls Finished
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-        parallel-finished: true
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true
+          carryforward: '18,20,22'

.gitignore

@@ -1,4 +1,7 @@
-dist
+dist/
+
+# Generated typing files
+*.d.ts
 
 # Logs
 logs
@@ -60,7 +63,10 @@ typings/
 .env
 
 # next.js build output
-.next
+.next/
 
 # VSCode project config
-.vscode
+.vscode/
+
+# JSDoc
+docs/

.markdownlint.mjs

@@ -0,0 +1,3 @@
+export default {
+  line_length: false,
+};

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2023 Wael TELLAT
+Copyright (c) 2018-2024 Wael TELLAT
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,7 +4,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/forzagreen/n2words/badge.svg?branch=master)](https://coveralls.io/github/forzagreen/n2words?branch=master)
 [![npm](https://img.shields.io/npm/v/n2words.svg)](https://npmjs.com/package/n2words)
 [![npm](https://img.shields.io/npm/dw/n2words)](https://npmjs.com/package/n2words)
-[![](https://data.jsdelivr.com/v1/package/npm/n2words/badge)](https://www.jsdelivr.com/package/npm/n2words)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/n2words/badge)](https://www.jsdelivr.com/package/npm/n2words)
 
 __n2words__ converts numerical numbers into written ones, supports [27 languages](https://github.com/forzagreen/n2words#supported-languages), and has zero dependencies.
 
@@ -38,9 +38,8 @@ import n2words from 'n2words'
 ### CommonJS ([dynamic import](https://nodejs.org/api/esm.html#import-expressions))
 
 ```js
-import('n2words').then(n2words => {
-    // Available via "default" method
-    n2words.default(100)
+import('n2words').then(({default: n2words}) => {
+    n2words(100)
 })
 ```
 
@@ -65,6 +64,7 @@ n2words is also available on [jsDelivr](https://www.jsdelivr.com/package/npm/n2w
 - `de` (German)
 - `es` (Spanish)
 - `fr` (French)
+- `fr-BE` (French (Belgium))
 - `fa` (Farsi)
 - `he` (Hebrew)
 - `hr` (Croatian)
@@ -87,7 +87,7 @@ n2words is also available on [jsDelivr](https://www.jsdelivr.com/package/npm/n2w
 
 ## Contributing
 
-__This library is in active development.__ We are looking to improve the design and process for language contributors and to add more languages. Bug reports and feature requests are also extremely helpful!
+__This library is in active development.__ We want to improve the design and process for language contributors and add more languages. Bug reports and feature requests are also beneficial!
 
 ## License