grunt-my-first-plugin

    0.1.1 • Public • Published

    grunt-my-first-plugin

    The best Grunt plugin ever.

    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-my-first-plugin --save-dev

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

    grunt.loadNpmTasks('grunt-my-first-plugin');

    The "my_first_plugin" task

    Overview

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

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

    Options

    options.copyText

    Type: String Default value: ``

    A text wich will be inserted right before </body>.

    Usage Examples

    Default Options

    In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

    grunt.initConfig({
      my_first_plugin: {
        main: {
          options: {
            copyText: 'Copyright: My first grunt plugin'
          },
          files: {
            'tmp/index.html': 'test/index.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.

    Release History

    (Nothing yet)

    Keywords

    Install

    npm i grunt-my-first-plugin

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    none

    Unpacked Size

    8.93 kB

    Total Files

    12

    Last publish

    Collaborators

    • vitalijpetras