Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smhg/gettext-handlebars
Extract translatable strings from Handlebars template strings
https://github.com/smhg/gettext-handlebars
Last synced: about 2 months ago
JSON representation
Extract translatable strings from Handlebars template strings
- Host: GitHub
- URL: https://github.com/smhg/gettext-handlebars
- Owner: smhg
- License: mit
- Created: 2014-08-19T15:38:35.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T08:31:35.000Z (about 2 years ago)
- Last Synced: 2024-11-11T19:13:35.601Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 416 KB
- Stars: 8
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gettext-handlebars 
Extract translatable strings from [Handlebars](http://handlebarsjs.com/) template strings.
It can be used stand-alone or through [xgettext-template](https://github.com/gmarty/xgettext).
### API
#### new Parser(keywordSpec)
Creates a new parser.
The `keywordSpec` parameter is optional, with the default being:
```javascript
{
_: {
msgid: 0
},
gettext: {
msgid: 0
},
dgettext: {
msgid: 1
},
dcgettext: {
msgid: 1
},
ngettext: {
msgid: 0,
msgid_plural: 1
},
dngettext: {
msgid: 1,
msgid_plural: 2
},
pgettext: {
msgctxt: 0,
msgid: 1
},
dpgettext: {
msgctxt: 1,
msgid: 2
}
}
```
Each keyword (key) requires an object with argument positions. The `msgid` position is required. `msgid_plural` and `msgctxt` are optional.
For example `gettext: {msgid: 0}` indicates that the Handlebars expression looks like `{{gettext "string"}}`.
#### .parse(template)
Parses the `template` string for Handlebars expressions using the keywordspec.
It returns an object with this structure:
```javascript
{
msgid1: {
line: [1, 3]
},
msgid2: {
line: [2],
plural: 'msgid_plural'
},
context\u0004msgid2: {
line: [4]
}
}
```
### Development
#### Install
```shell
git clone [email protected]:smhg/gettext-handlebars.git
npm i
```
#### Test
```shell
npm run lint
npm test
```