Merge pull request #1 from webdeveric/dev

Added `luhn()`

Author: webdeveric

.eslintrc.json

@@ -31,7 +31,7 @@
     "import/no-extraneous-dependencies": [
       "error",
       {
-        "devDependencies": ["./vitest.config.mts", "./lint-staged.config.mjs", "./test/**/*"]
+        "devDependencies": ["./vitest.config.mts", "./lint-staged.config.mjs", "./test/**/*", "./bench/**/*"]
       }
     ],
     "import/no-relative-packages": "error",

.github/workflows/release.yml.example renamed to .github/workflows/release.yml

@@ -0,0 +1,28 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import { bench } from 'vitest';
+
+bench(
+  'boolean',
+  () => {
+    let flag = true;
+
+    flag = !flag;
+    flag = !flag;
+  },
+  {
+    time: 1000,
+  },
+);
+
+bench(
+  'Bitwise XOR assignment',
+  () => {
+    let flag = 1;
+
+    flag ^= 1;
+    flag ^= 1;
+  },
+  {
+    time: 1000,
+  },
+);

bench/booleanFlagFlip.bench.ts

@@ -0,0 +1,37 @@
+import fastLuhn from 'fast-luhn';
+import { validate as luhnValidate } from 'luhn';
+import { bench } from 'vitest';
+
+import { luhn } from '../src/luhn.js';
+
+const iterations = 1000;
+
+bench(
+  'luhn()',
+  () => {
+    luhn('bad input');
+  },
+  {
+    iterations,
+  },
+);
+
+bench(
+  'npm:fast-luhn',
+  () => {
+    fastLuhn('bad input');
+  },
+  {
+    iterations,
+  },
+);
+
+bench(
+  'npm:luhn',
+  () => {
+    luhnValidate('bad input');
+  },
+  {
+    iterations,
+  },
+);

bench/luhn-bad-input.bench.ts

@@ -0,0 +1,37 @@
+import fastLuhn from 'fast-luhn';
+import { validate as luhnValidate } from 'luhn';
+import { bench } from 'vitest';
+
+import { luhn } from '../src/luhn.js';
+
+const iterations = 1000;
+
+bench(
+  'luhn()',
+  () => {
+    luhn('4000000000001000');
+  },
+  {
+    iterations,
+  },
+);
+
+bench(
+  'npm:fast-luhn',
+  () => {
+    fastLuhn('4000000000001000');
+  },
+  {
+    iterations,
+  },
+);
+
+bench(
+  'npm:luhn',
+  () => {
+    luhnValidate('4000000000001000');
+  },
+  {
+    iterations,
+  },
+);

bench/luhn.bench.ts

@@ -0,0 +1,34 @@
+/* eslint-disable @typescript-eslint/no-unused-expressions */
+import { bench } from 'vitest';
+
+bench(
+  'Number.parseInt(x, 10)',
+  () => {
+    const input = '123';
+
+    Number.parseInt(input[2]!, 10);
+  },
+  {
+    iterations: 10_000,
+  },
+);
+
+bench(
+  'charCodeAt(x) - 48',
+  () => {
+    '123'.charCodeAt(2) - 48;
+  },
+  {
+    iterations: 10_000,
+  },
+);
+
+bench(
+  'Number(x)',
+  () => {
+    Number('123'[2]);
+  },
+  {
+    iterations: 10_000,
+  },
+);

bench/numberParsing.bench.ts

@@ -5,6 +5,7 @@
     "CODEOWNERS",
     "commitlint",
     "conventionalcommits",
+    "luhn",
     "nvmrc",
     "postbuild",
     "tsbuildinfo",

cspell.json

@@ -1,22 +1,20 @@
 {
-  "name": "@webdeveric/dual-ts-package-template",
-  "description": "",
+  "name": "validation-algorithms",
+  "description": "Validation algorithms",
   "version": "0.0.0",
-  "keywords": [],
+  "keywords": [
+    "luhn"
+  ],
   "author": "Eric King <[email protected]> (https://webdeveric.com/)",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/webdeveric/dual-ts-package-template.git"
+    "url": "git+ssh://git@github.com/webdeveric/validation-algorithms.git"
   },
   "bugs": {
-    "url": "https://github.com/webdeveric/dual-ts-package-template/issues"
+    "url": "https://github.com/webdeveric/validation-algorithms/issues"
   },
   "license": "MIT",
-  "packageManager": "[email protected].3+sha512.c0f53ee99477ed969b82b289ad011a5d16bf1623c957e7f29eabe8d0c00b574c29b8c7f54f6c67ee710c73f285c8154d07ce44b46fe2c0eeb476a90441bac371",
+  "packageManager": "[email protected].4+sha512.c8180b3fbe4e4bca02c94234717896b5529740a6cbadf19fa78254270403ea2f27d4e1d46a08a0f56c89b63dc8ebfd3ee53326da720273794e6200fcf0d184ab",
   "sideEffects": false,
   "engines": {
     "node": ">=20.0.0"
@@ -47,13 +45,15 @@
     "validate": "validate-package-exports --check --verify --info",
     "postbuild": "echo '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json && echo '{\"type\":\"module\"}' > ./dist/mjs/package.json && pnpm validate",
     "typecheck": "tsc --build --verbose",
-    "lint": "eslint ./*.{js,cjs,mjs,ts,cts,mts} ./src/ ./test/ --ext .ts,.mjs,.cjs",
+    "lint": "eslint ./*.{js,cjs,mjs,ts,cts,mts} ./src/ ./bench/ ./test/ --ext .ts,.mjs,.cjs",
+    "bench": "vitest bench",
     "test": "vitest",
-    "coverage": "vitest --coverage",
+    "coverage": "vitest run --coverage",
     "spellcheck": "cspell './{.github,src,test}/**/*.{ts,json}' './*.{js,json,md,mjs,mts}' './package.json' --no-progress",
     "prepublishOnly": "pnpm typecheck && pnpm spellcheck && pnpm lint && pnpm coverage && pnpm build",
-    "format": "prettier --write ./*.{js,json,md,mjs,mts} ./src/ ./test/",
-    "prepare": "husky"
+    "format": "prettier --write ./*.{js,json,md,mjs,mts} ./src/ ./bench/ ./test/",
+    "prepare": "husky",
+    "dry-release": "semantic-release --dry-run"
   },
   "prettier": "@webdeveric/prettier-config",
   "devDependencies": {
@@ -71,8 +71,10 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
+    "fast-luhn": "^2.0.2",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.10",
+    "luhn": "^2.4.1",
     "prettier": "^3.4.1",
     "rimraf": "^6.0.1",
     "semantic-release": "^24.2.0",

package.json

@@ -1,13 +1,23 @@
-# `dual-ts-package-template`
+# `validation-algorithms`
 
-[![Node.js CI](https://github.com/webdeveric/dual-ts-package-template/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/dual-ts-package-template/actions/workflows/node.js.yml)
+[![Node.js CI](https://github.com/webdeveric/validation-algorithms/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/validation-algorithms/actions/workflows/node.js.yml) [![Release](https://github.com/webdeveric/validation-algorithms/actions/workflows/release.yml/badge.svg)](https://github.com/webdeveric/validation-algorithms/actions/workflows/release.yml)
+
+## Install
+
+`pnpm add validation-algorithms`
+
+`npm i validation-algorithms --saves`
 
 ## Usage
 
-Click the "Use this template" button on this page and select "Create a new repository."
+```ts
+import { luhn } from 'validation-algorithms/luhn';
 
-### GitHub CLI
+if (luhn('4000000000001000')) {
+  // passed validation
+}
+```
 
-Reference: https://cli.github.com/manual/gh_repo_create
+## Benchmarks
 
-`gh repo create [YOUR-REPO-NAME] --template webdeveric/dual-ts-package-template --private`
+Run `pnpm bench` to run the benchmarks.

pnpm-lock.yaml

@@ -1,3 +1 @@
-export function demo(): boolean {
-  return true;
-}
+export * from './luhn.js';

readme.md

@@ -0,0 +1,30 @@
+export function luhn(input: number | bigint | string): boolean {
+  const value = typeof input === 'string' ? input : String(input);
+
+  // input contained non digit characters.
+  if (/[^\d]/.test(value)) {
+    return false;
+  }
+
+  /**
+   * This is the precomputed result of running this snippet.
+   *
+   * ```ts
+   * '0123456789'.split('').map((digit) => {
+   *   const num = Number.parseInt(digit, 10) * 2;
+   *   return num > 9 ? num - 9 : num;
+   * });
+   * ```
+   */
+  const precomputed = [0, 2, 4, 6, 8, 1, 3, 5, 7, 9] as const;
+
+  let sum = 0;
+
+  for (let index = value.length, isSecond = false; index; isSecond = !isSecond) {
+    const num = value.charCodeAt(--index) - 48;
+
+    sum += isSecond ? precomputed[num]! : num;
+  }
+
+  return sum % 10 === 0;
+}

src/index.ts

@@ -0,0 +1,27 @@
+import { describe, it, expect } from 'vitest';
+
+import { luhn } from '../src/luhn.js';
+
+describe('luhn()', () => {
+  it('accepts string', () => {
+    expect(luhn('4000000000001000')).toBeTruthy();
+    expect(luhn('4000000000001001')).toBeFalsy();
+  });
+
+  it('accepts bigint', () => {
+    expect(luhn(4000000000001000n)).toBeTruthy();
+    expect(luhn(4000000000001001n)).toBeFalsy();
+  });
+
+  it('accepts number', () => {
+    expect(luhn(4000000000001000)).toBeTruthy();
+    expect(luhn(4000000000001001)).toBeFalsy();
+  });
+
+  it.each(['not a credit card number', '-1', Number.POSITIVE_INFINITY, Number.NEGATIVE_INFINITY])(
+    'returns false when giving bad input: %s',
+    (input) => {
+      expect(luhn(input)).toBeFalsy();
+    },
+  );
+});