n2words 1.14.0 → 1.16.0

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

@@ -1,67 +1,69 @@
-import AbstractLanguage from '../classes/AbstractLanguage.mjs';
+import AbstractLanguage from '../classes/AbstractLanguage.js';
 
 export class N2WordsID extends AbstractLanguage {
-  constructor() {
-    super({
+  base = {
+    0: 'không',
+    1: 'một',
+    2: 'hai',
+    3: 'ba',
+    4: 'bốn',
+    5: 'năm',
+    6: 'sáu',
+    7: 'bảy',
+    8: 'tám',
+    9: 'chín',
+    10: 'mười',
+    11: 'mười một',
+    12: 'mười hai',
+    13: 'mười ba',
+    14: 'mười bốn',
+    15: 'mười lăm',
+    16: 'mười sáu',
+    17: 'mười bảy',
+    18: 'mười tám',
+    19: 'mười chín',
+  };
+
+  tens = {
+    20: 'hai mươi',
+    30: 'ba mươi',
+    40: 'bốn mươi',
+    50: 'năm mươi',
+    60: 'sáu mươi',
+    70: 'bảy mươi',
+    80: 'tám mươi',
+    90: 'chín mươi',
+  };
+
+  thousands = {
+    1: 'nghìn', // 10^1
+    2: 'triệu', // 10^2
+    3: 'tỷ', // 10^3
+    4: 'nghìn tỷ',
+    5: 'trăm nghìn tỷ',
+    6: 'Quintillion',
+    7: 'Sextillion',
+    8: 'Septillion',
+    9: 'Octillion',
+    10: 'Nonillion',
+    11: 'Decillion',
+    12: 'Undecillion',
+    13: 'Duodecillion',
+    14: 'Tredecillion',
+    15: 'Quattuordecillion',
+    16: 'Sexdecillion',
+    17: 'Septendecillion',
+    18: 'Octodecillion',
+    19: 'Novemdecillion',
+    20: 'Vigintillion',
+  };
+
+  constructor(options) {
+    super(Object.assign({
       negativeWord: 'âm',
       separatorWord: 'phẩy',
       zero: 'không'
-    });
-
-    this.base = {
-      0: 'không',
-      1: 'một',
-      2: 'hai',
-      3: 'ba',
-      4: 'bốn',
-      5: 'năm',
-      6: 'sáu',
-      7: 'bảy',
-      8: 'tám',
-      9: 'chín',
-      10: 'mười',
-      11: 'mười một',
-      12: 'mười hai',
-      13: 'mười ba',
-      14: 'mười bốn',
-      15: 'mười lăm',
-      16: 'mười sáu',
-      17: 'mười bảy',
-      18: 'mười tám',
-      19: 'mười chín',
-    };
-    this.tens = {
-      20: 'hai mươi',
-      30: 'ba mươi',
-      40: 'bốn mươi',
-      50: 'năm mươi',
-      60: 'sáu mươi',
-      70: 'bảy mươi',
-      80: 'tám mươi',
-      90: 'chín mươi',
-    };
-    this.thousands = {
-      1: 'nghìn', // 10^1
-      2: 'triệu', // 10^2
-      3: 'tỷ', // 10^3
-      4: 'nghìn tỷ',
-      5: 'trăm nghìn tỷ',
-      6: 'Quintillion',
-      7: 'Sextillion',
-      8: 'Septillion',
-      9: 'Octillion',
-      10: 'Nonillion',
-      11: 'Decillion',
-      12: 'Undecillion',
-      13: 'Duodecillion',
-      14: 'Tredecillion',
-      15: 'Quattuordecillion',
-      16: 'Sexdecillion',
-      17: 'Septendecillion',
-      18: 'Octodecillion',
-      19: 'Novemdecillion',
-      20: 'Vigintillion',
-    };
+    }, options));
   }
 
   convertLess100(number) {
@@ -144,9 +146,10 @@ export class N2WordsID extends AbstractLanguage {
 /**
  * Converts a value to cardinal (written) form.
  * @param {number|string} value Number to be convert.
+ * @param {object} options Options for class.
  * @throws {Error} Value cannot be invalid.
  * @returns {string} Value in cardinal (written) format.
  */
-export default function (value) {
-  return new N2WordsID().floatToCardinal(value);
+export default function (value, options) {
+  return new N2WordsID(options).floatToCardinal(value);
 }

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

@@ -1,13 +1,13 @@
-import BaseLanguage from '../classes/BaseLanguage.mjs';
+import BaseLanguage from '../classes/BaseLanguage.js';
 
 export class N2WordsZH extends BaseLanguage {
-  constructor() {
-    super({
+  constructor(options) {
+    super(Object.assign({
       negativeWord: '负',
       separatorWord: '点',
       zero: '零',
       spaceSeparator: ''
-    },[
+    }, options), [
       [1000000000000n, '万'],
       [100000000n, '亿'],
       [10000n, '万'],
@@ -69,9 +69,10 @@ export class N2WordsZH extends BaseLanguage {
 /**
  * Converts a value to cardinal (written) form.
  * @param {number|string} value Number to be convert.
+ * @param {object} options Options for class.
  * @throws {Error} Value cannot be invalid.
  * @returns {string} Value in cardinal (written) format.
  */
-export default function(value) {
-  return new N2WordsZH().floatToCardinal(value);
+export default function(value, options) {
+  return new N2WordsZH(options).floatToCardinal(value);
 }

package/lib/n2words.js

@@ -0,0 +1,67 @@
+/* eslint-disable import/max-dependencies */
+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] User options.
+ * @returns {string} Value in written format.
+ */
+export default function(value, options = {lang: 'en'}) {
+  switch (options.lang) {
+    case 'en': return n2wordsEN(value, options); // default
+    case 'ar': return n2wordsAR(value, options);
+    case 'az': return n2wordsAZ(value, options);
+    case 'cz': return n2wordsCZ(value, options);
+    case 'de': return n2wordsDE(value, options);
+    case 'dk': return n2wordsDK(value, options);
+    case 'es': return n2wordsES(value, options);
+    case 'fa': return n2wordsFA(value, options);
+    case 'fr': return n2wordsFR(value, options);
+    case 'he': return n2wordsHE(value, options); // only for numbers <= 9999
+    case 'hr': return n2wordsHR(value, options);
+    case 'hu': return n2wordsHU(value, options);
+    case 'id': return n2wordsID(value, options);
+    case 'it': return n2wordsIT(value, options);
+    case 'ko': return n2wordsKO(value, options);
+    case 'lt': return n2wordsLT(value, options);
+    case 'lv': return n2wordsLV(value, options);
+    case 'nl': return n2wordsNL(value, options);
+    case 'no': return n2wordsNO(value, options);
+    case 'pl': return n2wordsPL(value, options);
+    case 'pt': return n2wordsPT(value, options);
+    case 'ru': return n2wordsRU(value, options);
+    case 'sr': return n2wordsSR(value, options);
+    case 'tr': return n2wordsTR(value, options);
+    case 'uk': return n2wordsUK(value, options);
+    case 'vi': return n2wordsVI(value, options);
+    case 'zh': return n2wordsZH(value, options);
+    default: throw Error('Unsupported language: ' + value + '.');
+  }
+}

package/package.json

@@ -1,22 +1,7 @@
 {
   "name": "n2words",
-  "version": "1.14.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.21.8",
-    "@babel/preset-env": "^7.21.5",
-    "ava": "^5.2.0",
-    "babel-loader": "^9.1.2",
-    "benchmark": "^2.1.4",
-    "c8": "^7.13.0",
-    "core-js": "^3.30.2",
-    "eslint": "^8.40.0",
-    "eslint-plugin-ava": "^14.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^44.2.3",
-    "eslint-plugin-node": "^11.1.0",
-    "microtime": "^3.1.1",
-    "webpack": "^5.82.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

package/bench.mjs

@@ -1,94 +0,0 @@
-import Benchmark from 'benchmark';
-/* eslint-disable import/max-dependencies */
-import n2wordsAR from './lib/i18n/AR.mjs';
-import n2wordsAZ from './lib/i18n/AZ.mjs';
-import n2wordsCZ from './lib/i18n/CZ.mjs';
-import n2wordsDE from './lib/i18n/DE.mjs';
-import n2wordsDK from './lib/i18n/DK.mjs';
-import n2wordsEN from './lib/i18n/EN.mjs';
-import n2wordsES from './lib/i18n/ES.mjs';
-import n2wordsFA from './lib/i18n/FA.mjs';
-import n2wordsFR from './lib/i18n/FR.mjs';
-import n2wordsHE from './lib/i18n/HE.mjs';
-import n2wordsHR from './lib/i18n/HR.mjs';
-import n2wordsHU from './lib/i18n/HU.mjs';
-import n2wordsID from './lib/i18n/ID.mjs';
-import n2wordsIT from './lib/i18n/IT.mjs';
-import n2wordsKO from './lib/i18n/KO.mjs';
-import n2wordsLT from './lib/i18n/LT.mjs';
-import n2wordsLV from './lib/i18n/LV.mjs';
-import n2wordsNL from './lib/i18n/NL.mjs';
-import n2wordsNO from './lib/i18n/NO.mjs';
-import n2wordsPL from './lib/i18n/PL.mjs';
-import n2wordsPT from './lib/i18n/PT.mjs';
-import n2wordsRU from './lib/i18n/RU.mjs';
-import n2wordsSR from './lib/i18n/SR.mjs';
-import n2wordsTR from './lib/i18n/TR.mjs';
-import n2wordsUK from './lib/i18n/UK.mjs';
-import n2wordsVI from './lib/i18n/VI.mjs';
-import n2wordsZH from './lib/i18n/ZH.mjs';
-
-const suite = new Benchmark.Suite();
-
-const i18n = {
-  'ar': n2wordsAR,
-  'az': n2wordsAZ,
-  'cz': n2wordsCZ,
-  'de': n2wordsDE,
-  'dk': n2wordsDK,
-  'en': n2wordsEN,
-  'es': n2wordsES,
-  'fa': n2wordsFA,
-  'fr': n2wordsFR,
-  'he': n2wordsHE,
-  'hr': n2wordsHR,
-  'hu': n2wordsHU,
-  'id': n2wordsID,
-  'it': n2wordsIT,
-  'ko': n2wordsKO,
-  'lt': n2wordsLT,
-  'lv': n2wordsLV,
-  'nl': n2wordsNL,
-  'no': n2wordsNO,
-  'pl': n2wordsPL,
-  'pt': n2wordsPT,
-  'ru': n2wordsRU,
-  'sr': n2wordsSR,
-  'tr': n2wordsTR,
-  'uk': n2wordsUK,
-  'vi': n2wordsVI,
-  'zh': n2wordsZH
-};
-
-const args = process.argv;
-args.slice(2);
-
-let language;
-let value = 9007199254740991;
-
-for (let i = 1; i < args.length; i++) {
-  if (args[i] == '--lang' || args[i] == '--language') {
-    language = args[i + 1];
-  } else if (args[i] == '--value') {
-    value = args[i + 1];
-  }
-}
-
-if (language) {
-  suite.add(language, () => {
-    i18n[language](value);
-  });
-} else {
-  Object.keys(i18n).forEach(language => {
-    suite.add(language, () => {
-      i18n[language](value);
-    });
-  });
-}
-
-suite
-  .on('cycle', event => {
-    // Output benchmark result by converting benchmark result to string
-    console.log(String(event.target));
-  })
-  .run();