npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-po-json

v0.2.0

Published

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

Downloads

203

Readme

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.