grunt-readme/Gruntfile.js

Grunt plugin for generating a README from templates, including an optional table of contents. No Gruntfile config is necessary, just choose a starter template and you'll be ready to go.

/*
 * grunt-readme
 * https://github.com/assemble/grunt-readme
 *
 * Copyright (c) 2013 Jon Schlinkert, contributors
 * Licensed under the MIT license.
 */

'use strict';

module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    jshint: {
      options: {
        curly: true,
        eqeqeq: true,
        immed: true,
        latedef: true,
        newcap: true,
        noarg: true,
        sub: true,
        undef: true,
        boss: true,
        eqnull: true,
        node: true
      },
      all: ['Gruntfile.js', 'tasks/*.js', '<%= nodeunit.tests %>']
    },

    // Unit tests.
    nodeunit: {
      tests: ['test/*_test.js'],
    },

    // Pull down a list of repos from Github.
    repos: {
      helpers: {
        options: {
          path: '/orgs/helpers/',
          namespace: 'helpers'
        },
        files: {
          'test/fixtures/data/helpers.json': ['repos?page=1&per_page=100']
        }
      },
      assemble: {
        options: {
          path: '/orgs/assemble/'
        },
        files: {
          'test/fixtures/data/assemble.json': ['repos?page=1&per_page=100']
        }
      }
    },

    readme: {
      options: {
        alt: {
          src: ['docs/DOCS.tmpl.md', 'docs/EXAMPLES.tmpl.md'],
          dest: './'
        },
        // This is only for tests! For most projects, the readme task doesn't even
        // need to be defined in the Gruntfile, and zero configuration is required.
        // metadata: ['test/fixtures/data/assemble.json', 'test/fixtures/data/helpers.json'],
        // test: {
        //   src: ['test/fixtures/*.(tmpl.md,md)', 'templates/**/*.{tmpl.md,md}'],
        //   dest: 'test/actual/'
        // }
      }
    }

  });

  // Actually load this plugin's task(s).
  grunt.loadTasks('tasks');

  // These plugins provide necessary tasks.
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-contrib-nodeunit');

  // Run this task, then test the results.
  grunt.registerTask('test', ['readme', 'nodeunit']);

  // By default, lint and run all tests.
  grunt.registerTask('default', ['jshint', 'readme']);

};