Home

i18n-smell-detector Wiki

i18n-smell-detector is a CI-friendly localization quality checker.

It helps catch issues that ordinary key coverage tools miss:

• Copied base-locale translations.
• Missing or extra placeholders.
• Hardcoded user-visible strings in Vue, JS, TS, JSX, and TSX files.

Start Here

• Getting Started
• Configuration
• Commands
• Checks
• Reports and CI
• Baseline
• Algorithms
• TypeScript API
• Integrations
• Performance
• Project Maturity
• Troubleshooting

Recommended Adoption Flow

1. Install the package.
2. Generate a starter config with init.
3. Run in reporting mode with --fail-on none.
4. Tune locale paths, source globs, and allowlists.
5. Add a baseline if the project already has known findings.
6. Enable CI failure with --fail-on high or --fail-on medium.

Current Scope

The detector is intentionally rule-based. It does not translate text and it does not verify key coverage. It reports suspicious localization quality patterns so teams can review and fix them.

Deeper Topics

• Use Algorithms to understand severity classification and false-positive tradeoffs.
• Use Integrations for ESLint, Prettier, VS Code, and pre-commit templates.
• Use Performance before changing scanner or parser behavior.
• Use TypeScript API when building custom integrations.