n2words 1.15.0 → 1.16.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Wael TELLAT
+Copyright (c) 2018-2023 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

package/README.md

@@ -4,12 +4,11 @@
 [![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)
 
-n2words is a library that converts a numerical number into a written number.
+__n2words__ converts a numerical number into a written one, supports [27 languages](https://github.com/forzagreen/n2words#supported-languages), and has zero dependencies.
 
-We have support for multiple languages (27 and growing) and our package is lightweight, modular and has no dependencies.
-
-## How To
+## Example
 
 ```js
 n2words(123)   // 'one hundred and twenty-three'
@@ -20,6 +19,8 @@ n2words(123, {lang: 'es'})  // 'ciento veintitrés'
 n2words(123, {lang: 'ar'})  // 'مائة و ثلاثة و عشرون'
 ```
 
+See the [Wiki](https://github.com/forzagreen/n2words/wiki) for examples and advanced usage.
+
 ## Install
 
 ```sh
@@ -34,42 +35,28 @@ n2words is also available on [jsDelivr](https://jsdelivr.com/package/npm/n2words
 
 ```js
 import n2words from 'n2words'
-
-// Source file
-import n2words from 'n2words/lib/n2words.mjs'
-
-// Individual languages (recommended)
-import n2wordsEN from 'n2words/lib/i18n/EN.mjs'
 ```
 
 ### CommonJS
 
 ```js
-var n2words = require('n2words')
-
-// Dynamic Import (source files)
-import('n2words/lib/n2words.mjs').then(n2words => {
+// Dynamic Import
+import('n2words').then(n2words => {
     // Available via "default" method
     n2words.default(100)
 })
-
-// Individual languages
-import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
-    n2wordsEN.default(100)
-})
 ```
 
 ### Browser
 
 ```html
 <script src="n2words.js"></script>
+<script>
+    n2words(100)
+</script>
 ```
 
-## Features
-
-- Cardinal numbers
-- Decimal numbers
-- Negative numbers
+You can also [import only specific languages](https://github.com/forzagreen/n2words/wiki/Importing-only-specific-languages) if you don't need all of them.
 
 ## Supported Languages
 
@@ -103,10 +90,7 @@ import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
 
 ## Contributing
 
-You can help by adding new languages or by improving existing ones. Also, reporting issues, verifying the correctness of unit tests or adding more test cases is extremely helpful.
-
-All help is welcome!
-
+__This library is in active development.__ We are looking to improve the design and process for language contributors as well as add more languages.
 ## License
 
-MIT
+[MIT](https://github.com/forzagreen/n2words/blob/master/LICENSE)

package/lib/classes/{AbstractLanguage.mjs → AbstractLanguage.js}

@@ -11,10 +11,10 @@ export default class {
 
   /**
    * @param {object} options Options for class.
-   * @param {string} [options.negativeWord = ''] Word that precedes a negative number (if any).
+   * @param {string} [options.negativeWord] Word that precedes a negative number (if any).
    * @param {string} options.separatorWord Word that separates cardinal numbers (i.e. "and").
    * @param {string} options.zero Word for 0 (i.e. "zero").
-   * @param {string} [options.spaceSeparator = ' '] Character that separates words.
+   * @param {string} [options.spaceSeparator] Character that separates words.
    */
   constructor(options) {
     // Merge supplied options with defaults

package/lib/classes/{BaseLanguage.mjs → BaseLanguage.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from './AbstractLanguage.mjs';
+import AbstractLanguage from './AbstractLanguage.js';
 
 /**
  * Creates new common language class that uses a highest matching word value algorithm.
@@ -11,10 +11,10 @@ export default class extends AbstractLanguage {
 
   /**
    * @param {object} options Options for class.
-   * @param {string} [options.negativeWord = ''] Word that precedes a negative number (if any).
+   * @param {string} [options.negativeWord] Word that precedes a negative number (if any).
    * @param {string} options.separatorWord Word that separates cardinal numbers (i.e. "and").
    * @param {string} options.zero Word for 0 (i.e. "zero").
-   * @param {string} [options.spaceSeparator = ' '] Character that separates words.
+   * @param {string} [options.spaceSeparator] Character that separates words.
    * @param {Array} cards Array of number matching "cards" from highest-to-lowest.
    */
   constructor(options, cards) {

package/lib/i18n/{AR.mjs → AR.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class Arabic extends AbstractLanguage {
   integerValue = 0;

package/lib/i18n/{AZ.mjs → AZ.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsAZ extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{CZ.mjs → CZ.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsCZ extends N2WordsRU {
   ones = {

package/lib/i18n/{DE.mjs → DE.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsDE extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{DK.mjs → DK.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsDK extends BaseLanguage {
   ordFlag;

package/lib/i18n/{EN.mjs → EN.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 /**
  * This class is for converting numbers to english words.

package/lib/i18n/{ES.mjs → ES.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsES extends BaseLanguage {
   genderStem;

package/lib/i18n/{FA.mjs → FA.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class N2WordsFA extends AbstractLanguage {
   namedNumbers = {

package/lib/i18n/{FR.mjs → FR.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsFR extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{HE.mjs → HE.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsHE extends N2WordsRU {
   and;

package/lib/i18n/{HR.mjs → HR.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsHR extends N2WordsRU {
   ones = {

package/lib/i18n/{HU.mjs → HU.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsHU extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{ID.mjs → ID.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class N2WordsID extends AbstractLanguage {
   base = {

package/lib/i18n/{IT.mjs → IT.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsIT extends BaseLanguage {
   cardinalWords = [

package/lib/i18n/{KO.mjs → KO.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsKO extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{LT.mjs → LT.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsLT extends N2WordsRU {
   ones = {

package/lib/i18n/{LV.mjs → LV.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsLV extends N2WordsRU{
   ones = {

package/lib/i18n/{NL.mjs → NL.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsNL extends BaseLanguage {
   includeOptionalAnd;

package/lib/i18n/{NO.mjs → NO.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsNO extends BaseLanguage {
   constructor(options) {

package/lib/i18n/{PL.mjs → PL.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsPL extends N2WordsRU {
   ones = {

package/lib/i18n/{PT.mjs → PT.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsPT extends BaseLanguage {
   hundreds = {

package/lib/i18n/{RU.mjs → RU.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class N2WordsRU extends AbstractLanguage {
   feminine;

package/lib/i18n/{SR.mjs → SR.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsSR extends N2WordsRU {
   ones = {

package/lib/i18n/{TR.mjs → TR.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsTR extends BaseLanguage {
   constructor(options = {}) {

package/lib/i18n/{UK.mjs → UK.js}

@@ -1,4 +1,4 @@
-import {N2WordsRU} from './RU.mjs';
+import {N2WordsRU} from './RU.js';
 
 export class N2WordsUK extends N2WordsRU {
   ones = {

package/lib/i18n/{VI.mjs → VI.js}

@@ -1,4 +1,4 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class N2WordsID extends AbstractLanguage {
   base = {

package/lib/i18n/{ZH.mjs → ZH.js}

@@ -1,4 +1,4 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsZH extends BaseLanguage {
   constructor(options) {

package/lib/{n2words.mjs → n2words.js}

@@ -1,36 +1,36 @@
 /* eslint-disable import/max-dependencies */
-import n2wordsAR from './i18n/AR.mjs';
-import n2wordsAZ from './i18n/AZ.mjs';
-import n2wordsCZ from './i18n/CZ.mjs';
-import n2wordsDE from './i18n/DE.mjs';
-import n2wordsDK from './i18n/DK.mjs';
-import n2wordsEN from './i18n/EN.mjs';
-import n2wordsES from './i18n/ES.mjs';
-import n2wordsFA from './i18n/FA.mjs';
-import n2wordsFR from './i18n/FR.mjs';
-import n2wordsHE from './i18n/HE.mjs';
-import n2wordsHR from './i18n/HR.mjs';
-import n2wordsHU from './i18n/HU.mjs';
-import n2wordsID from './i18n/ID.mjs';
-import n2wordsIT from './i18n/IT.mjs';
-import n2wordsKO from './i18n/KO.mjs';
-import n2wordsLT from './i18n/LT.mjs';
-import n2wordsLV from './i18n/LV.mjs';
-import n2wordsNL from './i18n/NL.mjs';
-import n2wordsNO from './i18n/NO.mjs';
-import n2wordsPL from './i18n/PL.mjs';
-import n2wordsPT from './i18n/PT.mjs';
-import n2wordsRU from './i18n/RU.mjs';
-import n2wordsSR from './i18n/SR.mjs';
-import n2wordsTR from './i18n/TR.mjs';
-import n2wordsUK from './i18n/UK.mjs';
-import n2wordsVI from './i18n/VI.mjs';
-import n2wordsZH from './i18n/ZH.mjs';
+import n2wordsAR from './i18n/AR.js';
+import n2wordsAZ from './i18n/AZ.js';
+import n2wordsCZ from './i18n/CZ.js';
+import n2wordsDE from './i18n/DE.js';
+import n2wordsDK from './i18n/DK.js';
+import n2wordsEN from './i18n/EN.js';
+import n2wordsES from './i18n/ES.js';
+import n2wordsFA from './i18n/FA.js';
+import n2wordsFR from './i18n/FR.js';
+import n2wordsHE from './i18n/HE.js';
+import n2wordsHR from './i18n/HR.js';
+import n2wordsHU from './i18n/HU.js';
+import n2wordsID from './i18n/ID.js';
+import n2wordsIT from './i18n/IT.js';
+import n2wordsKO from './i18n/KO.js';
+import n2wordsLT from './i18n/LT.js';
+import n2wordsLV from './i18n/LV.js';
+import n2wordsNL from './i18n/NL.js';
+import n2wordsNO from './i18n/NO.js';
+import n2wordsPL from './i18n/PL.js';
+import n2wordsPT from './i18n/PT.js';
+import n2wordsRU from './i18n/RU.js';
+import n2wordsSR from './i18n/SR.js';
+import n2wordsTR from './i18n/TR.js';
+import n2wordsUK from './i18n/UK.js';
+import n2wordsVI from './i18n/VI.js';
+import n2wordsZH from './i18n/ZH.js';
 
 /**
  * Converts a number to written form.
  * @param {number|string} value The number to convert.
- * @param {object} [options = {lang: en}] User options.
+ * @param {object} [options] User options.
  * @returns {string} Value in written format.
  */
 export default function(value, options = {lang: 'en'}) {

package/package.json

@@ -1,22 +1,7 @@
 {
   "name": "n2words",
-  "version": "1.15.0",
-  "description": "Convert numbers to words, in multiple languages",
-  "main": "dist/n2words.js",
-  "scripts": {
-    "lint": "eslint --config .eslintrc.json lib/ test/",
-    "test": "ava --verbose",
-    "coverage": "c8 ava",
-    "build": "webpack --config webpack.config.js --progress",
-    "bench": "node bench.mjs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/forzagreen/n2words.git"
-  },
-  "engines": {
-    "node": "16 || >=18"
-  },
+  "version": "1.16.0",
+  "description": "n2words converts a numerical number into a written one, supports 27 languages and has zero dependencies.",
   "keywords": [
     "n2words",
     "convert",
@@ -54,28 +39,31 @@
     "vietnamese",
     "azerbaijani"
   ],
-  "author": "Wael TELLAT",
-  "license": "MIT",
+  "homepage": "https://github.com/forzagreen/n2words#readme",
   "bugs": {
     "url": "https://github.com/forzagreen/n2words/issues"
   },
-  "homepage": "https://github.com/forzagreen/n2words#readme",
-  "devDependencies": {
-    "@babel/core": "^7.22.1",
-    "@babel/preset-env": "^7.22.4",
-    "ava": "^5.3.0",
-    "babel-loader": "^9.1.2",
-    "benchmark": "^2.1.4",
-    "c8": "^7.14.0",
-    "core-js": "^3.30.2",
-    "eslint": "^8.41.0",
-    "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^45.0.0",
-    "eslint-plugin-node": "^11.1.0",
-    "microtime": "^3.1.1",
-    "webpack": "^5.84.1",
-    "webpack-cli": "^5.1.1"
+  "repository": "github:forzagreen/n2words",
+  "license": "MIT",
+  "author": "Wael TELLAT",
+  "contributors": [
+    "Tyler Vigario <TylerVigario90@gmail.com>"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./lib/n2words.js",
+    "./i18n/": "./lib/i18n/"
+  },
+  "files": [
+    "lib/*",
+    "build/*"
+  ],
+  "scripts": {
+    "bench": "node bench.js",
+    "build": "webpack --config webpack.config.js --progress",
+    "coverage": "c8 ava",
+    "lint": "eslint --config .eslintrc.json lib/ test/",
+    "test": "ava --verbose"
   },
   "ava": {
     "files": [
@@ -92,5 +80,25 @@
       "lcov",
       "text"
     ]
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.1",
+    "@babel/preset-env": "^7.22.4",
+    "ava": "^5.3.0",
+    "babel-loader": "^9.1.2",
+    "benchmark": "^2.1.4",
+    "c8": "^7.14.0",
+    "core-js": "^3.30.2",
+    "eslint": "^8.41.0",
+    "eslint-plugin-ava": "^14.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jsdoc": "^46.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "microtime": "^3.1.1",
+    "webpack": "^5.84.1",
+    "webpack-cli": "^5.1.1"
+  },
+  "engines": {
+    "node": "16 || >=18"
   }
 }

package/.editorconfig

@@ -1,13 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-indent_size = 2
-tab_width = 2
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true
-quote_type = single
-
-[*.json]
-quote_type = double

package/.eslintrc.json

@@ -1,105 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "commonjs": true,
-    "es6": true,
-    "es2017": true,
-    "es2020": true,
-    "es2021": true,
-    "es2022": true,
-    "node": true
-  },
-  "plugins": [
-    "ava",
-    "node",
-    "import",
-    "jsdoc"
-  ],
-  "extends": [
-    "eslint:recommended",
-    "plugin:ava/recommended",
-    "plugin:node/recommended",
-    "plugin:import/errors",
-    "plugin:import/warnings",
-    "plugin:jsdoc/recommended"
-  ],
-  "overrides": [{
-    "files": ["*.js", "*.mjs"]
-  }],
-  "parserOptions": {
-    "ecmaVersion": "latest",
-    "sourceType": "module"
-  },
-  "rules": {
-    // Ignore platform dependent linebreak
-    "linebreak-style": "off",
-    // Remove maximum length limit
-    "max-len": "off",
-    // Enforce camelCase for variable names
-    "camelcase": ["error", {
-      "properties": "never"
-    }],
-    // Enforce indent of two spaces
-    "indent": [
-      "error", 2, {
-        "SwitchCase": 1
-      }
-    ],
-    // Remove trailing whitespace
-    "no-trailing-spaces": "error",
-    // Enforce use of single quotes
-    "quotes": ["error", "single"],
-    // Enforce use of semicolon to end lines
-    "semi": "error",
-    // Enforce consistent spacing before & after arrow function
-    "arrow-spacing": "error",
-    // Enforce omitting parentheses when unnecessary for arrow functions
-    "arrow-parens": ["error", "as-needed"],
-    // Disallow multiple imports of same module
-    "no-duplicate-imports": "error",
-    // Enforce let or const instead of var
-    "no-var": "error",
-    // Enforce consistent brace style usage (1TBS default)
-    "brace-style": "error",
-    //
-    // -- IMPORT RULES --
-    //
-    // Report any invalid exports, i.e. re-export of the same name
-    "import/export": "error",
-    // Report modules without exports, or exports without matching import in another module
-    "import/no-unused-modules": "error",
-    // Report potentially ambiguous parse goal (script vs. module)
-    "import/unambiguous": "error",
-    // Report CommonJS require calls and module.exports or exports.*
-    "import/no-commonjs": "error",
-    // Report AMD require and define calls
-    "import/no-amd": "error",
-    // No Node.js builtin modules
-    "import/no-nodejs-modules": "error",
-    // Report imported names marked with @deprecated documentation tag
-    "import/no-deprecated": "error",
-    // Ensure all imports appear before other statements
-    "import/first": "error",
-    // Ensure consistent use of file extension within the import path
-    "import/extensions": ["error", "always"],
-    // Enforce a newline after import statements
-    "import/newline-after-import": "error",
-    // Ensure imports point to a file/module that can be resolved
-    "import/no-unresolved": ["error", {
-      "commonjs": true
-    }],
-    // Limit the maximum number of dependencies a module can have
-    "import/max-dependencies": "error",
-    // Prefer a default export if module exports a single name
-    "import/prefer-default-export": "error",
-    // Forbid unassigned imports
-    "import/no-unassigned-import": ["error", {
-      "allow": ["**/app.mjs"]
-    }]
-    //
-    // -- JSDOC RULES --
-    //
-    // Checks for presence of jsdoc comments, on class declarations as well as functions
-    //"jsdoc/require-jsdoc": "off"
-  }
-}

package/.gitattributes

@@ -1,5 +0,0 @@
-# Automatically convert to native line endings
-* text=auto
-
-# Force Unix (LF) line endings
-package-lock.json  text eol=lf