i18n-validate

i18n-validate

A cli tool to find invalid i18n keys, missing variables and many more.

Features

• Written In Typescript
• Offers CLI and API
• Full TypeScript & JavaScript support
• Framework agnostic
• Supports Pluralization
• Fully customizable

Usage

npx i18n-validate

Usage: i18n-validate [options] <file ...>

Options:
  -V, --version           output the version number
  -c, --config <config>   Path to the config file (default:
                          "./i18n-validate.json")
  --log-level <logLevel>  Log level (default: "info")
  --exclude <exclude...>  Exclude files from parsing (default:
                          "**/node_modules/**")
  --exit-on-error         Exit immediately if an error is found (default:
                          false)
  -h, --help              display help for command

  Examples:

    $ i18next-validate "/path/to/src/app.js"
    $ i18next-validate --config i18n-validate-custom.json 'src/**/*.{js,jsx}'
    $ i18next-validate --exclude "**/node_modules/**" "src/**/*.{js,jsx}"

You can disable the i18n-validate for a specific line by adding // i18n-validate-disable-next-line before the line.

Note: Currently, i18n-validate only supports ts, tsx, js and jsx source files and json translation files.

Use with lint-staged

{
	"lint-staged": {
		"*.{js,jsx,ts,tsx}": ["i18n-validate"]
	}
}

Configuration

You can customize the behavior of i18n-validate by adding a i18n-validate.json file to the root of your project.

{
	"$schema": "https://raw.githubusercontent.com/imranbarbhuiya/i18n-validate/main/.github/i18n-validate.schema.json"
}

Note: You can also use js, cjs or mjs file and with any name you want. Just make sure to pass the path of the config file to i18n-validate using --config option.

Buy me some doughnuts

If you want to support me by donating, you can do so by using any of the following methods. Thank you very much in advance!

Contributors ✨

Thanks goes to these wonderful people: