chore: tweaks

Author: Mister-Hope

.github/renovate.json

@@ -1,10 +1,6 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:recommended",
-    ":prHourlyLimitNone",
-    ":prConcurrentLimitNone"
-  ],
+  "extends": ["config:recommended", ":prHourlyLimitNone", ":prConcurrentLimitNone"],
   "dependencyDashboard": true,
   "schedule": ["every weekend"],
   "packageRules": [

.husky/commit-msg

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-pnpm commitlint --edit $1
+pnpm commitlint --edit $1

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 pnpm nano-staged

.oxfmtrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "ignorePatterns": []
+}

.oxlintrc.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "ignorePatterns": ["dist/**"],
+  "categories": {
+    "correctness": "error",
+    "suspicious": "warn",
+    "pedantic": "warn",
+    "perf": "warn",
+    "style": "warn",
+    "restriction": "off"
+  },
+  "plugins": ["import", "unicorn", "oxc", "promise", "jsdoc", "vitest", "node"],
+  "rules": {
+    "catch-error-name": ["warn", { "name": "err" }],
+    "curly": ["off", "multi-line"],
+    "group-exports": "off",
+    "id-length": "off",
+    "init-declarations": "off",
+    "max-dependencies": "off",
+    "max-lines": "off",
+    "max-lines-per-function": "off",
+    "max-params": ["warn", 4],
+    "no-continue": "off",
+    "no-console": "warn",
+    "no-duplicate-imports": "off",
+    "no-magic-numbers": "off",
+    // "no-magic-numbers": ["warn", { "ignore": [-1, 0, 1, 2] }],
+    "no-nested-ternary": "off",
+    "no-null": "off",
+    "no-ternary": "off",
+    "no-warning-comments": "off",
+    "sort-imports": "off",
+    "sort-keys": "off",
+
+    "import/exports-last": "off",
+    // usually we just export vue components as default export without naming it
+    "import/no-anonymous-default-export": "off",
+    // a rule that shall not be enabled anyway
+    "import/no-named-export": "off",
+    "import/no-unassigned-import": ["error", { "allow": ["**/*.css", "**/*.scss"] }],
+    // named export is preferred in our codebase
+    "import/prefer-default-export": "off",
+    "jsdoc/require-param": "off",
+    "jsdoc/require-param-type": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/require-returns-type": "off",
+    "promise/always-return": "off",
+    "promise/avoid-new": "off",
+    "promise/prefer-await-to-then": "off",
+    "unicorn/filename-case": "off",
+    // toReversed can introduce memory overhead
+    "unicorn/no-array-reverse": "off",
+    // toSorted can introduce memory overhead
+    "unicorn/no-array-sort": "off",
+    "unicorn/no-nested-ternary": "off",
+    // at is not supported by our target environments
+    "unicorn/prefer-at": "off",
+    "unicorn/prefer-global-this": "off",
+
+    // seems conflicts with prettier
+    "number-literal-case": "off",
+    "numeric-separators-style": "off",
+
+    // style rules
+    "capitalized-comments": "off",
+    "max-statements": ["warn", { "max": 30 }],
+    "no-inline-comments": "off"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.ts"],
+      "plugins": ["typescript"],
+      "rules": {
+        // we make type casts only when necessary
+        // "typescript/no-unsafe-type-assertion": "off",
+        // skipping it for now, may enable it later
+        // "typescript/switch-exhaustiveness-check": "off",
+        // a lot of time we are just want to check existence
+        // "typescript/strict-boolean-expressions": "off"
+      }
+    },
+    {
+      "files": ["**/__tests__/**"],
+      "plugins": ["vitest"]
+    }
+  ]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["oxc.oxc-vscode", "vitest.explorer"]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.defaultFormatter": "oxc.oxc-vscode"
+}

README.md

@@ -170,10 +170,7 @@ export const compare: (
  * @param salt Salt length to generate or salt to use, default to 10
  * @returns Resulting hash
  */
-export const hashSync: (
-  contentString: string,
-  salt?: string | number,
-) => string;
+export const hashSync: (contentString: string, salt?: string | number) => string;
 /**
  * Asynchronously generates a hash for the given string.
  *

__tests__/base64.spec.ts

@@ -2,13 +2,13 @@ import { describe, expect, it } from "vitest";
 
 import { decodeBase64, encodeBase64 } from "../src/base64.js";
 
-describe("encodeBase64", () => {
+describe(encodeBase64, () => {
   it("should encode byte array to base64 string", () => {
     expect(
       encodeBase64(
         [
-          0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a,
-          0x0b, 0x0c, 0x0d, 0x0e, 0x0f, 0x10,
+          0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
+          0x0f, 0x10,
         ],
         16,
       ),
@@ -22,11 +22,11 @@ describe("encodeBase64", () => {
   });
 });
 
-describe("decodeBase64", () => {
+describe(decodeBase64, () => {
   it("should decode base64 string to byte array", () => {
     expect(decodeBase64("..CA.uOD/eaGAOmJB.yMBv.", 16)).toEqual([
-      0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b,
-      0x0c, 0x0d, 0x0e, 0x0f,
+      0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
+      0x0f,
     ]);
   });
 

__tests__/compare.bench.ts

@@ -14,7 +14,7 @@ Eget ultricies potenti aptent augue eget quisque erat habitasse feugiat. Commodo
 Aliquet curae fames vel; purus dolor maecenas. Fermentum sagittis nulla ornare bibendum justo pellentesque lacinia, sem eleifend. Justo eleifend etiam suspendisse sagittis; fames ipsum. Sodales cras mus non metus sapien parturient maximus adipiscing blandit. Praesent amet risus; auctor molestie eros morbi. Torquent pulvinar sodales; a nisi cursus tempus. Dignissim ipsum placerat nisl litora auctor.
 `;
 
-describe("compare", async () => {
+describe(compare, async () => {
   const hellow5Hash = await hash("hello", 5);
   const hellow10Hash = await hash("hello", 10);
   const lorenHash = await hash(lorem, 5);
@@ -44,7 +44,7 @@ describe("compare", async () => {
   );
 });
 
-describe("compareSync", () => {
+describe(compareSync, () => {
   const hellow5Hash = hashSync("hello", 5);
   const hellow10Hash = hashSync("hello", 10);
   const lorenHash = hashSync(lorem, 5);