grunt-gettext-twig-parser
A grunt task that parses i18n twig strings and creates a PHP file with all the calls readable by the grunt-pot task.
Getting Started
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 @dreamproduction/grunt-gettext-twig-parser --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('@dreamproduction/grunt-gettext-twig-parser');
The "gettext_twig_parser" task
Overview
In your project's Gruntfile, add a section named gettext_twig_parser
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
gettext_twig_parser: {
custom_options: {
options: {
textdomain: 'bar',
add_textdomain: true
},
files: {
'tmp/gettext_twig_parser_output.php': [ '**/*.twig', '!node_modules/**' ]
}
}
}
});
Options
options.textdomain
Type: String|null
Default value: null
A string value that matches your text domain.
options.add_textdomain
Type: Bool
Default value: true
A boolean value that specifies if the text domain should be appended to the output file.
Usage Examples
Default Options
In this example, the default options are used to generate the PHP file. So if the test.twig
file has the content {{ __('foo', 'bar') }}
, the generated result would be __( 'foo', 'bar' );
in the gettext_twig_parser_test.php
file.
grunt.initConfig({
gettext_twig_parser: {
default_options: {
options: {
textdomain: 'bar',
add_textdomain: true
},
files: {
'tmp/gettext_twig_parser_test.php': ['test/fixtures/test.twig', 'test/fixtures/test.php']
}
}
}
});
Null Text Domain Options
In this example, the default options are used to generate the PHP file. So if the test.twig
file has the content {{ __('foo', 'bar') }}
and {{__("bar", "foo")}}
, the generated result would be __( 'foo', 'bar' );
and __( 'bar', 'foo' );
in the gettext_twig_parser_test_null_textdomain.php
file.
grunt.initConfig({
gettext_twig_parser: {
null_textdomain: {
options: {
textdomain: null,
add_textdomain: true
},
files: {
'tmp/gettext_twig_parser_test_null_textdomain.php': ['test/fixtures/test.twig', 'test/fixtures/test_null_textdomain.php']
}
}
}
});
No Text Domain Options
In this example, the default options are used to generate the PHP file. So if the test.twig
file has the content {{ __('foo', 'bar') }}
, the generated result would be __( 'foo' );
in the gettext_twig_parser_test_no_textdomain.php
file.
grunt.initConfig({
gettext_twig_parser: {
no_textdomain: {
options: {
textdomain: 'bar',
add_textdomain: false
},
files: {
'tmp/gettext_twig_parser_test_no_textdomain.php': ['test/fixtures/test.twig', 'test/fixtures/test_no_textdomain.php']
}
}
}
});
Example To Use With Grunt Pot
This example will create a new task pot-twig
which will clean the temporary directory, parse the twig files and generate the PHP file, genearate the pot
file and then clean the temporary directory again.
grunt.initConfig({
// ...
clean: {
tests: ['src/tmp']
},
gettext_twig_parser: {
default_options: {
options: {
textdomain: 'bar',
add_textdomain: true
},
files: {
'src/tmp/gettext_twig_parser_output.php': [ '**/*.twig', '!node_modules/**' ]
}
}
},
pot: {
options: {
// ...
},
files: {
// ...
src: [ '**/*.php' ] // Make sure to include the PHP file generated from the twig files ('src/tmp/gettext_twig_parser_output.php').
// ...
}
}
// ...
});
// ...
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('@dreamproduction/grunt-gettext-twig-parser');
grunt.loadNpmTasks('grunt-pot');
// ...
grunt.registerTask('pot-twig', ['clean', 'gettext_twig_parser', 'pot', 'clean']);
// ...
Supported Translation Functions
- __()
- _x()
- _n()
- _nx()
- nnoop()
- nxnoop()
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.