{"id":15392376,"url":"https://github.com/activeguild/vite-plugin-i18n-validator","last_synced_at":"2026-05-07T13:37:54.162Z","repository":{"id":218692355,"uuid":"747070862","full_name":"activeguild/vite-plugin-i18n-validator","owner":"activeguild","description":"A Vite plugin validates Json files with internationalization support in worker thread","archived":false,"fork":false,"pushed_at":"2024-03-09T05:37:20.000Z","size":510,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-12T12:45:54.358Z","etag":null,"topics":["i18n","internationalization","json","locale","locales","valid","validator","vite","vite-plugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/activeguild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-23T07:53:39.000Z","updated_at":"2024-01-26T17:22:24.000Z","dependencies_parsed_at":"2024-10-18T23:09:44.414Z","dependency_job_id":null,"html_url":"https://github.com/activeguild/vite-plugin-i18n-validator","commit_stats":{"total_commits":90,"total_committers":1,"mean_commits":90.0,"dds":0.0,"last_synced_commit":"d8684c0ef24175e4897a7e77f74b8da89ea4893b"},"previous_names":["activeguild/vite-plugin-i18n-validator"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/activeguild/vite-plugin-i18n-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-i18n-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-i18n-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-i18n-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-i18n-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/activeguild","download_url":"https://codeload.github.com/activeguild/vite-plugin-i18n-validator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/activeguild%2Fvite-plugin-i18n-validator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266496399,"owners_count":23938711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["i18n","internationalization","json","locale","locales","valid","validator","vite","vite-plugin"],"created_at":"2024-10-01T15:14:41.892Z","updated_at":"2026-05-07T13:37:49.123Z","avatar_url":"https://github.com/activeguild.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com/actions/setup-node\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/activeguild/vite-plugin-i18n-validator/workflows/release/badge.svg\" style=\"max-width:100%;\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# vite-plugin-i18n-validator\n\nA Vite plugin validates Json files with internationalization support in worker thread.\n\n- Compare with the base language file to verify the presence of key and value.\n- _Optional:_ Use [textlint](https://github.com/textlint/textlint) to proofread values.\n\n## Motivation\n\n- We want to reduce obstacles caused by forgotten key settings by supporting multiple languages.\n- We want to reduce obstacles such as shaky notation.\n- I want to use correct grammar to provide easier-to-understand text to users.\n\n## Install\n\n```bash\nnpm i -D vite-plugin-i18n-validator\n```\n\n## Options\n\n- You can set an object or an array.\n\n| Parameter          | Type                                                | Description                                   |\n| ------------------ | --------------------------------------------------- | --------------------------------------------- |\n| enabledBuild       | boolean                                             | Enable checks at build time. (default: false) |\n| baseLocaleFilePath | string                                              | Set the path of the file to be compared.      |\n| include            | string \\| RegExp \\| Array\u003cstring \\| RegExp\u003e         | Set the target path.                          |\n| exclude            | string \\| RegExp \\| Array\u003cstring \\| RegExp\u003e         | Set the paths you want to exclude.            |\n| ignoreKeys         | RegExp \\| Array\u003cRegExp\u003e                             | Set key not to validate.                      |\n| prohibitedKeys     | string[]                                            | Set prohibited keys.                          |\n| prohibitedValues   | string[]                                            | Set prohibited values.                        |\n| textlint           | true \\| {CreateLinterOptions,LoadTextlintrcOptions} | https://github.com/textlint/textlint          |\n\n## Usage\n\n[vite.config.ts]\n\n```ts\nimport { defineConfig } from \"vite\";\nimport i18nValidator from \"vite-plugin-i18n-validator\";\nimport path from \"path\";\n\n// https://vitejs.dev/config/\nexport default defineConfig({\n  plugins: [\n    i18nValidator([\n      {\n        enabledBuild: true,\n        include: [\"src/locales/*.json\"],\n        baseLocaleFilePath: path.resolve(__dirname, \"src/locales/ja.json\"),\n        prohibitedValues: [\"public\"],\n        textlint: true,\n      },\n      {\n        include: [\"src/locales2/*.json\"],\n        baseLocaleFilePath: path.resolve(__dirname, \"src/locales/ja.json\"),\n        ignoreKeys: /(foo\\.todo2)+/i,\n      },\n    ]),\n  ],\n});\n```\n\n- Compare files in `baseLocaleFilePath` when files set to `include` are saved.\n\n```bash\nnpm run dev\n```\n\n- Compare all files set in `include` with those in `baseLocaleFilePath`.\n\n```base\nnpm run build\n```\n\n- When a file is updated or built, the following messages are output.\n\n```bash\n2:05:34 [vite] src/locales/ja.json:5:14: Found TODO: 'todo:hoge\"'\n2:05:34 [vite] src/locales/ja.json:7:15: Found TODO: 'todo:hoge\"'\n2:05:49 [vite] src/locales/en.json: Not found: 'foo.zoo'\n2:05:49 [vite] src/locales/en.json: Not found: 'foo.todo'\n2:05:49 [vite] src/locales/en.json: Not found: 'foo.todo2'\n2:05:49 [vite] src/locales/en.json: Not found: 'foo.todo3'\n```\n\n- If proofreading is required, install the `textlint` library.\n\n## Principles of conduct\n\nPlease see [the principles of conduct](https://github.com/activeguild/vite-plugin-i18n-validator/blob/master/.github/CONTRIBUTING.md) when building a site.\n\n## License\n\nThis library is licensed under the [MIT license](https://github.com/activeguild/vite-plugin-i18n-validator/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiveguild%2Fvite-plugin-i18n-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factiveguild%2Fvite-plugin-i18n-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factiveguild%2Fvite-plugin-i18n-validator/lists"}