my-code-style 1.2.0 → 1.5.0

package/package.json

@@ -1,127 +1,228 @@
 {
-    "name": "my-code-style",
-    "version": "1.2.0",
-    "description": "Lint/Format/Git 配置工程化 npm 包（ESLint + Prettier + Stylelint + Commitlint + Husky + standard-version）",
-    "type": "commonjs",
-    "main": "src/eslint/uniapp.cjs",
-    "bin": {
-        "my-code-style-init": "./bin/init"
-    },
-    "exports": {
-        ".": "./src/eslint/uniapp.cjs",
-        "./eslint": "./src/eslint/base.cjs",
-        "./eslint/vue3": "./src/eslint/vue3.cjs",
-        "./eslint/uniapp": "./src/eslint/uniapp.cjs",
-        "./eslint/flat": "./src/eslint/flat/base.mjs",
-        "./eslint/flat/vue3": "./src/eslint/flat/vue3.mjs",
-        "./eslint/flat/uniapp": "./src/eslint/flat/uniapp.mjs",
-        "./prettier": "./src/prettier/index.cjs",
-        "./stylelint": "./src/stylelint/index.cjs",
-        "./stylelint/less": "./src/stylelint/less.cjs",
-        "./stylelint/less-override": "./src/stylelint/less-override.cjs",
-        "./commitlint": "./src/commitlint/base.cjs",
-        "./commitlint/scopes": "./src/commitlint/scopes.cjs",
-        "./versionrc": "./src/versionrc/index.cjs"
-    },
-    "files": [
-        "src",
-        "bin",
-        "README.md"
+  "name": "my-code-style",
+  "version": "1.5.0",
+  "description": "Lint/Format/Git 配置工程化 npm 包（ESLint + Prettier + Stylelint + Commitlint + Husky + standard-version）",
+  "type": "commonjs",
+  "main": "src/eslint/uniapp.cjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/myvn/codeStyle.git"
+  },
+  "homepage": "https://github.com/myvn/codeStyle#readme",
+  "bugs": {
+    "url": "https://github.com/myvn/codeStyle/issues"
+  },
+  "bin": {
+    "my-code-style-init": "./bin/init"
+  },
+  "exports": {
+    ".": "./src/eslint/uniapp.cjs",
+    "./eslint": "./src/eslint/base.cjs",
+    "./eslint/vue3": "./src/eslint/vue3.cjs",
+    "./eslint/uniapp": "./src/eslint/uniapp.cjs",
+    "./eslint/flat": "./src/eslint/flat/base.mjs",
+    "./eslint/flat/vue3": "./src/eslint/flat/vue3.mjs",
+    "./eslint/flat/uniapp": "./src/eslint/flat/uniapp.mjs",
+    "./prettier": "./src/prettier/index.cjs",
+    "./stylelint": "./src/stylelint/index.cjs",
+    "./stylelint/less": "./src/stylelint/less.cjs",
+    "./stylelint/less-override": "./src/stylelint/less-override.cjs",
+    "./commitlint": "./src/commitlint/base.cjs",
+    "./commitlint/scopes": "./src/commitlint/scopes.cjs",
+    "./versionrc": "./src/versionrc/index.cjs"
+  },
+  "files": [
+    "src",
+    "bin",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "test": "node --test tests/*.test.cjs demo-test/*.test.cjs",
+    "test:demo": "node --test demo-test/*.test.cjs",
+    "test:integration:setup": "node demo-test/setup-integration.cjs",
+    "test:integration": "node --test demo-test/integration/*.test.cjs",
+    "test:legacy:setup": "node demo-test/setup-legacy.cjs",
+    "test:legacy": "node --test demo-test/legacy/*.test.cjs",
+    "test:all": "npm test && npm run test:integration && npm run test:legacy",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "prepare": "node -e \"if (!process.env.CI) { try { require('child_process').execSync('husky', { stdio: 'ignore' }) } catch {} }\"",
+    "release": "standard-version",
+    "release:push": "standard-version && git push --follow-tags origin HEAD",
+    "pub": "npm run release:push",
+    "cz": "czg",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global",
+    "pack": "npm pack"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "@commitlint/cli": "^19.0.0",
+    "@commitlint/config-conventional": "^19.0.0",
+    "@eslint/eslintrc": "^3.0.0",
+    "@eslint/js": "^9.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "czg": "^1.0.0",
+    "eslint": "^8.57.0 || ^9.0.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^3.0.0",
+    "eslint-plugin-import": "^2.0.0",
+    "eslint-plugin-import-x": "^4.0.0",
+    "eslint-plugin-prettier": "^5.2.0",
+    "eslint-plugin-vue": "^10.0.0",
+    "globals": "^16.0.0",
+    "husky": "^9.0.0",
+    "lint-staged": "^16.0.0",
+    "postcss-html": "^2.0.0",
+    "postcss-less": "^6.0.0",
+    "postcss-scss": "^4.0.0",
+    "prettier": "^3.0.0",
+    "standard-version": "^9.0.0",
+    "stylelint": "^16.0.0",
+    "stylelint-config-html": "^2.0.0",
+    "stylelint-config-recess-order": "^5.0.0",
+    "stylelint-config-recommended": "^17.0.0",
+    "stylelint-config-recommended-scss": "^16.0.0",
+    "stylelint-config-recommended-vue": "^2.0.0",
+    "stylelint-prettier": "^5.0.0",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.0.0",
+    "vue-eslint-parser": "^10.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@commitlint/cli": {
+      "optional": true
+    },
+    "@commitlint/config-conventional": {
+      "optional": true
+    },
+    "@eslint/eslintrc": {
+      "optional": true
+    },
+    "@eslint/js": {
+      "optional": true
+    },
+    "@typescript-eslint/eslint-plugin": {
+      "optional": true
+    },
+    "@typescript-eslint/parser": {
+      "optional": true
+    },
+    "czg": {
+      "optional": true
+    },
+    "eslint": {
+      "optional": true
+    },
+    "eslint-config-prettier": {
+      "optional": true
+    },
+    "eslint-import-resolver-typescript": {
+      "optional": true
+    },
+    "eslint-plugin-import": {
+      "optional": true
+    },
+    "eslint-plugin-import-x": {
+      "optional": true
+    },
+    "eslint-plugin-prettier": {
+      "optional": true
+    },
+    "eslint-plugin-vue": {
+      "optional": true
+    },
+    "globals": {
+      "optional": true
+    },
+    "husky": {
+      "optional": true
+    },
+    "lint-staged": {
+      "optional": true
+    },
+    "postcss-html": {
+      "optional": true
+    },
+    "postcss-less": {
+      "optional": true
+    },
+    "postcss-scss": {
+      "optional": true
+    },
+    "prettier": {
+      "optional": true
+    },
+    "standard-version": {
+      "optional": true
+    },
+    "stylelint": {
+      "optional": true
+    },
+    "stylelint-config-html": {
+      "optional": true
+    },
+    "stylelint-config-recess-order": {
+      "optional": true
+    },
+    "stylelint-config-recommended": {
+      "optional": true
+    },
+    "stylelint-config-recommended-scss": {
+      "optional": true
+    },
+    "stylelint-config-recommended-vue": {
+      "optional": true
+    },
+    "stylelint-prettier": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    },
+    "typescript-eslint": {
+      "optional": true
+    },
+    "vue-eslint-parser": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "standard-version": "^9.5.0"
+  },
+  "keywords": [
+    "eslint-config",
+    "prettier-config",
+    "stylelint-config",
+    "commitlint-config",
+    "vue",
+    "uni-app",
+    "typescript"
+  ],
+  "license": "MIT",
+  "lint-staged": {
+    "**/*.{vue,nvue}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "**/*.{js,ts,jsx,tsx,cjs,mjs,mts,cts}": [
+      "prettier --write",
+      "eslint --fix"
     ],
-    "scripts": {
-        "link": "pnpm link --global",
-        "unlink": "pnpm unlink --global",
-        "pack": "npm pack",
-        "release": "standard-version"
-    },
-    "engines": {
-        "node": ">=18"
-    },
-    "peerDependencies": {
-        "@commitlint/cli": "^19.0.0",
-        "@commitlint/config-conventional": "^19.0.0",
-        "@eslint/eslintrc": "^3.0.0",
-        "@eslint/js": "^9.0.0",
-        "@typescript-eslint/eslint-plugin": "^8.0.0",
-        "@typescript-eslint/parser": "^8.0.0",
-        "czg": "^1.0.0",
-        "eslint": "^9.0.0",
-        "eslint-config-prettier": "^10.1.8",
-        "eslint-import-resolver-typescript": "^3.0.0",
-        "eslint-plugin-import": "^2.0.0",
-        "eslint-plugin-import-x": "^4.0.0",
-        "eslint-plugin-prettier": "^5.2.0",
-        "eslint-plugin-vue": "^10.0.0",
-        "globals": "^16.0.0",
-        "husky": "^9.0.0",
-        "lint-staged": "^16.0.0",
-        "postcss-html": "^1.0.0",
-        "postcss-less": "^6.0.0",
-        "postcss-scss": "^4.0.0",
-        "prettier": "^3.0.0",
-        "standard-version": "^9.0.0",
-        "stylelint": "^16.0.0",
-        "stylelint-config-html": "^1.0.0",
-        "stylelint-config-recess-order": "^5.0.0",
-        "stylelint-config-recommended": "^17.0.0",
-        "stylelint-config-recommended-scss": "^16.0.0",
-        "stylelint-config-recommended-vue": "^2.0.0",
-        "stylelint-prettier": "^5.0.0",
-        "typescript-eslint": "^8.0.0",
-        "vue-eslint-parser": "^9.0.0"
-    },
-    "peerDependenciesMeta": {
-        "@eslint/eslintrc": {
-            "optional": true
-        },
-        "@eslint/js": {
-            "optional": true
-        },
-        "eslint-plugin-vue": {
-            "optional": true
-        },
-        "eslint-plugin-import-x": {
-            "optional": true
-        },
-        "globals": {
-            "optional": true
-        },
-        "postcss-less": {
-            "optional": true
-        },
-        "postcss-scss": {
-            "optional": true
-        },
-        "postcss-html": {
-            "optional": true
-        },
-        "stylelint-config-recommended-scss": {
-            "optional": true
-        },
-        "stylelint-config-recommended-vue": {
-            "optional": true
-        },
-        "stylelint-config-html": {
-            "optional": true
-        },
-        "typescript-eslint": {
-            "optional": true
-        },
-        "vue-eslint-parser": {
-            "optional": true
-        }
-    },
-    "devDependencies": {
-        "standard-version": "^9.5.0"
-    },
-    "keywords": [
-        "eslint-config",
-        "prettier-config",
-        "stylelint-config",
-        "commitlint-config",
-        "vue",
-        "uni-app",
-        "typescript"
+    "**/*.{html,css}": [
+      "prettier --write"
     ],
-    "license": "MIT"
+    "**/*.{json,json5,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  }
 }

package/src/commitlint/base.cjs

@@ -1,6 +1,5 @@
 // Commitlint base config (without project-specific dynamic scopes)
 module.exports = {
-    ignores: [(commit) => commit.includes("init")],
     extends: ["@commitlint/config-conventional"],
     rules: {
         "body-leading-blank": [2, "always"],

package/src/commitlint/scopes.cjs

@@ -25,34 +25,88 @@ const PLURAL_MAP = {
     assets: "asset",
 }
 
+// Plurals whose singular cannot be derived by rule: uncountables, irregulars,
+// and the "-e" + "s" words that would otherwise lose their stem ("caches" →
+// "cach"). Everything else is handled by the suffix rules below.
+const EXACT_SINGULAR = {
+    news: "news",
+    series: "series",
+    movies: "movie",
+    cookies: "cookie",
+    caches: "cache",
+    chases: "chase",
+    niches: "niche",
+}
+
+// Directory names that already read as singular (or are conventional as-is)
+const NON_PLURAL = [
+    "status",
+    "canvas",
+    "bus",
+    "pass",
+    "process",
+    "css",
+    "less",
+    "scss",
+    "js",
+    "ts",
+    "types",
+]
+
+// Singulars that legitimately end in "s"/"z" and therefore take "-es":
+// bus → buses, status → statuses. Without this list "buses" would follow the
+// "-se + s" reading and become "buse".
+const SIBILANT_SINGULARS = [
+    "bus",
+    "gas",
+    "canvas",
+    "alias",
+    "atlas",
+    "bias",
+    "virus",
+    "status",
+    "process",
+    "lens",
+    "plus",
+    "focus",
+    "campus",
+    "analysis",
+    "axis",
+    "basis",
+    "crisis",
+    "thesis",
+    "quiz",
+]
+
+// Unambiguous "-es" plurals: the stem ends in a doubled sibilant or a digraph
+// (classes, boxes, churches, dishes, buzzes, batches, fixes).
+const ES_PLURAL = /(?:ss|zz|ch|sh|x)es$/i
+// "-ses"/"-zes" are ambiguous: "cases" is case + s, "buses" is bus + es.
+const S_OR_Z_ES_PLURAL = /[sz]es$/i
+
 function toSingular(name) {
     if (!name) {
         return name
     }
-    if (PLURAL_MAP[name]) {
-        return PLURAL_MAP[name]
+    const lower = name.toLowerCase()
+    if (PLURAL_MAP[lower]) {
+        return PLURAL_MAP[lower]
+    }
+    if (EXACT_SINGULAR[lower]) {
+        return EXACT_SINGULAR[lower]
+    }
+    if (NON_PLURAL.includes(lower)) {
+        return name
     }
-    if (name.endsWith("ies") && name.length > 4) {
+    if (/ies$/i.test(name) && name.length > 4) {
         return name.slice(0, -3) + "y"
     }
-    if (/(?:[sxz]|[ch|sh])es$/.test(name)) {
+    if (ES_PLURAL.test(name)) {
         return name.slice(0, -2)
     }
-    const nonPluralEndingInS = [
-        "status",
-        "canvas",
-        "bus",
-        "pass",
-        "process",
-        "css",
-        "less",
-        "scss",
-        "js",
-        "ts",
-        "types",
-    ]
-    if (nonPluralEndingInS.includes(name.toLowerCase())) {
-        return name
+    if (S_OR_Z_ES_PLURAL.test(name)) {
+        const esStem = name.slice(0, -2).toLowerCase()
+        return SIBILANT_SINGULARS.includes(esStem) ? name.slice(0, -2) : name.slice(0, -1)
     }
     if (name.endsWith("s") && !name.endsWith("ss") && name.length > 3) {
         return name.slice(0, -1)
@@ -71,11 +125,15 @@ function generateScopes(srcDirs = "src") {
 
     for (const srcDir of dirs) {
         const resolved = path.resolve(process.cwd(), srcDir)
-        if (!fs.existsSync(resolved)) {
+        let entries
+        try {
+            // A missing path, a plain file, or an unreadable directory must not
+            // break the commitlint config load — just yield no scopes.
+            entries = fs.readdirSync(resolved, { withFileTypes: true })
+        } catch {
             continue
         }
-        const scopes = fs
-            .readdirSync(resolved, { withFileTypes: true })
+        const scopes = entries
             .filter((dirent) => dirent.isDirectory())
             .map((dirent) => toSingular(dirent.name))
         allScopes.push(...scopes)
@@ -84,19 +142,130 @@ function generateScopes(srcDirs = "src") {
     return [...new Set(allScopes)]
 }
 
+function getStagedFiles(cwd) {
+    try {
+        const output = execSync("git diff --cached --name-only -z", {
+            cwd,
+            stdio: ["pipe", "pipe", "ignore"],
+        }).toString()
+        return output.split("\0").filter(Boolean)
+    } catch {
+        try {
+            const output = execSync("git status --porcelain -z", {
+                cwd,
+                stdio: ["pipe", "pipe", "ignore"],
+            }).toString()
+            const parts = output.split("\0")
+            const staged = []
+            for (let i = 0; i < parts.length; i++) {
+                const entry = parts[i]
+                if (!entry) continue
+                const x = entry[0]
+                const isRenameOrCopy = x === "R" || x === "C"
+                const filePath = entry.slice(3)
+                if (x !== " " && x !== "?" && x !== "!") {
+                    if (filePath) staged.push(filePath)
+                }
+                if (isRenameOrCopy) {
+                    i++
+                }
+            }
+            return staged
+        } catch {
+            return []
+        }
+    }
+}
+
 /**
- * Guess the current scope from git status (modified files under src/)
- * @returns {string|undefined}
+ * Guess the current scope from staged files in the git index.
+ * Only staged files are considered (unstaged and untracked changes are ignored).
+ * Multi-directory strategy: votes by the number of staged changes under each candidate scope directory;
+ * in case of a tie, the first encountered scope among staged files is chosen.
+ *
+ * @param {string|string[]} [srcDirs="src"] - Source directory name(s) relative to cwd
+ * @returns {string|undefined} Guessed scope name, or undefined if none matched
  */
-function guessCurrentScope() {
+function guessCurrentScope(srcDirs = "src") {
     try {
-        const output = execSync("git status --porcelain || true").toString().trim()
-        const line = output.split("\n").find((r) => r.includes("M  src"))
-        if (!line) {
+        const cwd = process.cwd()
+        const rawPrefix = execSync("git rev-parse --show-prefix", {
+            cwd,
+            stdio: ["pipe", "pipe", "ignore"],
+        })
+            .toString()
+            .trim()
+        const prefix = rawPrefix.replace(/\\/g, "/")
+
+        const stagedFiles = getStagedFiles(cwd)
+        if (!stagedFiles || stagedFiles.length === 0) {
             return undefined
         }
-        const rawName = line.replace(/\//g, "%%").match(/src%%((\w|-)*)/)?.[1]
-        return toSingular(rawName)
+
+        const normalizedDirs = (Array.isArray(srcDirs) ? srcDirs : [srcDirs])
+            .map((d) => d.replace(/\\/g, "/").replace(/^\/+|\/+$/g, ""))
+            .filter(Boolean)
+
+        const candidateScopes = []
+
+        for (const file of stagedFiles) {
+            const normalizedFile = file.replace(/\\/g, "/")
+            if (prefix && !normalizedFile.startsWith(prefix)) {
+                continue
+            }
+            const relativeToCwd = prefix ? normalizedFile.slice(prefix.length) : normalizedFile
+
+            for (const srcDir of normalizedDirs) {
+                const dirPrefix = srcDir ? `${srcDir}/` : ""
+                if (relativeToCwd.startsWith(dirPrefix)) {
+                    const subPath = relativeToCwd.slice(dirPrefix.length)
+                    const segments = subPath.split("/").filter(Boolean)
+                    // Must have at least 2 segments (directory + file) to belong to a scope directory
+                    if (segments.length >= 2) {
+                        const rawName = segments[0]
+                        const resolvedDir = path.resolve(cwd, srcDir, rawName)
+                        if (fs.existsSync(resolvedDir)) {
+                            if (fs.statSync(resolvedDir).isDirectory()) {
+                                candidateScopes.push(toSingular(rawName))
+                                break
+                            }
+                        } else {
+                            // If deleted on disk, having segments >= 2 indicates it was a directory in git
+                            candidateScopes.push(toSingular(rawName))
+                            break
+                        }
+                    }
+                }
+            }
+        }
+
+        if (candidateScopes.length === 0) {
+            return undefined
+        }
+
+        // Multi-directory selection strategy: vote by frequency; first encountered breaks ties
+        const counts = new Map()
+        const order = []
+
+        for (const scope of candidateScopes) {
+            if (!counts.has(scope)) {
+                counts.set(scope, 0)
+                order.push(scope)
+            }
+            counts.set(scope, counts.get(scope) + 1)
+        }
+
+        let bestScope = undefined
+        let maxCount = 0
+        for (const scope of order) {
+            const count = counts.get(scope)
+            if (count > maxCount) {
+                maxCount = count
+                bestScope = scope
+            }
+        }
+
+        return bestScope
     } catch {
         return undefined
     }