grunt-po2json-simple

Convert i18n PO format to JSON files

Getting Started

This plugin requires Grunt ~0.4.4

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

1npm install grunt-po2json-simple --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

1grunt.loadNpmTasks('grunt-po2json-simple');

The "po2json" task

Overview

In your project's Gruntfile, add a section named po2json to the data object passed into grunt.initConfig().

1grunt.initConfig({
2	po2json: {
3		options: {
4			// Task-specific options go here.
5		},
6		your_target: {
7			// Target-specific file lists and/or options go here.
8		}
9	}
10});

Options

options.format

Type: String Values: 'module' | 'json' Default value: 'module'

Format of source file

options.original

Type: String Default value: 'en'

Original language

options.path

Type: String Default value: 'LC_MESSAGES'

Optional path within locale directory

options.filename

Type: String Default value: 'messages.po'

Filename of result file

options.template

Type: Function Default value: null

Template source files with a custom function.

Usage Examples

Default Options

In this example, the default options are used to convert PO file to JS module.

1grunt.initConfig({
2	po2json: {
3		options: {},
4		files: {
5			'path/to/result/json': 'path/to/directory-with-po'
6		}
7	}
8});

Custom Options

In this example, result will be saved in JSON format.

1grunt.initConfig({
2	po2json: {
3		options: {
4			format  : 'json',
5			original: 'ru',
6			path    : 'LCCC',
7			filename: 'locale.po',
8			template: function (data, file) {
9				return 'define(function() {\n' +
10					'\treturn ' + data + ';\n' +
11				'});\n';
12			}
13		},
14		files: {
15			'path/to/result/json': 'path/to/directory-with-po'
16		}
17	}
18});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)