https://github.com/danibram/translator-helper-dustjs
A little helper for dustjs to load your i18n translations in a dynamic way
https://github.com/danibram/translator-helper-dustjs
Last synced: 2 months ago
JSON representation
A little helper for dustjs to load your i18n translations in a dynamic way
- Host: GitHub
- URL: https://github.com/danibram/translator-helper-dustjs
- Owner: danibram
- Created: 2015-03-17T15:14:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-19T14:07:47.000Z (about 9 years ago)
- Last Synced: 2025-02-22T17:51:46.857Z (3 months ago)
- Language: JavaScript
- Homepage: https://github.com/danibram/translator-helper-dustjs
- Size: 5.86 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# translator-helper-dustjs [](https://david-dm.org/danibram/translator-helper-dustjs)
A little helper for dustjs to load i18n translations dynamically, with variables, based on https://github.com/mikesparr/Kraken_Example_i18n_Helper. Feel free to comment, copy or burn this code =P
### New version supporting kraken 2. Check the 1.x for kraken 1 and 2.x for kraken 2.
## Getting Started
Install the module with: `npm install translator-helper-dustjs`
Its important to add a global variable to pass the kraken config to the module, i put in my index.js this after load kraken config
```javascript
/* ... */
app = module.exports = express();
app.use(kraken(options));
global._app = app;
/* ... */
```
##### KrakenJs 2
```javascript
/* ... */
//In your config file, using tag 2.x
"dust": {
"helpers": [
"dust-makara-helpers",
"translator-helper-dustjs"
]
},
/* ... */
```
##### KrakenJs 1
```javascript
/* ... */
// On your controllers file or wethever you load dust, add the helper like another, using tag 1.x
var dust = require('dustjs-linkedin');
require('dustjs-helpers');
require('translator-helper-dustjs');
/* ... */
```
## Examples
On your properties files (index.properties)
```javascript
/* ... */
jobs.acme.title=Company Acme
jobs.hernes.title=Company Hernes
/* ... */
```
On your dust template files, pass to the t helper the key (jobs.acme.title -> companyName = "acme"), the properties file (index in this case), and the lang (in my case "EN_us")
```javascript
/* ... */
{@t key="jobs.{companyName}.title" bundle="index" lang="{lang}" /}
/* ... */
```
And the result will be
```javascript
/* ... */
Company Acme
/* ... */
```
## Contributing
Please fell free to contribute, i´m not a real expert of dustJs
## Release History
###(2.x)
- Supporting krakenJs 2
###(1.x)
- Supporting krakenJs 1
## License
Copyright (c) 2015 Daniel Biedma Ramos
Licensed under the MIT license.