koa-adam-locale

Simple Multi Language Middleware for Koa.

Installation

1$ npm install koa-adam-locale

Example

app.js:

1var Path = require('path');
2var View = require('koa-views')
3var KAL = require('koa-adam-locale');
4var koa = require('koa');
5var app = koa();
6
7/* i18n */
8app.use(KAL({
9  path: Path.resolve(__dirname, 'i18n'),
10  // reference: require('./i18n_ref'),
11  cookieKey: 'current_lang',
12  cookies: {
13    maxAge: 365*24*60*60*1000,
14    domain: 'hello.com',
15    signed: false
16  },
17  default: 'en_US',
18  supported: [{code:'en_US', lang:'English'},{code:'zh_CN', lang:'简体中文'}]
19}, app));
20
21/* templating */
22app.use(View(__dirname + '/views', {
23  default: 'ejs'
24}));
25
26app.use(function * () {
27  if(!this.path == '/') return;
28  yield this.render('locale')
29})
30
31app.listen(process.argv[2])

i18n/en_US.json

1{
2  "hello": "hello",
3  "world": "world"
4}

views/locale.ejs

1<p><%= _i18n_.hello %>, <%= _i18n_.world %>.</p>
2<p>current:<%= _i18n_current_ %>.</p>
3<% for(var i in _i18n_supported_) { %>
4<a href='/set_locale?lang=<%= _i18n_supported_[i].code %>'>
5	switch to <%= _i18n_supported_[i].lang %>
6</a>
7<% } %>

Options

path {String}

The folder path of i18n files

reference {Object}

The reference of i18n Object, key of this reference should match the code, like 'zh_CN', 'en_US' (Case sensitive), and this parameter has a higher priority than path.

supported {Array}

The supported languages. default value: [{code:'en_US', lang:'English'},{code:'zh_CN', lang:'简体中文'}]

Example:

1app.use(KAL({
2  path: Path.resolve(__dirname, 'i18n'),
3  // reference: require('./i18n_ref'),
4  supported: [{code:'en_US', lang:'English'},{code:'zh_CN', lang:'简体中文'}]
5}, app));

namespace {String}

Custom template data params namespace. Default value is 'locals'

• koa-views 2.x - ctx.locals
• koa-views 3.x - ctx.state

Example:

1// for koa-views 3.x
2app.use(KAL({
3  path: Path.resolve(__dirname, 'i18n'),
4  // reference: require('./i18n_ref'),
5  supported: [{code:'en_US', lang:'English'},{code:'zh_CN', lang:'简体中文'}],
6  namespace: 'state'
7}, app));

cookieKey {String}

cookies {Object}

Store the selected language in the cookie. see koa cookie for more information.

Example:

1app.use(KAL({
2  path: Path.resolve(__dirname, 'i18n'),
3  cookies: {
4    domain: 'hello.com',
5    maxAge: 365*24*60*60*1000
6  }
7}, app));

default {String}

Default language

Example:

1app.use(KAL({
2  path: Path.resolve(__dirname, 'i18n'),
3  // reference: require('./i18n_ref'),
4  supported: [{code:'en_US', lang:'English'},{code:'zh_CN', lang:'简体中文'}],
5  default: 'en_US'
6}, app));
7

set_url {String}

The url to switch current language. default value: /set_locale

Example:

1app.use(KAL({
2  path: Path.resolve(__dirname, 'i18n'),
3  // reference: require('./i18n_ref'),
4  set_url: '/set_locale'
5}, app));
6

Then you can set current language by request url like this '/set_locale?lang=en_US'

Local Params

The following three params are set to ctx.namespace, default ctx.locals. For koa-views 3.x version, you can set namespace to ctx.state

• this.locals._i18n_ {Object}
• this.locals._i18n_current_ {String}
• this.locals._i18n_supported_ {Array}

static addLanguageHelper

添加dust模板的helper，用于展示语言名称

var dust = require('dustjs-helpers');
KAL.addLanguageHelper(dust)

在模板里使用@language

{@language code="ru_RU" current="zh_CN" /} // 输出"俄语"

{@language code="ru_RU" current="en_US" /} // 输出"Russian"

{@language code="ru_RU" /} // 根据系统设置的自动判断语言

Debug

Set the DEBUG environment variable to koa-adam-locale when starting your server.

1$ DEBUG=koa-adam-locale

License

MIT