n2words 1.9.0 → 1.11.0

package/.eslintrc.json

@@ -22,24 +22,83 @@
     "plugin:import/warnings",
     "plugin:jsdoc/recommended"
   ],
+  "overrides": [{
+    "files": ["*.js", "*.mjs"]
+  }],
   "parserOptions": {
     "ecmaVersion": 2021,
     "sourceType": "module"
   },
   "rules": {
-    "max-len": ["warn", {
-      "code": 130
-    }],
+    // Ignore platform dependent linebreak
     "linebreak-style": "off",
-    "jsdoc/require-jsdoc": "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/CHANGELOG.md

@@ -5,6 +5,40 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [1.11.0] - 2022-01-08
+
+### Added
+- New language: `hr` Croatian [#61](https://github.com/forzagreen/n2words/pull/61). Thanks to [@lagavuliner](https://github.com/lagavuliner) !
+
+### Fixed
+- Fix translations for Serbian [#60](https://github.com/forzagreen/n2words/pull/60) [#61](https://github.com/forzagreen/n2words/pull/61). Thanks to [@lagavuliner](https://github.com/lagavuliner) !
+
+
+## [1.10.1] - 2021-10-31
+
+### Fixed
+- Correct translation of number 18 for NL.mjs [#59](https://github.com/forzagreen/n2words/pull/59). Thanks to [@K4CZP3R](https://github.com/K4CZP3R) !
+- Update dev dependencies.
+
+
+## [1.10.0] - 2021-08-22
+### Added
+- New language: `id` Indonesian [#58](https://github.com/forzagreen/n2words/pull/58).
+
+### Changed
+- Migrate to ES6 classes [#55](https://github.com/forzagreen/n2words/pull/55). Thanks to [@TylerVigario](https://github.com/TylerVigario) !
+
+### Fixed
+- Accept numbers as string [#57](https://github.com/forzagreen/n2words/pull/57).
+
+
+## [1.9.1] - 2021-08-14
+### Changed
+- Configs: update dependencies, linting, camelCase [#51](https://github.com/forzagreen/n2words/pull/51). Thanks to [@TylerVigario](https://github.com/TylerVigario) !
+
+### Fixed
+- Fix Polish translation [#49](https://github.com/forzagreen/n2words/pull/49). Thanks to [@krzyhan](https://github.com/krzyhan) !
+
 ## [1.9.0] - 2020-12-19
 ### Added
 - New language: `zh` Chinese [#43](https://github.com/forzagreen/n2words/pull/43). Thanks to [@ljinke](https://github.com/ljinke) !

package/README.md

@@ -3,12 +3,25 @@
 [![Node CI](https://github.com/forzagreen/n2words/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/forzagreen/n2words/actions)
 [![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)
-[![Gitter](https://img.shields.io/gitter/room/forzagreen/n2words)](https://gitter.im/forzagreen/n2words)
+[![npm](https://img.shields.io/npm/dw/n2words)](https://npmjs.com/package/n2words)
 
 n2words converts numbers to words. It supports multiple languages.
 
 n2words is a lightweight, easy to use package, with no dependencies. It works both in Node.js and in browsers.
 
+
+## How To
+
+```js
+n2words(123)   // 'one hundred and twenty-three'
+n2words(-1.5)  // 'minus one point five'
+
+n2words(123, {lang: 'fr'})  // 'cent vingt-trois'
+n2words(123, {lang: 'es'})  // 'ciento veintitrés'
+n2words(123, {lang: 'ar'})  // 'مائة و ثلاثة و عشرون'
+```
+
+
 ## Install
 
 ```sh
@@ -23,14 +36,29 @@ n2words is available on [jsDelivr](https://jsdelivr.com/package/npm/n2words).
 
 ```js
 var n2words = require('n2words')
+
+// Dynamic Import (source files)
+import('n2words/lib/n2words.mjs').then(n2words => {
+    // Available via "default" method
+    n2words.default(100)
+})
+
+// Individual languages
+import('n2words/lib/i18n/EN.mjs').then(n2wordsEN => {
+    n2wordsEN.default(100)
+})
 ```
 
-### ES6
+### ESM
 
 ```js
 import n2words from 'n2words'
-// or to import source ES Modules without bundle and polyfills
+
+// ES6+
 import n2words from 'n2words/lib/n2words.mjs'
+
+// Individual languages
+import n2wordsEN from 'n2words/lib/i18n/EN.mjs'
 ```
 
 ### Browser
@@ -39,17 +67,6 @@ import n2words from 'n2words/lib/n2words.mjs'
 <script src="n2words.js"></script>
 ```
 
-## Example
-
-```js
-n2words(123)   // 'one hundred and twenty-three'
-n2words(-1.5)  // 'minus one point five'
-
-n2words(123, {lang: 'en'})  // 'one hundred and twenty-three'
-n2words(123, {lang: 'fr'})  // 'cent vingt-trois'
-n2words(123, {lang: 'es'})  // 'ciento veintitrés'
-```
-
 ## Features
 
 - Cardinal numbers
@@ -67,7 +84,9 @@ n2words(123, {lang: 'es'})  // 'ciento veintitrés'
 - `fr` (French)
 - `fa` (Farsi)
 - `he` (Hebrew)
+- `hr` (Croatian)
 - `hu` (Hungarian)
+- `id` (Indonesian)
 - `it` (Italian)
 - `ko` (Korean)
 - `lt` (Lithuanian)