Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinedied/gettext-extract
:speech_balloon: CLI for extracting Gettext messages from JavaScript, TypeScript, JSX and HTML
https://github.com/sinedied/gettext-extract
cli extract gettext html i18n jsx l10n messages pot translation typescript
Last synced: 2 months ago
JSON representation
:speech_balloon: CLI for extracting Gettext messages from JavaScript, TypeScript, JSX and HTML
- Host: GitHub
- URL: https://github.com/sinedied/gettext-extract
- Owner: sinedied
- License: mit
- Created: 2017-11-21T08:37:48.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-08T23:46:09.000Z (over 2 years ago)
- Last Synced: 2024-10-15T06:03:47.909Z (3 months ago)
- Topics: cli, extract, gettext, html, i18n, jsx, l10n, messages, pot, translation, typescript
- Language: JavaScript
- Homepage:
- Size: 159 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# :speech_balloon: gettext-extract
[](https://www.npmjs.com/package/gettext-extract)
[](https://travis-ci.org/sinedied/gettext-extract)
[](https://github.com/sindresorhus/xo)
[](LICENSE)
> CLI for extracting Gettext messages from JavaScript, TypeScript, JSX and HTML
This CLI is essentially a convenience wrapper around
[gettext-extractor](https://github.com/lukasgeiter/gettext-extractor), all the processing is done by this library.
## Installation
```sh
npm install gettext-extract
```
## Usage
```
Usage: gettext-extract [options]
Options:
-c, --config Config file [default: .gettext.json]
-o, --output Output file [default: template.pot]
-h, --help Show this help
```
## Configuration
Configuration for message extraction can be provided using a `.gettext.json` file, a custom JSON file using the
`--config` CLI option or by adding a `gettext` object in your `package.json`.
Here is an example configuration (remove comments for valid JSON):
```hson
{
"js": {
"parsers": [
{
"expression": "gettext",
"arguments": {
"text": 0
}
},
{
"expression": "ngettext",
"arguments": {
"text": 0,
"textPlural": 1
}
},
{
"expression": "pgettext",
"arguments": {
"context": 0,
"text": 1
}
}
],
"glob": {
// [node-glob pattern(https://github.com/isaacs/node-glob#glob-primer) to match your JS files
"pattern": "src/**/*.ts",
// Add any [node-glob options](https://github.com/isaacs/node-glob#options) here
"options": {
"ignore": "src/**/*.spec.ts"
}
}
},
"html": {
"parsers": [
{
// Extract message from content of the HTML element with the specified CSS selector
"element": "[translate]",
"attributes": {
"textPlural": "translate-plural",
"context": "translate-context"
}
},
{
// Extract message from attribute of the HTML element
"attribute": "translate-text",
"attributes": {
"textPlural": "translate-plural",
"context": "translate-context"
}
}
],
"glob": {
"pattern": "src/**/*.html"
}
},
//
"headers": {
"Language": ""
},
"output": "translations/template.pot"
}
```
At least one valid parser (JS or HTML) with glob pattern must be present, everything else is optional.
You can fin additional information concerning the
[JavaScript / TypeScript / JSX](https://github.com/lukasgeiter/gettext-extractor/wiki/JavaScript%2C-TypeScript%2C-JSX)
or [HTML](https://github.com/lukasgeiter/gettext-extractor/wiki/HTML) parsers on the `gettext-extractor` wiki.