Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 2.66 KB

README.md

File metadata and controls

110 lines (83 loc) · 2.66 KB
Raw

grunt-i18n-combinator

Combine SimpleSchema i18n files for each schema

Getting Started

This plugin requires Grunt ~0.4.5

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:

npm install grunt-i18n-combinator --save-dev

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

grunt.loadNpmTasks('grunt-i18n-combinator');

The "i18n_combinator" task

Overview

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

grunt.initConfig({
  i18n_combinator: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.outputSuffix

Type: String Default value: ''

Only Work if multiple == true. Set output file suffix A string value that is used to do something with whatever.

options.outputPrefix

Type: String Default value: ''

Only Work if multiple == true. Set output file prefix A string value that is used to do something with whatever.

options.multiple

Type: Boolean Default value: false

If you want a single file set to 'false' A string value that is used to do something with whatever.

options.jsonFile

Type: String Default value: i18n_combined.json

If you want a single file here is define the name of the output file A string value that is used to do something with whatever.

Usage Examples

Combinator

Allow to combine multiple JSON file based on this structure (see file test.json)

grunt.initConfig({
  i18n_combinator: {
    combinator: {
      options: {
        multiple: true,
        jsonFile: 'i18n_combined.json',
      },
      files: [
        { src: 'test/fixtures/json/*.json', dest: 'test/fixtures/output/' },
      ],
    },
  },
});

Mergator

Allow to merge JSON files

grunt.initConfig({
  i18n_combinator: {
    mergator: {
      files: [
        { src: 'test/fixtures/json/*.json', dest: 'test/fixtures/output/output.json' },
      ],
    },
  },
});

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)