commit-sheriff 1.3.0 → 1.4.0

package/README.md

@@ -77,9 +77,9 @@ Run this once per repo, from the repo root (where `package.json` lives). This wo
 3. Creates a default `.commitsheriffrc.json` file at the repo root **only if one doesn't already exist** (and only if there's no legacy `package.json` → `commitGuard` block either — see [Configuration](#configuration-commitsheriffrcjson)) — re-running `init` never overwrites your customized config.
 4. Adds a default `lint-staged` block to `package.json` **only if one doesn't already exist**.
 5. Adds a `"prepare": "husky"` npm script if missing, so hooks are (re)installed automatically after `npm install`.
-6. If `react` and `typescript` are both present in your `dependencies`/`devDependencies`, also runs [`add-eslint-react`](#advanced-eslint-module-boundary-template-typescriptreact) automatically. Otherwise it's skipped and you can add it manually later.
+6. If `react` and `typescript` are both present in your `dependencies`/`devDependencies`, also runs [`add-eslint-react`](#advanced-eslint-module-boundary-template-typescriptreact) automatically, which **overwrites** `.eslintrc.js` and `.prettierrc.js` with the latest template. Otherwise it's skipped and you can add it manually later.
 
-Re-running `npx commit-sheriff init` later (e.g. after updating the package) is safe: it refreshes the two hook scripts to the latest version but leaves your `.commitsheriffrc.json` / `lint-staged` config alone.
+Re-running `npx commit-sheriff init` later (e.g. after updating the package) is safe for your project-specific settings: it refreshes the hook scripts and (on react+typescript projects) the ESLint/Prettier templates to the latest version, but leaves your `.commitsheriffrc.json` / `lint-staged` config alone. If you've hand-edited `.eslintrc.js` or `.prettierrc.js`, back them up first — those two get overwritten on every re-run.
 
 ## Commit message format
 
@@ -162,7 +162,6 @@ Add/edit this file at your project's **root** (next to `package.json`) — the `
   ],
   "types": [
     "feat",
-    "feature",
     "fix",
     "docs",
     "style",
@@ -219,7 +218,7 @@ Allowed prefixes for **branch names**. This is intentionally a coarser, workflow
 
 ### `types`
 
-`string[]`, default: `["feat", "feature", "fix", "docs", "style", "refactor", "test", "chore", "perf", "ci", "build", "revert"]`.
+`string[]`, default: `["feat", "fix", "docs", "style", "refactor", "test", "chore", "perf", "ci", "build", "revert"]`.
 
 Allowed `type` words in **commit messages**, following [Conventional Commits](https://www.conventionalcommits.org/) style.
 
@@ -258,12 +257,18 @@ other through a public barrel file, never through deep/internal paths:
 npx commit-sheriff add-eslint-react
 ```
 
-This copies two templates into your repo root, **without overwriting** anything already there:
+This copies two templates into your repo root, **always overwriting** whatever is already
+there at those exact filenames (same behavior as the `commit-msg`/`pre-commit` hooks — re-running
+it refreshes both files to the latest version of the template):
 
 - `.eslintrc.js` — legacy-format ESLint config (TypeScript + React + a11y + import + sonarjs +
   testing-library/jest/vitest rules) with a module-boundary `no-restricted-imports` rule.
 - `.prettierrc.js` — matching Prettier config.
 
+If you've customized either file by hand, back it up under a different name before re-running
+`add-eslint-react` (or `init` on a react+typescript project, which calls it automatically) —
+your edits will be replaced.
+
 The module list for the boundary rule isn't hardcoded — it's read straight from the `modules`
 array in your root `.commitsheriffrc.json` (the same list the commit-msg/branch-name hooks use
 for the `[MODULE]` tag), lowercased. For older installs still using `package.json`'s

package/bin/commit-sheriff.js

@@ -24,7 +24,6 @@ const DEFAULT_COMMIT_GUARD = {
   ],
   types: [
     "feat",
-    "feature",
     "fix",
     "docs",
     "style",
@@ -162,24 +161,24 @@ const ESLINT_REACT_DEV_DEPS = [
   "prettier",
 ];
 
-function copyTemplateIfMissing(templateName, destName) {
+function copyTemplateOverwrite(templateName, destName) {
   const src = path.join(__dirname, "..", "templates", templateName);
   const dest = path.join(cwd, destName);
-  if (fs.existsSync(dest)) {
-    console.log(`• ${destName} artıq var, toxunulmadı`);
-    return;
-  }
+  const existed = fs.existsSync(dest);
   fs.copyFileSync(src, dest);
-  console.log(`✔ ${destName} yazıldı`);
+  console.log(existed ? `✔ ${destName} yeniləndi (üzərinə yazıldı)` : `✔ ${destName} yazıldı`);
 }
 
 function addEslintReact() {
-  copyTemplateIfMissing("eslintrc.module-boundaries.js", ".eslintrc.js");
-  copyTemplateIfMissing("prettier.module-boundaries.js", ".prettierrc.js");
+  copyTemplateOverwrite("eslintrc.module-boundaries.js", ".eslintrc.js");
+  copyTemplateOverwrite("prettier.module-boundaries.js", ".prettierrc.js");
   console.log(
     "\nBu şablon TypeScript/React + modul-sərhəd (module-boundary) qaydaları üçündür.\n" +
       `Modul siyahısı ${CONFIG_FILE_NAME}.modules-dən avtomatik oxunur (boşdursa nümunə\n` +
       "siyahı istifadə olunur — .eslintrc.js içindəki şərhi oxuyun).\n\n" +
+      "Diqqət: .eslintrc.js və .prettierrc.js hər dəfə şablonun ən son versiyası ilə\n" +
+      "üzərinə yazılır (commit-msg/pre-commit hook-ları kimi) — özünüzə uyğun etdiyiniz\n" +
+      "dəyişiklikləri qorumaq istəsəniz, əvvəlcə fərqli adla backup götürün.\n\n" +
       "Lazımi devDependencies (özünüz quraşdırın, layihənizin real versiyalarına uyğun):\n" +
       `  npm install --save-dev ${ESLINT_REACT_DEV_DEPS.join(" ")}\n`,
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commit-sheriff",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Shared husky commit-msg / pre-commit hooks enforcing ticket-based commit messages and branch naming",
   "main": "index.js",
   "bin": {

package/templates/commit-msg

@@ -21,7 +21,7 @@ eval "$(node -e "
   }
   const useModules = cfg.useModules !== undefined ? cfg.useModules : true;
   const modules = (cfg.modules && cfg.modules.length ? cfg.modules.join('|') : '[A-Z]+');
-  const types = (cfg.types || ['feat','feature','fix','docs','style','refactor','test','chore','perf','ci','build','revert']).join('|');
+  const types = (cfg.types || ['feat','fix','docs','style','refactor','test','chore','perf','ci','build','revert']).join('|');
   console.log('USE_MODULES=' + useModules);
   console.log('MODULES=\"' + modules + '\"');
   console.log('TYPES=\"' + types + '\"');