# 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](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
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:

```js
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()`.

```js
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

```js
grunt.initConfig({
  add_comment: {
    test: {
      options: {
        comments: ['Autogenerated, do not edit. All changes will be undone.', new Date()],
        carriageReturn: "\n",
        prepend: true,
        syntaxes: {
          '.js': '//',
          '.json': '--',
          '.css': ['/*', '*/']
        }
      },
      files: [{
        expand: true,
        cwd: 'test/files/',
        src: ['**/*.js', '**/*.sql', '!**/*.json'],
        dest: 'test/files/'
      }]
    }
  },
});
```

## Contributing