feat: also modify project scripts for easier setup

haoqunjiang · haoqunjiang · commit 5983d48cb354 · 2024-11-04T17:14:51.000+08:00
diff --git a/bin/create-eslint-config.js b/bin/create-eslint-config.js
@@ -191,10 +191,6 @@ const { pkg: pkgToExtend, files } = createConfig({
   needsOxlint,
 })
 
-// TODO:
-// Add `lint` command to package.json
-// Add a `format` command to package.json when prettier is used
-
 deepMerge(pkg, pkgToExtend)
 
 // Write `package.json` back
diff --git a/index.js b/index.js
@@ -20,6 +20,7 @@ export default function createConfig({
 
   const pkg = {
     devDependencies: pickDependencies(['eslint', 'eslint-plugin-vue']),
+    scripts: {}
   }
 
   const fileExtensions = ['vue']
@@ -54,14 +55,19 @@ export default function createConfig({
 
   if (needsOxlint) {
     additionalConfigs.push({
-      devDependencies: pickDependencies(['oxlint', 'eslint-plugin-oxlint']),
+      devDependencies: pickDependencies(['oxlint', 'eslint-plugin-oxlint', 'npm-run-all2']),
       afterVuePlugin: [
         {
           importer: "import oxlint from 'eslint-plugin-oxlint'",
           content: "oxlint.configs['flat/recommended'],",
         },
       ],
     })
+    pkg.scripts['lint:eslint'] = 'eslint . --fix'
+    pkg.scripts['lint:oxlint'] = 'oxlint . --fix'
+    pkg.scripts.lint = 'run-s lint:*'
+  } else {
+    pkg.scripts.lint = 'eslint . --fix'
   }
 
   if (needsPrettier) {
@@ -78,6 +84,7 @@ export default function createConfig({
         },
       ],
     })
+    pkg.scripts.format = 'prettier --write src/'
   }
 
   const configsBeforeVuePlugin = [],
@@ -115,6 +122,10 @@ export default function createConfig({
     )
   }
 
+  // TODO:
+  // Add `lint` command to package.json
+  // Add a `format` command to package.json when prettier is used
+
   return {
     pkg,
     files,
diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
     "eslint": "^9.13.0",
     "eslint-plugin-oxlint": "^0.11.0",
     "eslint-plugin-vue": "^9.30.0",
+    "npm-run-all2": "^7.0.1",
     "oxlint": "^0.11.0",
     "prettier": "^3.3.3",
     "typescript": "~5.6.0"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
