Giter Club home page Giter Club logo

grunt-po-json's Introduction

grunt-po-json

As of 0.2.0, this task gives a warning and aborts when it does not find a specified translation file. This behavior can be overridden with --force.

Converts one or more po files to a single json or amd module.

Getting Started

This plugin requires Grunt ~0.4.2

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-po-json --save-dev

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

grunt.loadNpmTasks('grunt-po-json');

The "po_json" task

Overview

In your project's Gruntfile, add a section named po_json to the data object passed into grunt.initConfig(). You must specify a target in which you can add options and files.

grunt.initConfig({
  po_json: {
    target: {
      files: {
        'path/to/dest.json': 'path/to/src.po'
      }
    },
    targetMultiple: {
      options : {
        amd: true
      },
      files: {
        'path/to/dest2.js': {
          'src2': 'path/to/src2.json',
          'src3': 'path/to/src3.json'
        }
      }
    }
  },
});

Options

options.amd

Type: Boolean Default value: false

Wraps the result in a define( ); call so you can use it as an amd module. You probably want your dest path to end with .js instead of .json.

options.useMsgctxtAsKey

Type: Boolean Default value: false

Matches msgctxt and msgstr instead of msgid and msgstr.

Files

files[property]

Type String|Object

Each property of the files object can be a string path to a .po file, or an object of properties with string paths to .po files. In case of an object, the output file will have the output of each .po file under their respective property names.

Usage Examples

Default Options

This example processes two .po files and puts them in two separate .json files.

grunt.initConfig({
  po_json: {
    target: {
      files: {
        'path/to/dest1.json': 'path/to/src1.po'
        'path/to/dest2.json': 'path/to/src2.po'
      }
    },
  },
});

Custom Options

This example processes two .po files and puts them in a single .js file. It also turns it in an (anonymous) amd module. When used, the conversion results are accessible via obj.src1 and obj.src2.

grunt.initConfig({
  po_json: {
    options: {
      amd: true
    },
    target: {
      files: {
        'path/to/dest.js': {
          'src1': 'path/to/src1.po',
          'src2': 'path/to/src2.po'
        }
      }
    }
  },
});

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.

grunt-po-json's People

Contributors

nickyout avatar vhi-di avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

grunt-po-json's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.