chore: tweaks

Author: Mister-Hope

.oxfmtrc.json .oxfmtrc.jsonc.oxfmtrc.json renamed to .oxfmtrc.jsonc

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/oxfmt/configuration_schema.json",
   "ignorePatterns": ["coverage/", "dist/"],
   "experimentalSortPackageJson": {
-    "sortScripts": true
-  }
+    "sortScripts": true,
+  },
 }

.oxlintrc.base.json .oxlintrc.base.jsonc.oxlintrc.base.json renamed to .oxlintrc.base.jsonc

@@ -6,7 +6,7 @@
     "pedantic": "warn",
     "perf": "warn",
     "style": "warn",
-    "restriction": "warn"
+    "restriction": "warn",
   },
   "rules": {
     // oxlint core rules
@@ -48,6 +48,9 @@
     "no-void": "off",
     // normally we do not enforce numeric separator usage
     "numeric-separators-style": "off",
+    // some functions that return promise and plain values in different conditions
+    // need an async declaration while not always using await
+    "require-await": "off",
     // we prefer to sort imports with its pkg name
     "sort-imports": "off",
     // object keys are not supposed to be sorted in many cases
@@ -111,38 +114,41 @@
         {
           "selector": "variable",
           "filter": { "regex": "^__(?:dirname|filename)$", "match": true },
-          "format": null
+          "format": null,
         },
         {
           "selector": "variable",
-          "filter": { "regex": "^(?:_{0,2})[A-Z][A-z0-9]*(?:_[A-Z][A-z0-9]*)*$", "match": true },
-          "format": null
+          "filter": {
+            "regex": "^(?:_{0,2})[A-Z][A-z0-9]*(?:_[A-Z][A-z0-9]*)*$",
+            "match": true,
+          },
+          "format": null,
         },
         {
           "selector": ["variable"],
           "format": ["camelCase", "PascalCase", "UPPER_CASE"],
-          "leadingUnderscore": "allow"
+          "leadingUnderscore": "allow",
         },
         {
           "selector": ["parameter"],
           "format": ["camelCase", "PascalCase"],
-          "leadingUnderscore": "allow"
+          "leadingUnderscore": "allow",
         },
         {
           "selector": ["property"],
           "format": ["camelCase", "PascalCase", "UPPER_CASE"],
           "leadingUnderscore": "allow",
-          "trailingUnderscore": "allow"
+          "trailingUnderscore": "allow",
         },
         { "selector": "import", "format": ["PascalCase", "camelCase"] },
         { "selector": "typeLike", "format": ["PascalCase"] },
-        { "selector": "enumMember", "format": ["PascalCase"] }
-      ]
+        { "selector": "enumMember", "format": ["PascalCase"] },
+      ],
     ],
     // allow non-null assertions in some cases
     "typescript/strict-boolean-expressions": [
       "warn",
-      { "allowNullableString": true, "allowNullableBoolean": true }
+      { "allowNullableString": true, "allowNullableBoolean": true },
     ],
     // missing async with await will be reported by typescript itself
     "typescript/promise-function-async": "off",
@@ -151,6 +157,8 @@
     // filename should not be enforced strictly, e.g. Vue SFC files shall be PascalCased
     // we shall expect a project level setting
     "unicorn/filename-case": "off",
+    // this rule introduce too many false positives
+    "unicorn/explicit-length-check": "off",
     // toReversed can introduce memory overhead,
     // in some chained calls it is better to use reverse as the "reversed" array is also a temp variable.
     "unicorn/no-array-reverse": "off",
@@ -159,6 +167,8 @@
     "unicorn/no-array-sort": "off",
     // Array.forEach has its use cases
     "unicorn/no-array-for-each": "off",
+    // for code simplicity we may not want to create temp variables for single use
+    "unicorn/no-await-expression-member": "off",
     // conflicts with oxfmt code style
     "unicorn/no-nested-ternary": "off",
     // conflicts with oxfmt code style
@@ -168,6 +178,8 @@
     // support starts with chrome71, firefox68. safari12.1, node12
     // leaving it to warn for edge cases
     "unicorn/prefer-global-this": "warn",
+    // prefer utf-8 over utf8
+    "unicorn/text-encoding-identifier-case": ["error", { "withDash": true }],
 
     // stylistic rules with default being tweaked
     "catch-error-name": ["warn", { "name": "err" }],
@@ -188,27 +200,27 @@
           // type generics
           "T",
           // parameter name for unused variables
-          "_"
-        ]
-      }
+          "_",
+        ],
+      },
     ],
     "max-dependencies": ["warn", { "ignoreTypeImports": true, "max": 15 }],
     "max-lines": ["warn", { "max": 500, "skipBlankLines": true, "skipComments": true }],
     "max-lines-per-function": [
       "warn",
-      { "max": 100, "skipBlankLines": true, "skipComments": true }
+      { "max": 100, "skipBlankLines": true, "skipComments": true },
     ],
     "max-params": ["warn", 4],
-    "max-statements": ["warn", { "max": 30 }]
+    "max-statements": ["warn", { "max": 30 }],
   },
   "overrides": [
     {
       "files": ["scripts/**/*.{js,ts}", "*.config.{js,ts}"],
       "plugins": ["node"],
       "rules": {
         // config files shall be allowed to access process.env
-        "node/no-process-env": "off"
-      }
+        "node/no-process-env": "off",
+      },
     },
     {
       "files": ["*.{jsx,tsx}"],
@@ -218,20 +230,20 @@
         // disable jsdoc rules in react components
         "jsdoc/require-returns": "off",
         // allow loose boolean expressions in react components
-        "typescript/strict-boolean-expressions": "off"
-      }
+        "typescript/strict-boolean-expressions": "off",
+      },
     },
     {
       "files": ["*.d.ts"],
       "rules": {
         // to extend existing modules, import/export must not appear in declaration files at top level
         "import/unambiguous": "off",
         // we need `export {}` to convert a file to a module
-        "unicorn/require-module-specifiers": "off"
-      }
+        "unicorn/require-module-specifiers": "off",
+      },
     },
     {
-      "files": ["*.bench.{js,ts}", "*.test.{js,ts}"],
+      "files": ["*.{bench,spec,test}.{js,ts}", "*.{spec,test}.{js,ts}", "*.{spec,test}-d.ts"],
       "plugins": ["vitest"],
       "rules": {
         "id-length": "off",
@@ -246,8 +258,12 @@
         "typescript/prefer-ts-expect-error": "off",
         "typescript/require-array-sort-compare": "off",
         "vitest/prefer-called-once": "off",
-        "unicorn/consistent-function-scoping": "off"
-      }
-    }
-  ]
+        "vitest/consistent-test-filename": [
+          "warn",
+          { "allTestPattern": "__tests__", "pattern": ".*\\.spec\\.ts$" },
+        ],
+        "unicorn/consistent-function-scoping": "off",
+      },
+    },
+  ],
 }

.oxlintrc.json .oxlintrc.jsonc.oxlintrc.json renamed to .oxlintrc.jsonc

@@ -1,10 +1,10 @@
 {
   "$schema": "./node_modules/oxlint/configuration_schema.json",
-  "extends": ["./.oxlintrc.base.json"],
+  "extends": ["./.oxlintrc.base.jsonc"],
   "ignorePatterns": ["coverage/", "dist/"],
   "plugins": ["typescript", "oxc", "jsdoc", "import", "promise", "unicorn", "node"],
   "rules": {
     "id-length": "off",
-    "no-bitwise": "off"
-  }
+    "no-bitwise": "off",
+  },
 }

README.md

@@ -4,7 +4,6 @@
 [![npm downloads](https://img.shields.io/npm/dw/bcrypt-ts)](https://www.npmjs.com/package/bcrypt-ts)
 [![types](https://img.shields.io/npm/types/bcrypt-ts)](https://mister-hope.github.io/bcrypt-ts/)
 
-[![Test](https://github.com/Mister-Hope/bcrypt-ts/actions/workflows/test.yml/badge.svg)](https://github.com/Mister-Hope/bcrypt-ts/actions/workflows/test.yml)
 [![DeepScan grade](https://deepscan.io/api/teams/15982/projects/28024/branches/898932/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=15982&pid=28024&bid=898932) [![codecov](https://codecov.io/gh/Mister-Hope/bcrypt-ts/graph/badge.svg?token=oO5gZq2aHe)](https://codecov.io/gh/Mister-Hope/bcrypt-ts)
 
 Optimized bcrypt in TypeScript with zero dependencies. Compatible to the C++ [bcrypt](https://npmjs.org/package/bcrypt) binding on Node.js and also working in the browser.

__tests__/base64.test.ts

@@ -41,6 +41,18 @@ describe(decodeBase64, () => {
     expect(result.length).toBeLessThanOrEqual(5);
   });
 
+  it("should handle characters with code >= BASE64_INDEX.length", () => {
+    // \u0080 has code 128, which is >= BASE64_INDEX.length (128)
+    const result1 = decodeBase64("\u0080\u0080\u0080\u0080", 5);
+    expect(result1.length).toBe(0);
+
+    const result2 = decodeBase64("..\u0080\u0080", 5);
+    expect(result2.length).toBe(1);
+
+    const result3 = decodeBase64("...\u0080", 5);
+    expect(result3.length).toBe(3);
+  });
+
   it("should handle early break on invalid c1 or c2", () => {
     // Test with string containing invalid characters at start
     const result = decodeBase64("@invalid", 5);

__tests__/hash.test.ts

@@ -15,6 +15,12 @@ describe(hash, () => {
     expect(hash4).toBeTypeOf("string");
     expect(hash1).not.toEqual(hash2);
     expect(hash3).not.toEqual(hash4);
+
+    const hash5 = await hash("hello", 4);
+    expect(hash5).toContain("$04$");
+
+    const hash6 = await hash("hello", "$2$10$abcdefghijklmnopqrstuv");
+    expect(hash6).toContain("$2$10$");
   });
 
   it("should reject for invalid argument types", async () => {
@@ -64,13 +70,21 @@ describe(hashSync, () => {
     const hash2 = hashSync("hello", 10);
     const hash3 = hashSync("中国我爱你！", 10);
     const hash4 = hashSync("中国我爱你！", 10);
+    const hash7 = hashSync("hello");
 
     expect(hash1).toBeTypeOf("string");
     expect(hash2).toBeTypeOf("string");
     expect(hash3).toBeTypeOf("string");
     expect(hash4).toBeTypeOf("string");
+    expect(hash7).toBeTypeOf("string");
     expect(hash1).not.toEqual(hash2);
     expect(hash3).not.toEqual(hash4);
+
+    const hash5 = hashSync("hello", 4);
+    expect(hash5).toContain("$04$");
+
+    const hash6 = hashSync("hello", "$2$10$abcdefghijklmnopqrstuv");
+    expect(hash6).toContain("$2$10$");
   });
 
   it("should throw error for invalid argument types", () => {

package.json

@@ -54,14 +54,14 @@
   },
   "devDependencies": {
     "@codecov/rollup-plugin": "1.9.1",
-    "@commitlint/cli": "20.4.0",
-    "@commitlint/config-conventional": "20.4.0",
+    "@commitlint/cli": "20.4.1",
+    "@commitlint/config-conventional": "20.4.1",
     "@types/node": "25.2.0",
     "@vitest/coverage-istanbul": "4.0.18",
     "husky": "9.1.7",
     "nano-staged": "0.9.0",
-    "oxfmt": "0.27.0",
-    "oxlint": "1.42.0",
+    "oxfmt": "0.28.0",
+    "oxlint": "1.43.0",
     "oxlint-tsgolint": "0.11.4",
     "rimraf": "6.1.2",
     "tsdown": "0.20.1",