i18n-smell-detector 0.4.0 → 0.4.2

package/README.md

@@ -4,10 +4,12 @@
 [![CI](https://github.com/xue-moe/i18n-smell-detector/actions/workflows/ci.yml/badge.svg)](https://github.com/xue-moe/i18n-smell-detector/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-Find locale values copied from the base locale.
+Find localization issues that key coverage checks miss.
 
 `i18n-smell-detector` checks localization files for keys whose translated value is identical to the base locale. It can also scan Vue templates for hardcoded user-visible strings.
 
+Current scope: `check-hardcoded` scans Vue templates only; JavaScript, TypeScript, and JSX strings are not scanned yet. Text classification is rule-based and conservative, so projects with many proper nouns, product codes, or non-English copy should start with `--fail-on none` and tune allowlists before enforcing CI.
+
 ## Features
 
 - Detect values that are identical to the base locale
@@ -70,7 +72,7 @@ For a new project, it is often easier to start in reporting mode while tuning al
 npx i18n-smell-detector check --config i18n-smell.config.mjs --fail-on none
 ```
 
-### GitHub Actions example
+### CI report artifact
 
 Add a workflow such as `.github/workflows/i18n-smell.yml`:
 
@@ -109,15 +111,6 @@ jobs:
           path: reports/i18n-smell.md
 ```
 
-For this repository, the local smoke commands are:
-
-```bash
-npm test
-npm run check
-npm run example:basic
-node bin/i18n-smell-detector.js --help
-```
-
 ## Configuration
 
 Create `i18n-smell.config.mjs`:
@@ -314,7 +307,7 @@ JSON output includes source locations:
 }
 ```
 
-## Running All Checks
+## Running all checks
 
 Use `check` to run every enabled check in one command:
 
@@ -355,7 +348,7 @@ Combined JSON output groups counts by check:
 }
 ```
 
-## Writing Reports
+## Writing reports
 
 Use `--output` to write the full report to a file. The CLI prints a short summary to stdout after writing.
 
@@ -366,7 +359,7 @@ npx i18n-smell-detector check --format json --output reports/i18n-report.json
 
 Markdown output for `check` includes a summary table and one section per check, which makes it suitable for CI artifacts.
 
-## Gradual Adoption
+## Gradual adoption
 
 Use a baseline to ignore existing findings while still failing CI for new ones:
 
@@ -448,7 +441,7 @@ Useful tuning patterns:
 
 ## Limitations
 
-`check-hardcoded` currently scans Vue templates only. JavaScript, TypeScript, and JSX string detection are not included yet.
+`check-hardcoded` currently scans Vue templates only. JavaScript, TypeScript, and JSX string detection are not included yet. Classification uses heuristic rules rather than full language detection.
 
 ## Notes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18n-smell-detector",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Find locale values copied from the base locale.",
   "type": "module",
   "bin": {
@@ -25,6 +25,10 @@
     "check:identical": "node ./bin/i18n-smell-detector.js check-identical --config ./examples/vue-vite/i18n-smell.config.mjs --fail-on none",
     "check:hardcoded": "node ./bin/i18n-smell-detector.js check-hardcoded --config ./examples/vue-vite/i18n-smell.config.mjs --fail-on none",
     "example:basic": "node ./bin/i18n-smell-detector.js check --config ./examples/basic/i18n-smell.config.mjs --fail-on none",
+    "audit": "npm audit --audit-level=moderate",
+    "check:package": "node ./scripts/check-package.js",
+    "release": "semantic-release",
+    "release:dry-run": "semantic-release --dry-run",
     "test": "node --test"
   },
   "keywords": [
@@ -42,5 +46,10 @@
     "@vue/compiler-dom": "^3.5.39",
     "@vue/compiler-sfc": "^3.5.39",
     "fast-glob": "^3.3.3"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "semantic-release": "^25.0.5"
   }
 }

package/src/reporters/markdown.js

@@ -1,7 +1,7 @@
 import { summarizeIssues } from './summary.js';
 
 function escapeCell(value) {
-  return String(value).replace(/\|/g, '\\|').replace(/\n/g, '<br>');
+  return String(value).replace(/\\/g, '\\\\').replace(/\|/g, '\\|').replace(/\n/g, '<br>');
 }
 
 export function renderMarkdownReport(issues, options) {

package/src/rules/classify-hardcoded.js

@@ -20,7 +20,7 @@ function isNonUserFacing(value) {
 }
 
 function latinWords(value) {
-  return value.match(/[A-Za-z][A-Za-z']*/g) || [];
+  return value.match(/[\p{L}\p{M}][\p{L}\p{M}']*/gu) || [];
 }
 
 function isShortCommonLabel(value) {

package/src/rules/classify-identical.js

@@ -32,7 +32,7 @@ function isPlaceholderOnly(value, patterns) {
 }
 
 function getLatinWords(value) {
-  return value.match(/[A-Za-z][A-Za-z']*/g) || [];
+  return value.match(/[\p{L}\p{M}][\p{L}\p{M}']*/gu) || [];
 }
 
 function languageFamily(locale) {