grunt-wrapper

    0.0.5 • Public • Published

    grunt-wrapper

    Wrap files

    Getting Started

    If you haven't used grunt before, be sure to check out the Getting Started guide.

    From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

    npm install grunt-wrapper --save-dev

    Once that's done, add this line to your project's Gruntfile:

    grunt.loadNpmTasks('grunt-wrapper');

    If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

    The "wrap" task

    Overview

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

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

    Options

    options.header

    Type: String

    Path to header file

    options.footer

    Type: String

    Path to footer file

    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({
      wrap: {
        options: {},
        files: {
          'dest/default_options': ['src/testing', 'src/123'],
        },
      },
    })

    Custom Options

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

    grunt.initConfig({
      wrap: {
        options: {
          separator: '',
          punctuation: ' !!!',
        },
        files: {
          'dest/default_options': ['src/testing', 'src/123'],
        },
      },
    })

    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

    none

    Install

    npm i grunt-wrapper

    DownloadsWeekly Downloads

    6

    Version

    0.0.5

    License

    none

    Last publish

    Collaborators

    • alexseville