Apply XSLT stylesheets to XML documents.
Getting Started
This plugin requires Grunt >=0.4.1
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-xsltproc --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "xsltproc" task
Overview
Run this task with the grunt xsltproc
command.
xsltproc
xsltproc is an open-source command line tool for applying XSLT stylesheets to XML documents.
This task requires you to have xsltproc
installed. If you're on OS X or Linux you probably already have it installed. You can check by running xsltproc -version
in your terminal.
Setup
First, ensure you have xsltproc
installed. Then, in your project's Gruntfile, add a section named xsltproc
to the data object passed into grunt.initConfig()
.
grunt
Options
options.stylesheet
Type: String
or false
Path to the XSLT stylesheet to apply to the files. If options.stylesheet
evaluates to false
, xsltproc
will fallback to stylesheets linked from the target document.
options.params
Type: Object
Pass an object of parameter name/value pairs to the stylesheet. Parameters are passed directly to the xsltproc
call with the --param
flag.
options.stringparams
Type: Object
Pass an object of string parameter name/value pairs to the stylesheet. Parameters are passed directly to the xsltproc
call with the --stringparam
flag.
options.xinclude
Type: Boolean
Process the input document using the XInclude specification. More details on this can be found in the XInclude specification.
options.xincludestyle
Type: Boolean
Process the stylesheet using the XInclude specification.
options.novalid
Type: Boolean
Process the input document skipping the DTD loading phase.
options.filepath
Type: Boolean
Pass the grunt filepath as stringparam to the XSLT.
options.html
Type: Boolean
The input document is(are) an HTML file(s).
Usage Examples
Single file
grunt
Directory of files
grunt
Passing parameters
grunt
Passing string parameters
grunt
XInclude
Process the input document using the XInclude specification.
grunt
Process the stylesheet using the XInclude specification.
grunt
filepath
Process the input documents and using the filepath xsl:param.
grunt
...
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
- 2016-02-22 v0.6.0 Update peerDependencies to support Grunt 1.0.
- 2015-03-21 v0.5.1 Setup Travis CI.
- 2015-01-19 v0.5.0 Fallback to inline stylesheets.
- 2014-11-10 v0.4.2 Add option to parse input as HTML.
- 2014-10-05 v0.4.1 Add option for passing the grunt filepath as stringparam.
- 2014-04-21 v0.4.0 Add option to use XIncludestyle.
- 2013-11-16 v0.3.0 Enable processing using the XInclude specification.
- 2013-10-26 v0.2.1 Add documentation for passing in parameters. Update
package.json
. - 2013-09-13 v0.2.0 Pass params to the stylesheet via the options object.
- 2013-09-08 v0.1.0 Initial release.