https://github.com/getsentry/babel-gettext-extractor
A fork of babel-gettext-plugin that works with older versions of node and supports comment and location extraction
https://github.com/getsentry/babel-gettext-extractor
tag-production
Last synced: 3 months ago
JSON representation
A fork of babel-gettext-plugin that works with older versions of node and supports comment and location extraction
- Host: GitHub
- URL: https://github.com/getsentry/babel-gettext-extractor
- Owner: getsentry
- License: mit
- Created: 2015-11-19T11:06:47.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T21:48:50.000Z (almost 2 years ago)
- Last Synced: 2025-03-22T06:47:06.197Z (3 months ago)
- Topics: tag-production
- Language: JavaScript
- Homepage:
- Size: 229 KB
- Stars: 43
- Watchers: 57
- Forks: 22
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/getsentry/babel-gettext-extractor)
[](https://www.npmjs.com/package/babel-gettext-extractor)
# babel-gettext-extractor
Extract gettext string with babel support syntax JSX, ES6, ... It is based on
node-gettext. This is a fork of the npm module `babel-gettext-plugin` which
adds support for references and runs on earlier versions of node.
Supports babel 7.
Install
========
`yarn add babel-gettext-extractor`
or
`npm install --save babel-gettext-extractor`
Node use
========
```js
var babel = require("babel");
babel.transform(code, { plugins:["babel-gettext-extractor"]});
```
Command line use
================
```
babel --plugins babel-gettext-extractor code.js
```
Options
=======
```js
"plugins": [
[ "babel-gettext-extractor", {
"headers": ,
"functionNames": ,
"fileName": ,
"baseDirectory": ,
"stripTemplateLiteralIndent":
}]
]
```
### headers ###
The headers to put in the po file.
```js
headers: {
"content-type": "text/plain; charset=UTF-8",
"plural-forms": "nplurals=2; plural=(n!=1);"
}
```
### functionNames ###
A list of function names to extract. The list is the definition of the
parameters: `"domain"`, `"msgctxt"`, `"msgid"`, `"msgid_plural"` and
`"count"`
example:
```js
functionNames: {
myfunction: ["msgid"]
}
```
### fileName ###
The filename where the end result is placed. If you supply a function, it will receive the current file babel is working
on and you can return the full path to where you want to save your translation template for this particular file.
example:
```javascript
[
require("babel-gettext-extractor"),
{
fileName: (file) => {
const sourceFile = file.opts.sourceFileName;
if (/^node_modules\//.test(sourceFile)) {
return false;
}
return sourceFile
.split(/[\/\\.]/)
.filter(name => !['src', 'packages', 'js'].includes(name))
.slice(0, 2)
.join('-') + '-template.pot';
},
},
]
```
### baseDirectory ###
If provided, then file names are chopped off in relation to this base path
if filenames start with that path.
### stripTemplateLiteralIndent ###
If true this will strip leading indents from multiline strings. Note: this
requires gettext function implementations to do the same leading indent removal.
Useful if you want to use Template literals for multiline strings to be passed
into to gettext functions.
License
=======
[MIT License](LICENSE).