gettext-extractor-vue

Extend gettext-extractor with the possibility to parse .vue single file components.

Usage: Adding Vue SFC Support with decorateJSParserWithVueSupport

Support for Vue single file components (SFC) is provided by a decorating the JSExtractor of gettext-extractor. The Single File Components will be transformed to JavaScript and fed into JSExtractor. Both vue@2 (via vue-template-compiler) and vue@3 (via @vue/compiler-sfc) are supported.

Below you can see an example, derived from gettext-extractor's README.

1const { GettextExtractor, JsExtractors } = require('gettext-extractor');
2const { decorateJSParserWithVueSupport } = require('gettext-extractor-vue');
3
4const extractor = new GettextExtractor();
5
6const jsParser = extractor.createJsParser([
7  JsExtractors.callExpression('getText', {
8    arguments: {
9      text: 0,
10      context: 1,
11    },
12  }),
13  JsExtractors.callExpression('getPlural', {
14    arguments: {
15      text: 1,
16      textPlural: 2,
17      context: 3,
18    },
19  }),
20]);
21
22let vueParser;
23
24// For vue@2 support please provide vue-template-compiler via `vue2TemplateCompiler`
25vueParser = decorateJSParserWithVueSupport(jsParser, {
26  vue2TemplateCompiler: require('vue-template-compiler'),
27});
28// For vue@3 support please provide @vue/compiler-sfc via `vue3TemplateCompiler`
29vueParser = decorateJSParserWithVueSupport(jsParser, {
30  vue3TemplateCompiler: require('@vue/compiler-sfc'),
31});
32
33vueParser.parseFilesGlob('./src/**/*.@(js|vue)');
34
35extractor.savePotFile('./messages.pot');
36
37extractor.printStats();

Usage: Transforming messages with decorateExtractorWithHelpers

decorateExtractorWithHelpers enables to you to add message transform functions to the extractor.

For example:

1const { GettextExtractor, JSExtractor } = require('gettext-extractor');
2const { decorateExtractorWithHelpers } = require('gettext-extractor-vue');
3
4const extractor = decorateExtractorWithHelpers(new GettextExtractor());
5
6// Ensure that every message has leading and trailing spaces removed
7extractor.addMessageTransformFunction((message) => message.trim());