Giter VIP home page Giter VIP logo

grunt-pocreate's Introduction

PoCreate

Add missing keys to .po files from JavaScript

Getting Started

This plugin requires Grunt.

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 pocreate --save-dev

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

grunt.loadNpmTasks('pocreate');

The "pocreate" task

PoCreate lets you maintain your .po files by adding new keys to them after they've already been created.

Often you'll create your .po files, make changes to them (either by annotating them or by sending them to translators), and then want add new keys without regenerating the file completely and losing changes.

PoCreate simplifies this process by adding keys only where they don't exist.

Overview

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

grunt.initConfig({
  pocreate: {
    src: ['path/to/js/files/*.js'],
    options: {
      pos: ['path/to/po/files/*.po'],
      add_comments: '/',
      keyword: ['tr', 'translate']
    }
  },
})

Options

options.pos (Required)

Type: Array

An array of .po files to add translation keys to. These files will be updated with new keys found in the source files if the keys don't already exist.

options.add_comments

Type: String Default value: '/'

A string that is used to scan for contextual comments for translators. This character must be the first character after a double slash comment. For insance, this is an example with the default value.

/// This is a contextual comment
gettext('Key');

options.keyword

Type: Array

An array of translation function keywords to scan the source files for.

The default value is ["gettext"].

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

  • 0.1.0: Initial release

License

Copyright (c) 2014 Paul LeMarquand. Licensed under the MIT license.

grunt-pocreate's People

Contributors

plemarquand avatar

Watchers

 avatar  avatar

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.