@i18n-audit/javascript
v0.1.0
Published
Framework-agnostic i18n audit CLI for JavaScript codebases
Maintainers
Readme
@i18n-audit/javascript
Framework-agnostic i18n audit CLI for JavaScript codebases.
Works for frontend and backend JS projects: React, Vue, Svelte, Next, Nuxt, Node APIs, jQuery apps, and mixed repos.
Features
- Configurable scan patterns from
.env - Configurable scan paths, lang paths, and excludes
- Configurable file extensions (empty means scan all files)
- Translation loading from JSON, YAML, and JS module files
- Nested key flattening
- Missing and unused key reporting per locale
- Dynamic key warnings
- Auto-populate missing keys with
{key}and{locale}placeholder template - JSON and clean Tailwind HTML reports
Install
npm install @i18n-audit/javascript --save-devUsage
npx i18n-audit-jsJSON output:
npx i18n-audit-js --format jsonGenerate HTML report:
npx i18n-audit-js --html --html-output var/i18n-audit-latest.htmlAuto-populate missing:
npx i18n-audit-js --fill-missing.env Configuration
All configuration is .env driven. See .env.example.
Example values:
I18N_AUDIT_SCAN_PATHS=src,app,components,views,templatesI18N_AUDIT_EXCLUDE_PATHS=node_modules,vendor,.git,dist,build,coverageI18N_AUDIT_SCAN_EXTENSIONS=js,jsx,mjs,cjs,ts,tsx,vue,svelte,html,phpI18N_AUDIT_SCAN_PATTERNS=t,i18n.t,$t,__,trans,gettextI18N_AUDIT_LANG_PATHS=locales,i18n,lang,translationsI18N_AUDIT_LOCALES=en,de,srI18N_AUDIT_AUTO_POPULATE_PLACEHOLDER=Missing translation: {key} for locale: {locale}
CLI Options
--env-file <path>--locales <csv>--paths <csv>--exclude <csv>--extensions <csv>--patterns <csv>--lang-paths <csv>--format table|json--output <path>--html--html-output <path>--fill-missing--fill-template <value>--fill-format json|yaml|js--fail-on-missing--fail-on-unused
