i18next-scanner
Advanced tools
i18next-scanner is a transfrom stream that can scan your code, extract translation keys/values, and merge them into i18n resource files.
i18next-scanner is a transfrom stream that can scan your code, extract translation keys/values, and merge them into i18n resource files.
It's available as both Gulp and Grunt plugins.
npm install --save-dev i18next-scanner
The main entry function of i18next-scanner is a transform stream. You can use vinyl-fs to create a readable stream, pipe the stream through i18next-scanner to transform your code into an i18n resource object, and write to a destination folder. Here is a simple example showing how that works:
var i18next = require('i18next-scanner');
var vfs = require('vinyl-fs');
vfs.src(['path/to/src'])
.pipe(i18next())
.pipe(vfs.dest('path/to/dest');
Now you are ready to set up a minimal configuration, and get started with Gulp. For example:
var gulp = require('gulp');
var i18next = require('i18next-scanner');
gulp.task('i18next', function() {
return gulp.src(['src/**/*.{js,html}'])
.pipe(i18next({
// a list of supported languages
lngs: ['en', 'de'],
// the source path is relative to current working directory
resGetPath: 'assets/i18n/__lng__/__ns__.json',
// the destination path is relative to your `gulp.dest()` path
resSetPath: 'i18n/__lng__/__ns__.json'
})
.pipe(gulp.dest('assets'));
});
Once you've finished the installation, add this line to your project's Gruntfile:
grunt.loadNpmTasks('i18next-scanner');
In your project's Gruntfile, add a section named i18next to the data object passed into grunt.initConfig(), like so:
grunt.initConfig({
i18next: {
dev: {
src: 'src/**/*.{js,html}',
dest: 'assets',
options: {
lngs: ['en', 'de'],
resGetPath: 'assets/i18n/__lng__/__ns__.json',
resSetPath: 'i18n/__lng__/__ns__.json'
}
}
}
});
As mentioned in the Usage section, the main entry function returns a through2 object stream, you can pass in your transform and flush functions:
i18next(options[, customTransform[, customFlush]])
You might want to find all occurrences of the i18n._() function in your code.
For example:
i18n._('This is text value');
i18n._("text");
i18n._('text');
i18n._("text", { count: 1 });
i18n._("text" + str); // skip run-time variables
The content can be parsed with a regular expression, like below:
i18n\._\(("[^"]*"|'[^']*')\s*[\,\)]
The code might look like this:
var _ = require('lodash');
var hash = require('i18next-text').hash['sha1'];
var customTransform = function(file, enc, done) {
var parser = this.parser;
var extname = path.extname(file.path);
var content = fs.readFileSync(file.path, enc);
(function() {
var results = content.match(/i18n\._\(("[^"]*"|'[^']*')\s*[\,\)]/igm) || '';
_.each(results, function(result) {
var key, value;
var r = result.match(/i18n\._\(("[^"]*"|'[^']*')/);
if (r) {
value = _.trim(r[1], '\'"');
key = hash(value); // returns a hash value as its default key
parser.parse(key, value);
}
});
}());
done();
};
i18n function helper
{{i18n 'bar'}}
{{i18n 'bar' defaultKey='foo'}}
{{i18n 'baz' defaultKey='locale:foo'}}
{{i18n defaultKey='noval'}}
Using the regular expression for the above:
{{i18n\s+("(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*')?([^}]*)}}
i18n block helper
{{#i18n}}Some text{{/i18n}}
{{#i18n this}}Description: {{description}}{{/i18n}}
{{#i18n this last-name=lastname}}{{firstname}} ${last-name}{{/i18n}}
Using the regular expression for the above:
{{#i18n\s*([^}]*)}}((?:(?!{{\/i18n}})(?:.|\n))*){{\/i18n}}
Sample code
The sample code might look like this:
var _ = require('lodash');
var hash = require('i18next-text').hash['sha1'];
var customTransform = function(file, enc, done) {
var parser = this.parser;
var extname = path.extname(file.path);
var content = fs.readFileSync(file.path, enc);
// i18n function helper
(function() {
var results = content.match(/{{i18n\s+("(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*')?([^}]*)}}/gm) || [];
_.each(results, function(result) {
var key, value;
var r = result.match(/{{i18n\s+("(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*')?([^}]*)}}/m) || [];
if ( ! _.isUndefined(r[1])) {
value = _.trim(r[1], '\'"');
}
var params = parser.parseHashArguments(r[2]);
if (_.has(params, 'defaultKey')) {
key = params['defaultKey'];
}
if (_.isUndefined(key) && _.isUndefined(value)) {
return;
}
if (_.isUndefined(key)) {
key = hash(value); // returns a hash value as its default key
}
parser.parse(key, value);
});
}());
// i18n block helper
(function() {
var results = content.match(/{{#i18n\s*([^}]*)}}((?:(?!{{\/i18n}})(?:.|\n))*){{\/i18n}}/gm) || [];
_.each(results, function(result) {
var key, value;
var r = result.match(/{{#i18n\s*([^}]*)}}((?:(?!{{\/i18n}})(?:.|\n))*){{\/i18n}}/m) || [];
if ( ! _.isUndefined(r[2])) {
value = _.trim(r[2], '\'"');
}
if (_.isUndefined(value)) {
return;
}
key = hash(value); // returns a hash value as its default key
parser.parse(key, value);
});
}());
done();
};
function(options[, customTransform[, customFlush]])
{
debug: false,
sort: false,
lngs: ['en'],
defaultValue: '',
resGetPath: 'i18n/__lng__/__ns__.json',
resSetPath: 'i18n/__lng__/__ns__.json',
nsseparator: ':',
keyseparator: '.',
interpolationPrefix: '__',
interpolationSuffix: '__',
ns: {
namespaces: [],
defaultNs: 'translation'
}
}
Type: Boolean Default: false
Set to true to trun on debug output.
Type: Boolean Default: false
Set to true if you want to sort translation keys in ascending order.
Type: Array Default: ['en']
Provides a list of supported languages.
Type: String Default: ''
Provides a default value if a value is not specified.
Type: String Default: 'i18n/__lng__/__ns__.json'
The source path of resource files. The resGetPath is relative to current working directory.
Type: String Default: 'i18n/__lng__/__ns__.json'
The target path of resource files. The resSetPath is relative to current working directory or your gulp.dest() path.
Type: String Default: ':'
The namespace separator.
Type: String Default: '.'
The key separator.
Type: String Default: '__'
The prefix for variables.
Type: String Default: '__'
The suffix for variables.
Type: Object or String
If an Object is supplied, you can either specify a list of namespaces, or override the default namespace.
For example:
{
ns: {
namespaces: [ // Default: []
'resource',
'locale'
],
defaultNs: 'resource' // Default: 'translation'
}
}
If a String is supplied instead, it will become the default namespace.
For example:
{
ns: 'resource' // Default: 'translation'
}
The optional customTransform function is provided as the 2nd argument. It must have the following signature: function (file, encoding, done) {}. A minimal implementation should call the done() function to indicate that the transformation is done, even if that transformation means discarding the file.
For example:
var customTransform = function _transform(file, enc, done) {
var parser = this.parser;
var extname = path.extname(file.path);
var content = fs.readFileSync(file.path, enc);
// add custom code
done();
};
To parse a translation key, call parser.parse(key, defaultValue) to assign the key with an optional defaultValue.
For example:
var _ = require('lodash');
var customTransform = function _transform(file, enc, done) {
var parser = this.parser;
var content = fs.readFileSync(file.path, enc);
var results = [];
// parse the content and loop over the results
_.each(results, function(result) {
var key = result.key;
var value = result.defaultValue || '';
parser.parse(key, value);
});
};
Alternatively, you may call parser.parse(defaultKey, value) to assign the value with a default key. The defaultKey should be unique string and can never be null, undefined, or empty.
For example:
var _ = require('lodash');
var hash = require('i18next-text').hash['sha1'];
var customTransform = function _transform(file, enc, done) {
var parser = this.parser;
var content = fs.readFileSync(file.path, enc);
var results = [];
// parse the content and loop over the results
_.each(results, function(result) {
var key = result.defaultKey || hash(result.value);
var value = result.value;
parser.parse(key, value);
});
};
The optional customFlush function is provided as the last argument, it is called just prior to the stream ending. You can implement your customFlush function to override the default flush function. When everything's done, call the done() function to indicate the stream is finished.
For example:
var _ = require('lodash');
var customFlush = function _flush(done) {
var that = this;
var resStore = parser.toObject({
sort: !!parser.options.sort
});
// loop over the resStore
_.each(resStore, function(namespaces, lng) {
_.each(namespaces, function(obj, ns) {
// add custom code
});
});
done();
};
Copyright (c) 2015 Cheton Wu
Licensed under the MIT License.
FAQs
Scan your code, extract translation keys/values, and merge them into i18n resource files.
The npm package i18next-scanner receives a total of 84,098 weekly downloads. As such, i18next-scanner popularity was classified as popular.
We found that i18next-scanner demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.