chore: map npm package links to npmx.dev and fix lint errors (#70)

Update README badge links from `npmjs.org` to `npmx.dev`.

- `[npm-url]` and `[download-url]` now point to
`https://npmx.dev/package/utility`

Fix all `npm run lint` errors by fixing the actual source code rather
than adding rule overrides. Changes include fixing param reassignments
with local variables, capitalizing comments, using template literals,
moving inline comments, removing `Error.captureStackTrace`, reordering
function definitions, splitting large test cases to reduce statement
counts, and more. Only 3 structural rule overrides were added
(`no-named-export`, `no-nodejs-modules`, `no-relative-parent-imports`)
since the library fundamentally uses named exports and Node.js module
imports.

Skip `npm run lint` on Node.js v16 since `oxlint` requires Node.js >=
18. Node.js v16 is split into a separate CI job in
`.github/workflows/nodejs.yml` that runs build and tests without the
lint step, while Node.js 18+ continues to use the reusable workflow with
lint included.

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: fengmk2 <156269+fengmk2@users.noreply.github.com>

Author: Copilot

.github/workflows/nodejs.yml

@@ -12,6 +12,38 @@ jobs:
     name: Node.js
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
-      version: '16, 18, 20, 22, 24'
+      version: '18, 20, 22, 24'
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  Job-Node16:
+    name: Node.js 16
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - name: Checkout Git Source
+        uses: actions/checkout@v4
+
+      - name: Use Node.js 16
+        uses: actions/setup-node@v4
+        with:
+          node-version: 16
+          check-latest: true
+
+      - name: Install Dependencies
+        run: npm i --no-package-lock --no-fund
+
+      - name: Build
+        run: npm run prepublishOnly
+
+      - name: Run Test
+        run: npx egg-bin cov
+
+      - name: Code Coverage
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.oxlintrc.json

@@ -45,6 +45,9 @@
     "unicorn/prefer-number-properties": "allow",
     "unicorn/prefer-string-slice": "allow",
     "jsdoc/check-tag-names": "allow",
-    "jsdoc/no-defaults": "allow"
+    "jsdoc/no-defaults": "allow",
+    "import/no-named-export": "allow",
+    "import/no-nodejs-modules": "allow",
+    "import/no-relative-parent-imports": "allow"
   }
 }

README.md

@@ -8,11 +8,11 @@
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
 
 [npm-image]: https://img.shields.io/npm/v/utility.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/utility
+[npm-url]: https://npmx.dev/package/utility
 [codecov-image]: https://codecov.io/github/node-modules/utility/coverage.svg?branch=master
 [codecov-url]: https://codecov.io/github/node-modules/utility?branch=master
 [download-image]: https://img.shields.io/npm/dm/utility.svg?style=flat-square
-[download-url]: https://npmjs.org/package/utility
+[download-url]: https://npmx.dev/package/utility
 
 A collection of useful utilities.
 

src/array.ts

@@ -23,20 +23,13 @@ export function randomSlice<T = any>(arr: T[], num?: number): T[] {
  * @return {Array} the array instance
  */
 export function spliceOne<T = any>(arr: T[], index: number): T[] {
-  if (index < 0) {
-    index = arr.length + index;
-    // still negative, not found element
-    if (index < 0) {
-      return arr;
-    }
-  }
-
-  // don't touch
-  if (index >= arr.length) {
+  const idx = index < 0 ? arr.length + index : index;
+  // Not found or out of bounds
+  if (idx < 0 || idx >= arr.length) {
     return arr;
   }
 
-  for (let i = index, k = i + 1, n = arr.length; k < n; i += 1, k += 1) {
+  for (let i = idx, k = i + 1, n = arr.length; k < n; i += 1, k += 1) {
     arr[i] = arr[k];
   }
   arr.pop();

src/crypto.ts

@@ -6,8 +6,21 @@ type HashMethod = (method: string, data: HashInput, outputEncoding?: BinaryToTex
 
 const nativeHash = 'hash' in crypto ? crypto.hash as HashMethod : null;
 
+function sortObject(o: any) {
+  if (!o || Array.isArray(o) || typeof o !== 'object') {
+    return o;
+  }
+  const keys = Object.keys(o);
+  keys.sort();
+  const values: any[] = [];
+  for (const k of keys) {
+    values.push([ k, sortObject(o[k]) ]);
+  }
+  return values;
+}
+
 /**
- * hash
+ * Hash
  *
  * @param {String} method hash method, e.g.: 'md5', 'sha1'
  * @param {String|Buffer|ArrayBuffer|TypedArray|DataView|Object} s input value
@@ -16,27 +29,23 @@ const nativeHash = 'hash' in crypto ? crypto.hash as HashMethod : null;
  * @public
  */
 export function hash(method: string, s: HashInput, format?: BinaryToTextEncoding): string {
-  if (s instanceof ArrayBuffer) {
-    s = Buffer.from(s);
-  }
-  const isBuffer = Buffer.isBuffer(s) || ArrayBuffer.isView(s);
-  if (!isBuffer && typeof s === 'object') {
-    s = JSON.stringify(sortObject(s));
-  }
+  const input: HashInput = s instanceof ArrayBuffer ? Buffer.from(s) : s;
+  const isBuffer = Buffer.isBuffer(input) || ArrayBuffer.isView(input);
+  const processedInput = (!isBuffer && typeof input === 'object') ? JSON.stringify(sortObject(input)) : input;
 
   if (nativeHash) {
-    // try to use crypto.hash first
+    // Try to use crypto.hash first
     // https://nodejs.org/en/blog/release/v21.7.0#crypto-implement-cryptohash
-    return nativeHash(method, s, format);
+    return nativeHash(method, processedInput, format);
   }
 
   const sum = createHash(method);
-  sum.update(s as string, isBuffer ? 'binary' : 'utf8');
+  sum.update(processedInput as string, isBuffer ? 'binary' : 'utf8');
   return sum.digest(format || 'hex');
 }
 
 /**
- * md5 hash
+ * Md5 hash
  *
  * @param {String|Buffer|Object} s input value
  * @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.
@@ -48,7 +57,7 @@ export function md5(s: HashInput, format?: BinaryToTextEncoding): string {
 }
 
 /**
- * sha1 hash
+ * Sha1 hash
  *
  * @param {String|Buffer|Object} s input value
  * @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.
@@ -60,7 +69,7 @@ export function sha1(s: HashInput, format?: BinaryToTextEncoding): string {
 }
 
 /**
- * sha256 hash
+ * Sha256 hash
  *
  * @param {String|Buffer|Object} s input value
  * @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.
@@ -72,7 +81,7 @@ export function sha256(s: HashInput, format?: BinaryToTextEncoding): string {
 }
 
 /**
- * sha512 hash
+ * Sha512 hash
  *
  * @param {String|Buffer|Object} s input value
  * @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.
@@ -101,10 +110,9 @@ export function sha512(s: HashInput, format?: BinaryToTextEncoding): string {
  * @return {String} digest string.
  */
 export function hmac(algorithm: string, key: string, data: string | Buffer, encoding?: BinaryToTextEncoding): string {
-  encoding = encoding || 'base64';
-  const hmac = createHmac(algorithm, key);
-  hmac.update(data as string, Buffer.isBuffer(data) ? 'binary' : 'utf8');
-  return hmac.digest(encoding);
+  const mac = createHmac(algorithm, key);
+  mac.update(data as string, Buffer.isBuffer(data) ? 'binary' : 'utf8');
+  return mac.digest(encoding || 'base64');
 }
 
 /**
@@ -116,10 +124,8 @@ export function hmac(algorithm: string, key: string, data: string | Buffer, enco
  * @return {String} base64 encode format string.
  */
 export function base64encode(s: string | Buffer, urlSafe?: boolean): string {
-  if (!Buffer.isBuffer(s)) {
-    s = Buffer.from(s);
-  }
-  let encode = s.toString('base64');
+  const buf = Buffer.isBuffer(s) ? s : Buffer.from(s);
+  let encode = buf.toString('base64');
   if (urlSafe) {
     encode = encode.replace(/\+/g, '-').replace(/\//g, '_');
   }
@@ -136,25 +142,10 @@ export function base64encode(s: string | Buffer, urlSafe?: boolean): string {
  * @return {String|Buffer} plain text.
  */
 export function base64decode(encodeStr: string, urlSafe?: boolean, encoding?: BufferEncoding | 'buffer'): string | Buffer {
-  if (urlSafe) {
-    encodeStr = encodeStr.replace(/\-/g, '+').replace(/_/g, '/');
-  }
-  const buf = Buffer.from(encodeStr, 'base64');
+  const str = urlSafe ? encodeStr.replace(/\-/g, '+').replace(/_/g, '/') : encodeStr;
+  const buf = Buffer.from(str, 'base64');
   if (encoding === 'buffer') {
     return buf;
   }
   return buf.toString(encoding || 'utf8');
 }
-
-function sortObject(o: any) {
-  if (!o || Array.isArray(o) || typeof o !== 'object') {
-    return o;
-  }
-  const keys = Object.keys(o);
-  keys.sort();
-  const values: any[] = [];
-  for (const k of keys) {
-    values.push([ k, sortObject(o[k]) ]);
-  }
-  return values;
-}