tanisa 1.0.1 → 1.1.0

package/README.md

@@ -11,6 +11,7 @@
 - ✅ **Decimal support** : Gracefully converts those pesky fractions into spoken form.
 - ✅ **Large number linguistics**: Tackles big numbers with the appropriate Malagasy terminology.
 - ✅ **User-friendly API** : So intuitive, you'll feel like you've been speaking number-words your whole life.
+- ✅ **Configurable options** : Customize the conversion behavior, like controlling how decimal places are handled and more...
 - 🛡️ **Error Handling** : Throws helpful errors when you try to feed it something it can't digest.
 
 ## Installation
@@ -22,13 +23,13 @@
 1. Import the Magic:
 
 ```
-import { MalagasyNumberToWords } from 'tanisa'
+import { Tanisa } from 'tanisa'
 ```
 
 2. Simply use it:
 
 ```
-const tanisa = new MalagasyNumberToWords();
+const tanisa = new Tanisa();
 
 tanisa.toWords(233)
 ```
@@ -40,3 +41,26 @@ tanisa.toWords(233) ==> Telo amby telopolo sy roanjato
 tanisa.toWords(18.3) ==> Valo amby folo faingo telo
 tanisa.toWords(0.008) ==> Aotra faingo aotra aotra valo
 ```
+
+## Options
+
+| Option Name     | Type      | Default                    | Description                                                                                                                                     |
+| :-------------- | :-------- | :------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ignoreDecimal` | `boolean` | `false`                    | If set to `true`, the converter completely disregards any digits after the decimal point. Only the integer part of the number is considered.    |
+| `decimalPlaces` | `number`  | `undefined` (converts all) | Specifies the maximum number of digits to convert in the decimal part. Extra digits are truncated (not rounded). Set to `0` to ignore decimals. |
+
+**Note:** If both `ignoreDecimal` is `true` and `decimalPlaces` is set, `ignoreDecimal: true` takes precedence, and the decimal part will be entirely ignored.
+
+Examples:
+
+```
+converter.toWords("456.789", { ignoreDecimal: true }) => Enina amby dimampolo sy efajato
+
+converter.toWords("3.14567", { decimalPlaces: 2 }); ==>  Telo faingo efatra amby folo
+
+converter.toWords("3.14567", { decimalPlaces: 2, ignoreDecimal: true }); ==>  Telo
+```
+
+## License
+
+This project is proudly released under the [MIT License](https://github.com/nifaliana/tanisa/blob/main/LICENSE)

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "tanisa",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "src/index.ts",
   "description": "An utility to convert Malagasy 🇲🇬 numbers, including decimals, into their word representations.",
   "license": "MIT",
   "author": {
     "name": "Rija Nifaliana",
-    "email": "rija.nifaliana@gmail.com"
+    "email": "rija.nifaliana@gmail.com",
+    "url": "https://github.com/nifaliana"
   },
   "scripts": {
     "test": "vitest run",
@@ -46,5 +47,13 @@
     "fanisana",
     "typescript",
     "javascript"
-  ]
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nifaliana/tanisa.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nifaliana/tanisa/issues"
+  },
+  "homepage": "https://github.com/nifaliana/tanisa#readme"
 }

package/src/converter.ts

@@ -1,14 +1,20 @@
 import { LargeNumberUnit, MalagasyNumerals } from './dictionary'
+import { TanisaOptions } from './interface'
 
 export class Tanisa {
-  public toWords(number: number | string): string {
-    const numStr = String(number)
+  public toWords(number: number | string, options?: TanisaOptions): string {
+    const ignoreDecimal = options?.ignoreDecimal ?? false
+    const decimalPlaces = options?.decimalPlaces ?? -1
+
+    const numStr = String(number).trim()
     const [integerPartStr, decimalPartStr] = numStr.split('.')
     const integerPartNum = parseInt(integerPartStr || '0', 10)
 
     if (
       isNaN(integerPartNum) ||
-      (decimalPartStr && isNaN(parseInt(decimalPartStr, 10)))
+      (decimalPartStr &&
+        decimalPartStr.length > 0 &&
+        isNaN(parseInt(decimalPartStr, 10)))
     ) {
       throw new TypeError(`Invalid number input: "${number}"`)
     }
@@ -29,21 +35,40 @@ export class Tanisa {
     const integerWords = this.convertInteger(integerPartNum)
 
     let decimalWords = ''
-    if (decimalPartStr && decimalPartStr.length > 0) {
-      for (let i = 0; i < decimalPartStr.length; i++) {
-        const digit = decimalPartStr[i]
-        if (digit === '0') {
-          decimalWords += MalagasyNumerals.GLUE_DECIMAL_ZERO
-        } else {
-          const remainingDecimal = decimalPartStr.substring(i)
-          decimalWords += this.convertInteger(parseInt(remainingDecimal, 10))
-          break
+    const processDecimals =
+      decimalPartStr &&
+      decimalPartStr.length > 0 &&
+      !ignoreDecimal &&
+      decimalPlaces !== 0
+
+    if (processDecimals) {
+      let effectiveDecimalPartStr = decimalPartStr
+
+      if (decimalPlaces > 0 && decimalPartStr.length > decimalPlaces) {
+        effectiveDecimalPartStr = decimalPartStr.substring(0, decimalPlaces)
+      }
+
+      if (parseInt(effectiveDecimalPartStr || '0', 10) > 0) {
+        let tempDecimalWords = ''
+        for (let i = 0; i < effectiveDecimalPartStr.length; i++) {
+          const digit = effectiveDecimalPartStr[i]
+          if (digit === '0') {
+            tempDecimalWords += MalagasyNumerals.GLUE_DECIMAL_ZERO
+          } else {
+            const remainingDecimal = effectiveDecimalPartStr.substring(i)
+            tempDecimalWords += this.convertInteger(
+              parseInt(remainingDecimal, 10)
+            )
+            break
+          }
+        }
+        if (tempDecimalWords) {
+          decimalWords = MalagasyNumerals.GLUE_FAINGO + tempDecimalWords
         }
       }
-      return integerWords + MalagasyNumerals.GLUE_FAINGO + decimalWords
-    } else {
-      return integerWords
     }
+
+    return integerWords + decimalWords
   }
 
   private convertInteger(num: number): string {

package/src/interface.ts

@@ -0,0 +1,15 @@
+export interface TanisaOptions {
+  /**
+   * If true, ignores the decimal part of the number.
+   * @default false
+   */
+  ignoreDecimal?: boolean
+
+  /**
+   * Specifies the maximum number of decimal places to convert.
+   * Extra decimal places will be truncated (not rounded).
+   * Set to 0 to ignore decimals.
+   * @default undefined (converts all decimal places)
+   */
+  decimalPlaces?: number
+}

package/tests/converter.test.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect, beforeEach } from 'vitest'
 import { Tanisa, MalagasyNumerals } from '../src'
+import { TanisaOptions } from '../src/interface'
 
 describe('MalagasyNumberToWords', () => {
   let converter: Tanisa
@@ -124,4 +125,77 @@ describe('MalagasyNumberToWords', () => {
       expect(() => converter.toWords(safeInt)).not.toThrow()
     })
   })
+
+  describe('ignoreDecimal option', () => {
+    it('should ignore decimal part when ignoreDecimal is true', () => {
+      const options: TanisaOptions = { ignoreDecimal: true }
+      expect(converter.toWords(123.456, options)).toBe(
+        'telo amby roapolo amby zato'
+      )
+      expect(converter.toWords(0.99, options)).toBe('aotra')
+      expect(converter.toWords(1000.001, options)).toBe('arivo')
+    })
+
+    it('should NOT ignore decimal part when ignoreDecimal is false or absent', () => {
+      expect(converter.toWords(10.5, { ignoreDecimal: false })).toBe(
+        'folo faingo dimy'
+      )
+      expect(converter.toWords(10.5)).toBe('folo faingo dimy')
+    })
+  })
+
+  describe('decimalPlaces option', () => {
+    it('should ignore decimal part when decimalPlaces is 0', () => {
+      const options: TanisaOptions = { decimalPlaces: 0 }
+      expect(converter.toWords(123.456, options)).toBe(
+        'telo amby roapolo amby zato'
+      )
+      expect(converter.toWords(0.99, options)).toBe('aotra')
+    })
+
+    it('should truncate decimal part to specified places', () => {
+      expect(converter.toWords(1.2345, { decimalPlaces: 1 })).toBe(
+        'iray faingo roa'
+      )
+      expect(converter.toWords(1.2345, { decimalPlaces: 2 })).toBe(
+        'iray faingo telo amby roapolo'
+      )
+      expect(converter.toWords(1.2345, { decimalPlaces: 3 })).toBe(
+        'iray faingo efatra amby telopolo sy roanjato'
+      )
+    })
+
+    it('should handle leading zeros correctly with truncation', () => {
+      expect(converter.toWords(10.056, { decimalPlaces: 1 })).toBe('folo')
+      expect(converter.toWords(10.056, { decimalPlaces: 2 })).toBe(
+        'folo faingo aotra dimy'
+      )
+      expect(converter.toWords(10.056, { decimalPlaces: 3 })).toBe(
+        'folo faingo aotra enina amby dimampolo'
+      )
+      expect(converter.toWords(10.009, { decimalPlaces: 2 })).toBe('folo')
+      expect(converter.toWords(10.009, { decimalPlaces: 3 })).toBe(
+        'folo faingo aotra aotra sivy'
+      )
+    })
+
+    it('should convert all decimals if decimalPlaces is equal to or greater than actual places', () => {
+      expect(converter.toWords(5.67, { decimalPlaces: 2 })).toBe(
+        'dimy faingo fito amby enimpolo'
+      )
+      expect(converter.toWords(5.67, { decimalPlaces: 3 })).toBe(
+        'dimy faingo fito amby enimpolo'
+      )
+      expect(converter.toWords(5.67, { decimalPlaces: 10 })).toBe(
+        'dimy faingo fito amby enimpolo'
+      )
+    })
+  })
+
+  describe('decimalPlaces and ignoreDecimal options', () => {
+    it('should ignore decimal part if both params is set', () => {
+      const options: TanisaOptions = { decimalPlaces: 2, ignoreDecimal: true }
+      expect(converter.toWords(3.134343, options)).toBe('telo')
+    })
+  })
 })