i18n-smell-detector 0.9.1 → 0.9.3

package/README.md

@@ -5,9 +5,51 @@
 [![Socket Badge](https://badge.socket.dev/npm/package/i18n-smell-detector)](https://badge.socket.dev/npm/package/i18n-smell-detector)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
 
-Find localization issues that key coverage checks miss.
+## Catch localization bugs your i18n coverage reports can't see.
+
+`i18n-smell-detector` is an i18n linter that catches localization mistakes ordinary key-coverage checks miss:
+
+- copied base-locale values that were never translated;
+- missing, extra, or repeated placeholders;
+- hardcoded user-visible text in Vue, JavaScript, TypeScript, JSX, and TSX.
+
+<p align="center">
+  <img src="./assets/i18n-smell-demo.gif"
+       alt="i18n-smell-detector finding copied translations, placeholder mismatches, and hardcoded UI text"
+       width="900">
+</p>
+
+```json
+// locales/en.json
+{
+  "checkout.pay": "Pay now",
+  "cart.items": "{{count}} items"
+}
+```
+
+```json
+// locales/ja.json
+{
+  "checkout.pay": "Pay now",
+  "cart.items": "商品"
+}
+```
+
+```Vue
+<button>Delete account</button>
+```
 
-`i18n-smell-detector` checks locale files for copied base-locale values and placeholder mismatches. It can also scan Vue, JavaScript, TypeScript, JSX, and TSX source for hardcoded user-visible strings.
+The project has every translation key, but it still ships three localization problems.
+
+`i18n-smell-detector` reports them before your users do.
+
+## Try it
+
+```bash
+npm install -D i18n-smell-detector
+npx i18n-smell-detector init
+npx i18n-smell-detector check --fail-on none
+```
 
 The classifier is deterministic and conservative. Start with `--fail-on none`, review the report, then tune allowlists before enforcing CI.
 
@@ -20,17 +62,10 @@ The classifier is deterministic and conservative. Start with `--fail-on none`, r
 - Support baselines for gradual adoption.
 - Publish TypeScript types and a small public API for integrations.
 
-## Install
-
-```bash
-npm install -D i18n-smell-detector
-```
-
-## Quick Start
+## Configuration
 
-```bash
+``` bash
 npx i18n-smell-detector init
-npx i18n-smell-detector check --config i18n-smell.config.mjs --fail-on none
 ```
 
 `init` creates `i18n-smell.config.mjs`. When it finds locale JSON files in `src/locales`, `src/i18n`, `locales`, or `i18n`, it writes them into the config automatically.
@@ -54,6 +89,7 @@ Locale keys that contain `-`, such as `'zh-Hans'`, must be quoted.
 
 With `ignoreSameLanguageFamily` enabled, locale tags are compared by language, inferred script, and explicitly declared region. Different scripts are checked normally, two different explicit regions are reported at low severity, and otherwise matching language and script are ignored. The last case includes comparisons where one or both locale tags do not explicitly declare a region.
 
+
 ## Commands
 
 ```bash
@@ -156,9 +192,8 @@ import type { DetectorConfigInput, DetectorIssue, CheckResult } from 'i18n-smell
 
 ## Documentation
 
-Full documentation lives in the GitHub Wiki:
+See the GitHub [Wiki](https://github.com/xue-moe/i18n-smell-detector/wiki) for:
 
-- [Home](https://github.com/xue-moe/i18n-smell-detector/wiki)
 - [Getting started](https://github.com/xue-moe/i18n-smell-detector/wiki/Getting-Started)
 - [Commands](https://github.com/xue-moe/i18n-smell-detector/wiki/Commands)
 - [Configuration](https://github.com/xue-moe/i18n-smell-detector/wiki/Configuration)

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "i18n-smell-detector",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "Find copied locale values, placeholder mismatches, and hardcoded user-visible strings.",
   "type": "module",
   "bin": {
-    "i18n-smell-detector": "./bin/i18n-smell-detector.js"
+    "i18n-smell-detector": "bin/i18n-smell-detector.js"
   },
   "types": "./dist/index.d.ts",
   "exports": {
@@ -33,7 +33,8 @@
     "check:identical": "npm run build --silent && node ./bin/i18n-smell-detector.js check-identical --config ./examples/vue-vite/i18n-smell.config.mjs --fail-on none",
     "check:hardcoded": "npm run build --silent && node ./bin/i18n-smell-detector.js check-hardcoded --config ./examples/vue-vite/i18n-smell.config.mjs --fail-on none",
     "example:basic": "npm run build --silent && node ./bin/i18n-smell-detector.js check --config ./examples/basic/i18n-smell.config.mjs --fail-on none",
-    "audit": "npm audit --audit-level=moderate",
+    "audit": "npm audit --omit=dev --audit-level=moderate",
+    "audit:all": "npm audit --audit-level=moderate",
     "benchmark": "npm run build --silent && tsx ./scripts/benchmark.ts",
     "check:package": "tsx ./scripts/check-package.ts",
     "format:check": "prettier --check \"**/*.{ts,js,json,md,yml}\"",
@@ -57,8 +58,8 @@
   },
   "dependencies": {
     "@babel/parser": "^7.29.7",
-    "@vue/compiler-dom": "^3.5.39",
-    "@vue/compiler-sfc": "^3.5.39",
+    "@vue/compiler-dom": "^3.5.44",
+    "@vue/compiler-sfc": "^3.5.44",
     "commander": "^12.1.0",
     "fast-glob": "^3.3.3"
   },
@@ -69,7 +70,7 @@
     "@types/node": "^18.19.130",
     "@types/vscode": "^1.125.0",
     "prettier": "^3.9.5",
-    "semantic-release": "^25.0.5",
+    "semantic-release": "^25.0.9",
     "tsx": "^4.23.0",
     "typescript": "^7.0.2"
   }