Grunt-pugpig-issues-xml NPM

grunt-pugpig-issues-xml

Generate issues XML file for PugPig.

In development

Todo:

More than one 'part' / src
Get partSrc dynamically from file
Tests
Usage Examples

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 grunt-pugpig-issues-xml --save-dev

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

grunt.loadNpmTasks('grunt-pugpig-issues-xml');

The "pugpig_issues_xml" task

Overview

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

grunt.initConfig({
  pugpig_issues_xml: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.root

Type: String Default value: 'content.xml'

A string value that is used to set the package root in the XML.

options.partName

Type: String Default value: 'all'

A string value that is used to set the part name root in the XML.

options.fileName

Type: String Default value: 'issues'

A string value that is used to set the XML file name.

options.dest

Type: String Default value: 'content.xml'

A string value that is used to set the destination for the XML file.

Usage Examples

Custom Options

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.