Skip to content

Latest commit

 

History

History
99 lines (79 loc) · 2.7 KB

README.md

File metadata and controls

99 lines (79 loc) · 2.7 KB
Raw

grunt-poeditor-gd

Call POEditor's APIs, upload & download from a grunt task.

Getting Started

First, check out POEditor if you don't know what it is.

npm install grunt-poeditor-gd --save-dev

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

grunt.loadNpmTasks('grunt-poeditor-gd');

or using the very convenient load-grunt-tasks utility.

Usage

This a non-tested plugin, use at your own risk. On the other, it's only a convenient plugin, just take care of the downloaded exports.

Example

grunt.initConfig({
  poeditor: {
    target1: {
      command: { // POEditor's API args
        action: 'list_languages',
        id: '9999'
      }
    },
    target2: {
      upload: { // special case for uploads
        id: '<%= poeditor.options.project_id %>',
        updating: 'terms_definitions',
        overwrite: 1, // set any POE's API option
        sync_terms: 1,
        intervalSecs: 5 // interval between uploads
        // (to avoid "Too many upload in a short period of time" API error)
      }
    },
    target3: {
      download: {
        project_id: '<%= poeditor.options.project_id %>',
        type: 'po', // export type (check out the doc)
        filters: ["proofread", "translated"], // https://poeditor.com/api_reference/#export
        tags: ["myTag", "myOtherTag"], // https://poeditor.com/api_reference/#export
        dest: '<%= conf.front %>/locale/?/LC_MESSAGES/django.po'
        // grunt style dest files
      }
    },
    options: {
      project_id: '1234',
      // matching POEditor's language codes with yours
      // applies to uploads & downloads
      languages: {
        'en-us': 'en',
        'es': 'es',
        'es-ar': 'es_AR',
        'fr': 'fr'
      },
      api_token: '[your API token here]'
    }
  },
});

Options

command

An object specifying the API command. Check out the doc : https://poeditor.com/api_reference/.

upload

Check out the doc, at the Upload command. https://poeditor.com/api_reference/#upload

download

Check out the doc too, at the Export command. https://poeditor.com/api_reference/#export Export type = po, pot, mo, xls, apple_strings, android_strings, resx, resw, properties, or 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

  • 0.1.9 added export settings support
  • 0.1.7~8 added upload feature
  • 0.1.0~6 initial (non-tested) releases

License

MIT License, see LICENSE-MIT for details.