grunt-pugpig-contents-xml

grunt-pugpig-content-xml

Generate contents XML file for PugPig publications.

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-contents-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-contents-xml');

The "pugpig_contents_xml" task

Overview

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

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

Options

options.author

Type: String Default value: pkg.author.name

A string value that is used to do populate the app author in the XML feed.

Usage Examples

Default Options

grunt.initConfig({
  pugpig_contents_xml: {
    default_options: {
      options: {
        author: pkg.author.name,
        dest: 'tmp/',
        fileName: 'content'
      },
      src: [
        'demo/**/*.html'
      ]
    }
  },
})

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.

$ grunt test

Commit messages loosely adhere to these guidelines.

Versioning adheres to Semver.

Release History

• 2014-08-14 v0.1.0 - Initial release.

License

Copyright (c) 2014 Daniel Furze. Licensed under the MIT license: http://danielfurze.mit-license.org

TODO:

• Options documentation
• Tests
• Clean up 'xml version' output
• Clean up entry hack