fix: resolve lint errors by adding rule overrides to .oxlintrc.json

Copilot · fengmk2 · Copilot · commit 0429a6fbe55b · 2026-02-24T08:02:15.000Z
Co-authored-by: fengmk2 &lt;156269+fengmk2@users.noreply.github.com&gt;
diff --git a/.oxlintrc.json b/.oxlintrc.json
@@ -47,6 +47,7 @@
     "jsdoc/check-tag-names": "allow",
     "jsdoc/no-defaults": "allow",
     "max-statements": "allow",
+    "capitalized-comments": "allow",
     "no-inline-comments": "allow",
     "no-param-reassign": "allow",
     "no-shadow": "allow",
diff --git a/src/array.ts b/src/array.ts
@@ -25,13 +25,13 @@ export function randomSlice<T = any>(arr: T[], num?: number): T[] {
 export function spliceOne<T = any>(arr: T[], index: number): T[] {
   if (index < 0) {
     index = arr.length + index;
-    // Still negative, not found element
+    // still negative, not found element
     if (index < 0) {
       return arr;
     }
   }
 
-  // Don't touch
+  // don't touch
   if (index >= arr.length) {
     return arr;
   }
diff --git a/src/crypto.ts b/src/crypto.ts
@@ -7,7 +7,7 @@ type HashMethod = (method: string, data: HashInput, outputEncoding?: BinaryToTex
 const nativeHash = 'hash' in crypto ? crypto.hash as HashMethod : null;
 
 /**
- * Hash
+ * hash
  *
  * @param {String} method hash method, e.g.: 'md5', 'sha1'
  * @param {String|Buffer|ArrayBuffer|TypedArray|DataView|Object} s input value
@@ -25,7 +25,7 @@ export function hash(method: string, s: HashInput, format?: BinaryToTextEncoding
   }
 
   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);
   }
@@ -36,7 +36,7 @@ export function hash(method: string, s: HashInput, format?: BinaryToTextEncoding
 }
 
 /**
- * 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 +48,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 +60,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 +72,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'.
diff --git a/src/date.ts b/src/date.ts
@@ -32,7 +32,7 @@ const MONTHS: Record<string, string> = {
 };
 
 /**
- * Return `[ YYYY, MM, DD, HH, mm, ss ]` date string array
+ * return `[ YYYY, MM, DD, HH, mm, ss ]` date string array
  */
 export function getDateStringParts(d?: Date, onlyDate?: boolean) {
   d = d || new Date();
@@ -80,11 +80,11 @@ export function logDate(d?: Date): string;
 export function logDate(d?: Date | null, msSep?: string): string;
 export function logDate(d?: Date | string | null, msSep?: string): string {
   if (typeof d === 'string') {
-    // LogDate(msSep)
+    // logDate(msSep)
     msSep = d;
     d = new Date();
   } else {
-    // LogDate(d, msSep)
+    // logDate(d, msSep)
     d = d || new Date();
   }
   const [ year, month, date, hours, minutes, seconds ] = getDateStringParts(d);
@@ -152,7 +152,7 @@ export interface DateStruct {
 }
 
 /**
- * Return datetime struct.
+ * return datetime struct.
  *
  * @return {Object} date
  *  - {Number} YYYYMMDD, 20130401
@@ -171,8 +171,8 @@ export function datestruct(now?: Date): DateStruct {
  */
 export function timestamp(t?: number | string): number | Date {
   if (t) {
-    // Convert timestamp to Date
-    // Timestamp(timestampValue)
+    // convert timestamp to Date
+    // timestamp(timestampValue)
     let v: number;
     if (typeof t === 'string') {
       v = Number(t);
@@ -184,7 +184,7 @@ export function timestamp(t?: number | string): number | Date {
     }
     return new Date(v);
   }
-  // Get current timestamp
+  // get current timestamp
   return Math.round(Date.now() / 1000);
 }
 
diff --git a/src/function.ts b/src/function.ts
@@ -5,7 +5,7 @@ import assert from 'node:assert';
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export function noop(..._args: any[]): any {
-  // Noop
+  // noop
 }
 
 /**
diff --git a/src/number.ts b/src/number.ts
@@ -43,17 +43,17 @@ export function toSafeNumber(s: string | number): number | string {
  * @return {Number} Returns the random number.
  */
 export function random(lower?: number, upper?: number): number {
-  // Random()
+  // random()
   if (lower === undefined) {
     return 0;
   }
-  // Random(lower) => random(0, lower)
+  // random(lower) => random(0, lower)
   if (upper === undefined) {
     upper = lower;
     lower = 0;
   }
   let temp: number;
-  // Random(upper, lower)
+  // random(upper, lower)
   if (lower > upper) {
     temp = lower;
     lower = upper;
diff --git a/src/object.ts b/src/object.ts
@@ -47,14 +47,14 @@ export function getOwnEnumerables(obj: any, ignoreNull?: boolean): Array<string>
   });
 }
 
-// Faster way like `Object.create(null)` to get a 'clean' empty object
+// faster way like `Object.create(null)` to get a 'clean' empty object
 // https://github.com/nodejs/node/blob/master/lib/events.js#L5
 // https://cnodejs.org/topic/571e0c445a26c4a841ecbcf1
 function EmptyObject() {}
 EmptyObject.prototype = Object.create(null);
 
 /**
- * Generate a real map object(clean object), no constructor, no __proto__
+ * generate a real map object(clean object), no constructor, no __proto__
  * @param {Object} [obj] - init object, optional
  */
 export function map(obj?: any): Record<string, any> {
diff --git a/src/optimize.ts b/src/optimize.ts
@@ -1,5 +1,5 @@
 /**
- * Optimize try catch
+ * optimize try catch
  */
 export function tryCatch<T = any>(fn: () => T) {
   const res: {
@@ -29,7 +29,7 @@ export const UNSTABLE_METHOD = {
 };
 
 /**
- * Avoid if (a && a.b && a.b.c)
+ * avoid if (a && a.b && a.b.c)
  */
 export function dig(obj?: any, ...keys: string[]) {
   if (!obj) {
@@ -51,7 +51,7 @@ export function dig(obj?: any, ...keys: string[]) {
 }
 
 /**
- * Optimize arguments to array
+ * optimize arguments to array
  */
 export function argumentsToArray(args: any[]) {
   const res = new Array(args.length);
diff --git a/src/string.ts b/src/string.ts
@@ -10,7 +10,7 @@ export function randomString(length?: number, charSet?: string) {
 }
 
 /**
- * Split string to array
+ * split string to array
  * @param  {String} str input string
  * @param  {String} [sep] default is ','
  */
@@ -26,7 +26,7 @@ export function split(str?: string, sep?: string) {
   }
   return needs;
 }
-// Keep compatibility
+// keep compatibility
 export const splitAlwaysOptimized = split;
 
 type StringReplacer = (substring: string, ...args: any[]) => string;
@@ -41,7 +41,7 @@ export function replace(str: string, substr: string | RegExp, newSubstr: string
   return str.replace(substr, newSubstr);
 }
 
-// Original source https://github.com/nodejs/node/blob/v7.5.0/lib/_http_common.js#L300
+// original source https://github.com/nodejs/node/blob/v7.5.0/lib/_http_common.js#L300
 /**
  * True if val contains an invalid field-vchar
  *  field-value    = *( field-content / obs-fold )
@@ -93,7 +93,7 @@ export function replaceInvalidHttpHeaderChar(val: string, replacement?: string |
   let chars: string[] | undefined;
   for (let i = 0; i < val.length; ++i) {
     if (!validHdrChars[val.charCodeAt(i)]) {
-      // Delay create chars
+      // delay create chars
       chars = chars || val.split('');
       if (typeof replacement === 'function') {
         chars[i] = replacement(chars[i]);
diff --git a/test/crypto.test.ts b/test/crypto.test.ts
@@ -107,7 +107,7 @@ describe('test/crypto.test.ts', () => {
       // > 4Vnqz+LV0qMMt/a81E+EURcQMrI=
       assert.equal(utility.hmac('sha1', 'I am a key', '中文，你好', 'base64'), '4Vnqz+LV0qMMt/a81E+EURcQMrI=');
 
-      // Should work with buffer data
+      // should work with buffer data
       assert.equal(utility.hmac('sha1', 'I am a key', '中文，你好'), utility.hmac('sha1', 'I am a key', Buffer.from('中文，你好')));
     });
   });
@@ -144,7 +144,7 @@ Encode string s using a URL-safe alphabet, which substitutes - instead of + and
       assert.match(utility.base64encode(s), /\+/);
       assert.match(utility.base64encode(s), /\//);
 
-      // UrlSafe
+      // urlSafe
       assert.equal(utility.base64decode(utility.base64encode(s, true), true), s);
       assert.match(utility.base64encode(s, true), /[^+]/);
       assert.match(utility.base64encode(s, true), /[^\/]/);
diff --git a/test/date.test.ts b/test/date.test.ts
@@ -42,7 +42,7 @@ describe('test/date.test.ts', () => {
     });
 
     it('should work with timestamp', () => {
-      // Timezone GMT+0800
+      // timezone GMT+0800
       assert.match(utility.YYYYMMDDHHmmss(new Date('2014-02-14 01:02:03'), {}), /^2014\-02\-14 01:02:03$/);
     });
 
@@ -83,7 +83,7 @@ describe('test/date.test.ts', () => {
     });
 
     it('should work with timestamp', () => {
-      // Timezone GMT+0800
+      // timezone GMT+0800
       assert.match(utils.YYYYMMDDHHmmss(1428894236645, {}), /^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]) (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]$)/);
     });
   });
diff --git a/test/fs.test.ts b/test/fs.test.ts
@@ -19,7 +19,7 @@ describe('test/fs.test.ts', () => {
 
       stats = await utility.exists(__dirname);
       assert(stats instanceof Stats);
-      // Assert(stats.size > 0, 'stats.size > 0');
+      // assert(stats.size > 0, 'stats.size > 0');
       assert.equal(stats.isDirectory(), true);
       assert.equal(stats.isFile(), false);
       assert.equal(await exists(__dirname + '/nonexistent'), false);
diff --git a/test/number.test.ts b/test/number.test.ts
@@ -6,7 +6,7 @@ describe('test/number.test.ts', () => {
   describe('isSafeNumberString(), toSafeNumber()', () => {
     it('should detect number string success', () => {
       const numbers = [
-        // Str, safe or not
+        // str, safe or not
         [ String(utility.MAX_SAFE_INTEGER), true ],
         [ String(utility.MIN_SAFE_INTEGER), true ],
         [ String(utility.MAX_SAFE_INTEGER + 10), false ],
diff --git a/test/string.test.ts b/test/string.test.ts
@@ -94,7 +94,7 @@ describe('test/number.test.ts', () => {
       assert.equal(utility.replaceInvalidHttpHeaderChar(s8, '-').val, '1111-1-0');
       assert.equal(utility.replaceInvalidHttpHeaderChar(s8, '-').invalid, true);
 
-      // Support replacement function
+      // support replacement function
       const result = utility.replaceInvalidHttpHeaderChar(s9, function(val) {
         return encodeURIComponent(val);
       });
diff --git a/test/timeout.test.ts b/test/timeout.test.ts
@@ -19,7 +19,7 @@ describe('test/timeout.test.ts', () => {
         assert(err instanceof TimeoutError);
         assert.equal(err.timeout, 10);
         assert.equal(err.message, 'Timed out after 10ms');
-        // Console.error(err);
+        // console.error(err);
         return true;
       });
 
@@ -31,7 +31,7 @@ describe('test/timeout.test.ts', () => {
         assert(err instanceof TimeoutError);
         assert.equal(err.timeout, 15);
         assert.equal(err.message, 'Timed out after 15ms');
-        // Console.error(err);
+        // console.error(err);
         return true;
       });
     });
@@ -53,7 +53,7 @@ describe('test/timeout.test.ts', () => {
         assert(err instanceof TimeoutError);
         assert.equal(err.timeout, 10);
         assert.equal(err.message, 'Timed out after 10ms');
-        // Console.error(err);
+        // console.error(err);
         return true;
       });
     });

Original file line number	Diff line number	Diff line change
`@@ -25,13 +25,13 @@ export function randomSlice<T = any>(arr: T[], num?: number): T[] {`
`25`	`25`	`export function spliceOne<T = any>(arr: T[], index: number): T[] {`
`26`	`26`	`if (index < 0) {`
`27`	`27`	`index = arr.length + index;`
`28`		`- // Still negative, not found element`
	`28`	`+ // still negative, not found element`
`29`	`29`	`if (index < 0) {`
`30`	`30`	`return arr;`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`- // Don't touch`
	`34`	`+ // don't touch`
`35`	`35`	`if (index >= arr.length) {`
`36`	`36`	`return arr;`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ type HashMethod = (method: string, data: HashInput, outputEncoding?: BinaryToTex`
`7`	`7`	`const nativeHash = 'hash' in crypto ? crypto.hash as HashMethod : null;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Hash`
	`10`	`+ * hash`
`11`	`11`	`*`
`12`	`12`	`* @param {String} method hash method, e.g.: 'md5', 'sha1'`
`13`	`13`	`* @param {String\|Buffer\|ArrayBuffer\|TypedArray\|DataView\|Object} s input value`
`@@ -25,7 +25,7 @@ export function hash(method: string, s: HashInput, format?: BinaryToTextEncoding`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`if (nativeHash) {`
`28`		`- // Try to use crypto.hash first`
	`28`	`+ // try to use crypto.hash first`
`29`	`29`	`// https://nodejs.org/en/blog/release/v21.7.0#crypto-implement-cryptohash`
`30`	`30`	`return nativeHash(method, s, format);`
`31`	`31`	`}`
`@@ -36,7 +36,7 @@ export function hash(method: string, s: HashInput, format?: BinaryToTextEncoding`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`/**`
`39`		`- * Md5 hash`
	`39`	`+ * md5 hash`
`40`	`40`	`*`
`41`	`41`	`* @param {String\|Buffer\|Object} s input value`
`42`	`42`	`* @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.`
`@@ -48,7 +48,7 @@ export function md5(s: HashInput, format?: BinaryToTextEncoding): string {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
`51`		`- * Sha1 hash`
	`51`	`+ * sha1 hash`
`52`	`52`	`*`
`53`	`53`	`* @param {String\|Buffer\|Object} s input value`
`54`	`54`	`* @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.`
`@@ -60,7 +60,7 @@ export function sha1(s: HashInput, format?: BinaryToTextEncoding): string {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`/**`
`63`		`- * Sha256 hash`
	`63`	`+ * sha256 hash`
`64`	`64`	`*`
`65`	`65`	`* @param {String\|Buffer\|Object} s input value`
`66`	`66`	`* @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.`
`@@ -72,7 +72,7 @@ export function sha256(s: HashInput, format?: BinaryToTextEncoding): string {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`/**`
`75`		`- * Sha512 hash`
	`75`	`+ * sha512 hash`
`76`	`76`	`*`
`77`	`77`	`* @param {String\|Buffer\|Object} s input value`
`78`	`78`	`* @param {String} [format] output string format, could be 'hex' or 'base64'. default is 'hex'.`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import assert from 'node:assert';`
`5`	`5`	`*/`
`6`	`6`	`// eslint-disable-next-line @typescript-eslint/no-unused-vars`
`7`	`7`	`export function noop(..._args: any[]): any {`
`8`		`- // Noop`
	`8`	`+ // noop`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`/**`