Registry / devops / vue-i18n-extract

vue-i18n-extract

library2.0.7jsnpmunverified

vue-i18n-extract is a development tool designed for managing `vue-i18n` localization within Vue.js projects through static code analysis. It scans Vue Single File Components (SFCs), JavaScript, and TypeScript files to identify used i18n keys and compares them against existing translation files (e.g., JSON, YAML). This helps developers find missing translations, identify unused keys that can be safely removed, and detect duplicate keys. The current stable version is 2.0.7, with an active release cadence, frequently incorporating new features and bug fixes as evidenced by recent patch releases. Its primary differentiation lies in its comprehensive static analysis approach for Vue-specific i18n usage, supporting various patterns like `$t`, `v-t`, and `Translation` components.

devops

npm install vue-i18n-extract

github ↗package ↗

INSTALL

IMPORT

SIG · VUE-I18N-EXTRACT

vue-i18n-extract

devopsjavascriptv2.0.7

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

extractI18n

✓ import { extractI18n } from 'vue-i18n-extract';

✗ const { extractI18n } = require('vue-i18n-extract');

For programmatic usage in a modern Node.js or TypeScript environment, prefer ES module imports. CommonJS `require` is generally discouraged since v2+.

readVueFiles

✓ import { readVueFiles } from 'vue-i18n-extract';

This utility function assists in reading Vue SFCs and JavaScript/TypeScript files, returning their content for analysis. It's typically used within custom scripts.

writeLocaleMessages

✓ import { writeLocaleMessages } from 'vue-i18n-extract';

Used programmatically to write updated locale messages back to translation files. Ensure file paths are correct and permissions allow writing.

This `package.json` excerpt demonstrates how to integrate `vue-i18n-extract` into a project using npm scripts for reporting, adding, and removing translation keys.

{ "name": "my-vue-i18n-app", "version": "1.0.0", "description": "My Vue.js i18n project", "main": "index.js", "scripts": { "i18n:report": "vue-i18n-extract report --vueFiles './src/**/*.?(js|ts|vue)' --languageFiles './src/locales/*.?(json|yml|yaml)' --ci", "i18n:add": "vue-i18n-extract report --vueFiles './src/**/*.?(js|ts|vue)' --languageFiles './src/locales/*.?(json|yml|yaml)' --add", "i18n:remove": "vue-i18n-extract report --vueFiles './src/**/*.?(js|ts|vue)' --languageFiles './src/locales/*.?(json|yml|yaml)' --remove" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "vue-i18n-extract": "^2.0.0" } }

vue-i18n-extract --version

Debug

Known issues

breakingUpgrading from `v1.x` to `v2.x` introduces significant breaking changes in configuration options. Several CLI arguments and config file properties have been renamed or removed.

fix

Review the official `vue-i18n-extract` documentation for v2.x to update `--vueFiles`, `--languageFiles`, and other options. Specifically, the `output` option was replaced by `dryRun` and `emit`.

affects: >=2.0.0

gotchaIncorrect glob patterns for `--vueFiles` or `--languageFiles` are a common cause of issues, leading to missing translations not being detected or files being ignored.

fix

Always test your glob patterns with a tool like `glob-tester` or `ls -l` combined with your pattern to ensure they correctly match the intended files. Pay close attention to file extensions and nested directory structures.

affects: >=1.0.0

gotchaWhen using `vue-i18n-extract` programmatically in an ES module (`'type': 'module'` in `package.json`) Node.js project, direct `require` statements for the library will fail with `SyntaxError: Unexpected token 'export'`.

fix

Ensure all imports are done using ES module syntax (e.g., `import { extractI18n } from 'vue-i18n-extract';`). If using older Node.js versions or CJS, configure a build step (like Babel or TypeScript compilation) to transpile imports.

affects: >=2.0.0

deprecatedThe underlying `vue-i18n` library has deprecated certain features like `$tc` and `tc` functions, especially for Composition API mode, and the `<i18n>` component in favor of `<i18n-t>`. While `vue-i18n-extract` aims to support various syntaxes, relying on deprecated `vue-i18n` features can lead to future compatibility issues.

fix

Migrate your `vue-i18n` usage to its latest recommended patterns, such as using `$t` or `t` for pluralization (with `n` parameter) and `<i18n-t>` components. Consult the `vue-i18n` migration guide for your specific version.

affects: >=2.0.0

Errors

Common errors & fixes

[vue-i18n-extract] Error: vueFiles glob has no files.

The glob pattern provided for `--vueFiles` (or in the config file) does not match any existing `.vue`, `.js`, or `.ts` files in your project. This often happens due to incorrect paths or typos in the pattern.

fix

Verify the `vueFiles` glob pattern in your command or configuration file. Use a tool like `ls -l './src/**/*.vue'` to confirm that files are matched by the pattern. Adjust the path or pattern as needed.

[vue-i18n-extract] Error: languageFiles glob has no files.

Similar to `vueFiles` not being found, this error indicates that the glob pattern for `--languageFiles` does not match any translation files (e.g., `.json`, `.yml`, `.yaml`) at the specified location.

fix

Check the `languageFiles` glob pattern. Ensure the path is correct and the file extensions (`.json`, `.yml`, `.yaml`) are included and properly escaped if necessary (e.g., `*.?(json|yml|yaml)`).

TypeError: Cannot read properties of undefined (reading 'extractI18n')

This typically occurs when attempting to use programmatic features (like `extractI18n`) in a CommonJS module context when the package is primarily designed for ES Modules, or when the named export is incorrect.

fix

For Node.js projects with `'type': 'module'`, use ES module imports: `import { extractI18n } from 'vue-i18n-extract';`. If sticking to CommonJS, check if a default export or different named exports are available, or use `await import('vue-i18n-extract')` for dynamic imports.

Upgrade

Version history

2.0.7latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/pixari/vue-i18n-extract ↗

packagehttps://www.npmjs.com/package/vue-i18n-extract ↗