commafy-anything 2.1.0 → 3.0.1

package/README.md

@@ -1,5 +1,8 @@
 # Commafy anything 🍡
 
+<a href="https://www.npmjs.com/package/commafy-anything"><img src="https://img.shields.io/npm/v/commafy-anything.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/commafy-anything"><img src="https://img.shields.io/npm/dw/commafy-anything.svg" alt="Latest Stable Version"></a>
+
 ```
 npm i commafy-anything
 ```
@@ -23,9 +26,9 @@ U built this package because I needed to add comma's to numbers! And I wanted to
 ## Usage
 
 ```js
-import commafy from 'commafy-anything'
+import { commafy } from 'commafy-anything'
 
-commafy(1000) === '1000'
+commafy(1000) === '1,000'
 commafy(10000) === '10,000'
 commafy(100000) === '100,000'
 commafy(1000000) === '1,000,000'
@@ -36,11 +39,12 @@ commafy(1000000) === '1,000,000'
 
 ```js
 // default:
-commafy(1000) === '1000'
+commafy(1000) === '1,000'
 
 // thousands:
-const options = {thousands: true}
-commafy(1000, options) === '1,000'
+const options = {thousandsComma: false}
+commafy(1000, options) === '1000'
+commafy(10000, options) === '10,000'
 ```
 
 ### Spaced decimals
@@ -79,7 +83,7 @@ I'm using simple regular expressions. The source code is in TypeScript, but the
 ```js
 function commafy (num, {stripDecimals, spacedDecimals} = {}) {
   const str = num.toString().split('.')
-  if (str[0].length >= 5) {
+  if (str[0].length >= 4) {
     str[0] = str[0].replace(/(\d)(?=(\d{3})+$)/g, '$1,')
   }
   if (stripDecimals) return str[0]

package/dist/{index.cjs.js → index.cjs}

@@ -11,16 +11,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * @returns {string} eg. '1,000,000'
  */
 function commafy(num, options) {
-    var _a = options || {}, _b = _a.stripDecimals, stripDecimals = _b === void 0 ? false : _b, _c = _a.spacedDecimals, spacedDecimals = _c === void 0 ? false : _c, _d = _a.thousandsComma, thousandsComma = _d === void 0 ? true : _d, _e = _a.K, K = _e === void 0 ? false : _e;
-    var _f = num.toString().split('.'), wholeNrStr = _f[0], _g = _f[1], decimalStr = _g === void 0 ? '' : _g;
-    var str = [wholeNrStr, decimalStr];
-    var minLength = thousandsComma ? 4 : 5;
+    const { stripDecimals = false, spacedDecimals = false, thousandsComma = true, K = false } = options || {};
+    const [wholeNrStr, decimalStr = ''] = num.toString().split('.');
+    const str = [wholeNrStr, decimalStr];
+    const minLength = thousandsComma ? 4 : 5;
     if (!K && wholeNrStr.length >= minLength) {
         str[0] = wholeNrStr.replace(/(\d)(?=(\d{3})+$)/g, '$1,');
     }
     if (K && wholeNrStr.length > 3) {
-        var numInK = Math.round(num / 1000);
-        var commafied = numInK.toString().replace(/(\d)(?=(\d{3})+$)/g, '$1,');
+        const numInK = Math.round(num / 1000);
+        const commafied = numInK.toString().replace(/(\d)(?=(\d{3})+$)/g, '$1,');
         str[0] = commafied + 'K';
     }
     if (stripDecimals || !decimalStr || K)

package/dist/{index.esm.js → index.es.js}

@@ -7,16 +7,16 @@
  * @returns {string} eg. '1,000,000'
  */
 function commafy(num, options) {
-    var _a = options || {}, _b = _a.stripDecimals, stripDecimals = _b === void 0 ? false : _b, _c = _a.spacedDecimals, spacedDecimals = _c === void 0 ? false : _c, _d = _a.thousandsComma, thousandsComma = _d === void 0 ? true : _d, _e = _a.K, K = _e === void 0 ? false : _e;
-    var _f = num.toString().split('.'), wholeNrStr = _f[0], _g = _f[1], decimalStr = _g === void 0 ? '' : _g;
-    var str = [wholeNrStr, decimalStr];
-    var minLength = thousandsComma ? 4 : 5;
+    const { stripDecimals = false, spacedDecimals = false, thousandsComma = true, K = false } = options || {};
+    const [wholeNrStr, decimalStr = ''] = num.toString().split('.');
+    const str = [wholeNrStr, decimalStr];
+    const minLength = thousandsComma ? 4 : 5;
     if (!K && wholeNrStr.length >= minLength) {
         str[0] = wholeNrStr.replace(/(\d)(?=(\d{3})+$)/g, '$1,');
     }
     if (K && wholeNrStr.length > 3) {
-        var numInK = Math.round(num / 1000);
-        var commafied = numInK.toString().replace(/(\d)(?=(\d{3})+$)/g, '$1,');
+        const numInK = Math.round(num / 1000);
+        const commafied = numInK.toString().replace(/(\d)(?=(\d{3})+$)/g, '$1,');
         str[0] = commafied + 'K';
     }
     if (stripDecimals || !decimalStr || K)

package/package.json

@@ -1,19 +1,30 @@
 {
   "name": "commafy-anything",
   "sideEffects": false,
-  "version": "2.1.0",
+  "type": "module",
+  "version": "3.0.1",
   "description": "Adds comma's to a number. A simple and small integration",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "types/index.d.ts",
-  "directories": {
-    "test": "test"
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13"
   },
   "scripts": {
-    "test": "ava",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c build/rollup.js",
-    "build": "npm run lint && npm run test && npm run rollup"
+    "test": "vitest run",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
   },
   "repository": {
     "type": "git",
@@ -26,31 +37,55 @@
     "number"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mesqueeb/commafy-anything/issues"
   },
   "homepage": "https://github.com/mesqueeb/commafy-anything#readme",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
-    "ava": "^3.13.0",
-    "eslint": "^7.13.0",
-    "eslint-config-prettier": "^6.15.0",
-    "eslint-plugin-tree-shaking": "^1.8.0",
-    "rollup": "^2.33.2",
-    "rollup-plugin-typescript2": "^0.29.0",
-    "tsconfig-paths": "^3.9.0",
-    "ts-node": "^9.0.0",
-    "typescript": "^4.0.5"
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.1"
+  },
+  "np": {
+    "yarn": false,
+    "branch": "production"
   },
-  "ava": {
-    "extensions": [
-      "ts"
+  "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint",
+      "tree-shaking"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
     ],
-    "require": [
-      "tsconfig-paths/register",
-      "ts-node/register"
-    ]
+    "rules": {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-ts-ignore": "off",
+      "tree-shaking/no-side-effects-in-initialization": "error",
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
   }
 }

package/.eslintignore

@@ -1,9 +0,0 @@
-# don't ever lint node_modules
-node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
-dist
-# don't lint nyc coverage output
-coverage
-
-test
-.eslintrc.js

package/.eslintrc.js

@@ -1,17 +0,0 @@
-// npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-tree-shaking
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'tree-shaking'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier/@typescript-eslint',
-  ],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-ignore': 'off',
-    'tree-shaking/no-side-effects-in-initialization': 'error',
-  },
-}

package/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: mesqueeb
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "semi": false,
-  "bracketSpacing": true,
-  "quoteProps": "consistent"
-}

package/build/rollup.js

@@ -1,59 +0,0 @@
-/* eslint-disable */
-
-// npm install rollup-plugin-typescript2 typescript --save-dev
-import typescript from 'rollup-plugin-typescript2'
-// import { terser } from 'rollup-plugin-terser'
-// import resolve from 'rollup-plugin-node-resolve'
-
-// ------------------------------------------------------------------------------------------
-// formats
-// ------------------------------------------------------------------------------------------
-// amd – Asynchronous Module Definition, used with module loaders like RequireJS
-// cjs – CommonJS, suitable for Node and Browserify/Webpack
-// esm – Keep the bundle as an ES module file
-// iife – A self-executing function, suitable for inclusion as a <script> tag. (If you want to create a bundle for your application, you probably want to use this, because it leads to smaller file sizes.)
-// umd – Universal Module Definition, works as amd, cjs and iife all in one
-// system – Native format of the SystemJS loader
-
-// ------------------------------------------------------------------------------------------
-// setup
-// ------------------------------------------------------------------------------------------
-const pkg = require('../package.json')
-const name = pkg.name
-const className = name.replace(/(^\w|-\w)/g, c => c.replace('-', '').toUpperCase())
-const external = Object.keys(pkg.dependencies || [])
-const plugins = [
-  typescript({ useTsconfigDeclarationDir: true, tsconfigOverride: { exclude: ['test/**/*'] } }),
-]
-
-// ------------------------------------------------------------------------------------------
-// Builds
-// ------------------------------------------------------------------------------------------
-function defaults (config) {
-  // defaults
-  const defaults = {
-    plugins,
-    external,
-  }
-  // defaults.output
-  config.output = config.output.map(output => {
-    return Object.assign(
-      {
-        sourcemap: false,
-        name: className,
-      },
-      output
-    )
-  })
-  return Object.assign(defaults, config)
-}
-
-export default [
-  defaults({
-    input: 'src/index.ts',
-    output: [
-      { file: 'dist/index.cjs.js', format: 'cjs' },
-      { file: 'dist/index.esm.js', format: 'esm' },
-    ],
-  }),
-]

package/src/index.ts

@@ -1,30 +0,0 @@
-/**
- * Adds comma's to a number
- *
- * @export
- * @param {(string | number)} num the number to commafy
- * @param {{ stripDecimals?: boolean, spacedDecimals?: boolean, thousandsComma?: boolean, K?: boolean }} [options] By default thousandsComma is enabled, if disabled it shows `1000` without comma (but `10,000` with)
- * @returns {string} eg. '1,000,000'
- */
-export function commafy (
-  num: number,
-  options?: { stripDecimals?: boolean, spacedDecimals?: boolean, thousandsComma?: boolean, K?: boolean }
-): string {
-  const { stripDecimals = false, spacedDecimals = false, thousandsComma = true, K = false } = options || {}
-  const [wholeNrStr, decimalStr = ''] = num.toString().split('.')
-  const str = [wholeNrStr, decimalStr]
-  const minLength = thousandsComma ? 4 : 5
-  if (!K && wholeNrStr.length >= minLength) {
-    str[0] = wholeNrStr.replace(/(\d)(?=(\d{3})+$)/g, '$1,')
-  }
-  if (K && wholeNrStr.length > 3) {
-    const numInK = Math.round(num / 1000)
-    const commafied = numInK.toString().replace(/(\d)(?=(\d{3})+$)/g, '$1,')
-    str[0] = commafied + 'K'
-  }
-  if (stripDecimals || !decimalStr || K) return str[0]
-  if (spacedDecimals && decimalStr.length >= minLength) {
-    str[1] = decimalStr.replace(/(\d{3})/g, '$1 ').trim()
-  }
-  return str.join('.')
-}

package/test/index.ts

@@ -1,121 +0,0 @@
-import test from 'ava'
-import { commafy } from '../src/index'
-
-test('defaults', t => {
-  t.is(commafy(1), '1')
-  t.is(commafy(10), '10')
-  t.is(commafy(100), '100')
-  t.is(commafy(1000), '1,000')
-  t.is(commafy(10000), '10,000')
-  t.is(commafy(100000), '100,000')
-  t.is(commafy(1000000), '1,000,000')
-  t.is(commafy(10000000), '10,000,000')
-  t.is(commafy(100000000), '100,000,000')
-  t.is(commafy(1000000000), '1,000,000,000')
-  t.is(commafy(10000000000), '10,000,000,000')
-  t.is(commafy(100000000000), '100,000,000,000')
-  t.is(commafy(1000000000000), '1,000,000,000,000')
-})
-
-test('K', t => {
-  t.is(commafy(1, {K: true}), '1')
-  t.is(commafy(14, {K: true}), '14')
-  t.is(commafy(134, {K: true}), '134')
-  t.is(commafy(1234, {K: true}), '1K')
-  t.is(commafy(10234, {K: true}), '10K')
-  t.is(commafy(100234, {K: true}), '100K')
-  t.is(commafy(1000234, {K: true}), '1,000K')
-  t.is(commafy(10000234, {K: true}), '10,000K')
-  t.is(commafy(100000234, {K: true}), '100,000K')
-  t.is(commafy(1000000234, {K: true}), '1,000,000K')
-  t.is(commafy(10000000234, {K: true}), '10,000,000K')
-  t.is(commafy(100000000234, {K: true}), '100,000,000K')
-  t.is(commafy(1000000000234, {K: true}), '1,000,000,000K')
-  t.is(commafy(1987, {K: true}), '2K')
-  t.is(commafy(10987, {K: true}), '11K')
-  t.is(commafy(100987, {K: true}), '101K')
-  t.is(commafy(1000987, {K: true}), '1,001K')
-  t.is(commafy(10000987, {K: true}), '10,001K')
-  t.is(commafy(100000987, {K: true}), '100,001K')
-  t.is(commafy(1000000987, {K: true}), '1,000,001K')
-  t.is(commafy(10000000987, {K: true}), '10,000,001K')
-  t.is(commafy(100000000987, {K: true}), '100,000,001K')
-  t.is(commafy(1000000000987, {K: true}), '1,000,000,001K')
-  t.is(commafy(1999, {K: true}), '2K')
-  t.is(commafy(19999, {K: true}), '20K')
-  t.is(commafy(199999, {K: true}), '200K')
-  t.is(commafy(1999999, {K: true}), '2,000K')
-  t.is(commafy(19999999, {K: true}), '20,000K')
-  t.is(commafy(199999999, {K: true}), '200,000K')
-  t.is(commafy(1999999999, {K: true}), '2,000,000K')
-  t.is(commafy(19999999999, {K: true}), '20,000,000K')
-  t.is(commafy(199999999999, {K: true}), '200,000,000K')
-  t.is(commafy(1999999999999, {K: true}), '2,000,000,000K')
-})
-
-test('thousands', t => {
-  // by default with
-  t.is(commafy(1000), '1,000')
-  t.is(commafy(9999), '9,999')
-  t.is(commafy(1000.0001), '1,000.0001')
-  
-  // set to without
-  t.is(commafy(1000, { thousandsComma: false }), '1000')
-  t.is(commafy(9999, { thousandsComma: false }), '9999')
-  t.is(commafy(1000.0001, { thousandsComma: false }), '1000.0001')
-
-  // multiple options
-  t.is(commafy(1000.0001, { thousandsComma: true, spacedDecimals: false }), '1,000.0001')
-  t.is(commafy(1000.0001, { thousandsComma: true, spacedDecimals: true }), '1,000.000 1')
-  t.is(commafy(1000.0001, { thousandsComma: false, spacedDecimals: true }), '1000.0001')
-})
-
-test('defaults - decimals', t => {
-  t.is(commafy(1), '1')
-  t.is(commafy(1.1), '1.1')
-  t.is(commafy(1.01), '1.01')
-  t.is(commafy(1.001), '1.001')
-  t.is(commafy(1.0001), '1.0001')
-  t.is(commafy(1.00001), '1.00001')
-  t.is(commafy(1.000001), '1.000001')
-  t.is(commafy(1.0000001), '1.0000001')
-  t.is(commafy(1.00000001), '1.00000001')
-  t.is(commafy(1.000000001), '1.000000001')
-  t.is(commafy(1.0000000001), '1.0000000001')
-  t.is(commafy(1.00000000001), '1.00000000001')
-  t.is(commafy(1.000000000001), '1.000000000001')
-})
-
-test('spaced decimals', t => {
-  const options = { spacedDecimals: true }
-  t.is(commafy(1, options), '1')
-  t.is(commafy(1.1, options), '1.1')
-  t.is(commafy(1.01, options), '1.01')
-  t.is(commafy(1.001, options), '1.001')
-  t.is(commafy(1.0001, options), '1.000 1')
-  t.is(commafy(1.00001, options), '1.000 01')
-  t.is(commafy(1.000001, options), '1.000 001')
-  t.is(commafy(1.0000001, options), '1.000 000 1')
-  t.is(commafy(1.00000001, options), '1.000 000 01')
-  t.is(commafy(1.000000001, options), '1.000 000 001')
-  t.is(commafy(1.0000000001, options), '1.000 000 000 1')
-  t.is(commafy(1.00000000001, options), '1.000 000 000 01')
-  t.is(commafy(1.000000000001, options), '1.000 000 000 001')
-})
-
-test('strip decimals', t => {
-  const options = { stripDecimals: true }
-  t.is(commafy(1, options), '1')
-  t.is(commafy(1.1, options), '1')
-  t.is(commafy(1.01, options), '1')
-  t.is(commafy(1.001, options), '1')
-  t.is(commafy(1.0001, options), '1')
-  t.is(commafy(1.00001, options), '1')
-  t.is(commafy(1.000001, options), '1')
-  t.is(commafy(1.0000001, options), '1')
-  t.is(commafy(1.00000001, options), '1')
-  t.is(commafy(1.000000001, options), '1')
-  t.is(commafy(1.0000000001, options), '1')
-  t.is(commafy(1.00000000001, options), '1')
-  t.is(commafy(1.000000000001, options), '1')
-})

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./dist",
-    "declaration": true,
-    "declarationDir": "./types/",
-    "target": "es5",
-    "lib": ["es5", "es2015", "es2016", "es2017", "dom"]
-  },
-  "include": [
-    "src/**/*",
-    "test/**/*"
-  ]
-}