grunt-add-comment

grunt-add-comment

Prepend or append some comments to your autogenerated files

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 grunt-add-comment --save-dev

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

grunt.loadNpmTasks('grunt-add-comment');

The "add_comment" task

Overview

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

grunt.initConfig({
  add_comment: {
    options: {
      // Task-specific options go here.
    },
    files: [{
      // Target-specific options go here.
    }],
  },
});

Options

options.comments

Type: Array Default value: ['autogenerated']

comments to add.

options.prepend

Type: Boolean Default value: true

prepend comments : true | append comments : false

options.carriageReturn

Type: String Default value: "\n"

options.syntaxes

Type: Object Default value: {'*':'//'}

comment syntax for each extensions.

Usage Examples

Sample Options

grunt.initConfig({
  add_comment: {
    test: {
      options: {
        comments: ['this file is autogenerated', 'this file is autogenerated 2'],
        carriageReturn: "\n",
        prepend: true,
        syntaxes: {
          '.js': '//',
          '.sql': '--'
        }
      },
      files: [{
        expand: true,
        cwd: 'test/files/',
        src: ['**/*.js', '**/*.sql', '!**/*.json'],
        dest: 'test/files/'
      }]
    }
  },
});

Contributing