ci: update docs

Author: tianyingchun

lint-staged.common.mjs

@@ -1,7 +1,4 @@
 import path from 'path';
-import { quote } from 'shell-quote';
-
-const isWin = process.platform === 'win32';
 
 const eslintGlobalRulesForFix = [
   // react-hooks/eslint and react in general is very strict about exhaustively
@@ -62,19 +59,3 @@ export const getEslintFixCmd = ({
   ].join(' ');
   return `eslint ${args}`;
 };
-
-/**
- * Concatenate and escape a list of filenames that can be passed as args to prettier cli
- *
- * Prettier has an issue with special characters in filenames,
- * such as the ones uses for nextjs dynamic routes (ie: [id].tsx...)
- *
- * @link https://github.com/okonet/lint-staged/issues/676
- *
- * @param {string[]} filenames
- * @returns {string} Return concatenated and escaped filenames
- */
-export const concatFilesForPrettier = (filenames) =>
-  filenames
-    .map((filename) => `"${isWin ? filename : quote([filename])}"`)
-    .join(' ');

lint-staged.config.mjs

@@ -5,10 +5,7 @@ import { fileURLToPath } from 'node:url';
  * A good practice is to override this base configuration in each package and/or application
  * where we are able to add customization depending on the nature of the project (eslint...).
  */
-import {
-  concatFilesForPrettier,
-  getEslintFixCmd,
-} from './lint-staged.common.mjs';
+import { getEslintFixCmd } from './lint-staged.common.mjs';
 
 /**
  * @type {Record<string, (filenames: string[]) => string | string[] | Promise<string | string[]>>}
@@ -26,11 +23,6 @@ const rules = {
       files: filenames,
     });
   },
-  '**/*.{json,md,mdx,css,html,yml,yaml,scss,ts,js,tsx,jsx,mjs}': (
-    filenames
-  ) => {
-    return [`prettier --write ${concatFilesForPrettier(filenames)}`];
-  },
 };
 
 export default rules;

package.json

@@ -53,7 +53,8 @@
     "lint-staged-files": "lint-staged --allow-empty",
     "changeset": "changeset",
     "release": "yarn build && changeset publish",
-    "cz": "cz"
+    "cz": "cz",
+    "postinstall": "is-ci || husky"
   },
   "config": {
     "commitizen": {
@@ -71,7 +72,6 @@
     "@commitlint/config-conventional": "19.2.2",
     "@hyperse/eslint-config-hyperse": "^1.0.4",
     "@types/node": "^20.12.12",
-    "@types/shell-quote": "1.7.5",
     "commitizen": "4.3.0",
     "cz-conventional-changelog": "3.3.0",
     "eslint": "^9.3.0",
@@ -80,7 +80,6 @@
     "lint-staged": "15.2.5",
     "npm-run-all": "^4.1.5",
     "postcss": "^8.4.38",
-    "shell-quote": "1.8.1",
     "tsup": "^8.0.2",
     "typescript": "^5.4.5",
     "vite": "^5.2.11",

yarn.lock

@@ -943,7 +943,6 @@ __metadata:
     "@hyperse/eslint-config-hyperse": "npm:^1.0.4"
     "@hyperse/ts-node-paths": "npm:^1.0.3"
     "@types/node": "npm:^20.12.12"
-    "@types/shell-quote": "npm:1.7.5"
     commitizen: "npm:4.3.0"
     cz-conventional-changelog: "npm:3.3.0"
     eslint: "npm:^9.3.0"
@@ -953,7 +952,6 @@ __metadata:
     lint-staged: "npm:15.2.5"
     npm-run-all: "npm:^4.1.5"
     postcss: "npm:^8.4.38"
-    shell-quote: "npm:1.8.1"
     tsup: "npm:^8.0.2"
     typescript: "npm:^5.4.5"
     vite: "npm:^5.2.11"
@@ -1475,13 +1473,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/shell-quote@npm:1.7.5":
-  version: 1.7.5
-  resolution: "@types/shell-quote@npm:1.7.5"
-  checksum: 10/32b4d697c7d23dbadf40713692c47f1595f083a3b3deea76cb18e30a05d197aa9205d2b87f6d92edb60cda120b51e35d32bda96ed9b0a7e32921eed2deb4559e
-  languageName: node
-  linkType: hard
-
 "@types/supports-color@npm:^8.0.0":
   version: 8.1.3
   resolution: "@types/supports-color@npm:8.1.3"
@@ -7987,7 +7978,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"shell-quote@npm:1.8.1, shell-quote@npm:^1.6.1":
+"shell-quote@npm:^1.6.1":
   version: 1.8.1
   resolution: "shell-quote@npm:1.8.1"
   checksum: 10/af19ab5a1ec30cb4b2f91fd6df49a7442d5c4825a2e269b3712eded10eedd7f9efeaab96d57829880733fc55bcdd8e9b1d8589b4befb06667c731d08145e274d