Gets translations from a GlotPress installation
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-glotpress --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-glotpress');
In your project's Gruntfile, add a section named glotpress_download
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
glotpress_download: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Type: String
Default value: languages
The folder where all downloaded files will be stored
Type: String
Default value: false
The url of the GlotPress installation (required).
Type: String
Default value: false
The slug is the path in the GlotPress installation which can also be main-folder/sub-folder (required).
Type: String
Default value: false
The textdomain that is used for WordPress. This is needed for the files. If not set, it will fallback to the slug.
Type: String
Default value: %domainPath%/%textdomain%-%wp_locale%.%format%
The structure how the file is being stored. Is based on previous settings but you could create your own format. For now only those four values and short locale can be used. You could however save the files in different folders if you move a placeholder.
Type: Array
Default value: ['po','mo']
The file formats that will be downloaded for each translation set.
Type: object
Default value: {translation_sets: false, minimum_percentage: 30, waiting_strings: false}
You can filter which files you want to have. By default it only checks the minimum percentage translation sets need to be translated. The other parameters still need to be implemented.
In this example, the default options are used to download all translations sets from a project.
grunt.initConfig({
glotpress_download: {
core: {
options: {
domainPath: 'languages',
url: 'https://wp-translate.org',
slug: 'tabify-edit-screen',
textdomain: 'tabify-edit-screen',
}
},
},
});
In this example, we add our own file format like for a theme. By default the format is set for plugins which do include the textdomain.
grunt.initConfig({
glotpress_download: {
core: {
options: {
domainPath: 'languages',
url: 'https://wp-translate.org',
slug: 'cool-theme',
textdomain: 'cool-theme',
file_format: '%domainPath%/%wp_locale%.%format%',
}
},
},
});
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.
- 0.2.2 - Add CWD support.
- 0.2.1 - Fix broken download of translation files.
- 0.2.0 - Complete rewrite of the codebase. Add ability to include waiting strings. Fallback to locale if wp_locale doesn't exists. Fixes encoding issue where downloadeded files didn't work. Further coding style fixes.
- 0.1.1 - Fix dependency and downloading issues.
- 0.1.0 - Initial Release.