grunt-particles-linker

grunt-particles-linker

Autoinsert script tags (or other filebased tags) in an template file

Getting Started

This plugin requires Grunt ~0.4.x

When the task is run the destination file(s) is updated with script tags pointing to all the source files. The reason this plugin was built was to automate the process of inserting script tags when building large web apps.

npm install grunt-particles-linker --save-dev

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

grunt.loadNpmTasks('grunt-particles-linker');

The "particles-linker" task

Overview

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

grunt.initConfig({
  'particles-linker': {
    defaultOptions: {
      options: {
        startTag: '<!--SCRIPTS-->',
        endTag: '<!--SCRIPTS END-->',
        fileTmpl: '<script src="%s"></script>',
        appRoot: 'app/'
      },
      files: {
        // Target-specific file lists and/or options go here.
        'app/index.html': ['app/scripts/**/*.js']
      },
    },
  },
})

Options

options.startTag

Type: String Default value: '<!--SCRIPTS-->'

Script tags are places between the startTag and endTag

options.endTag

Type: String Default value: '<!--SCRIPTS END-->'

Script tags are places between the startTag and endTag

options.fileTmpl

Type: String Default value: '<script src="%s"></script>'

The template used to insert the reference to the script files.

options.appRoot

Type: String Default value: ''

The root of the application. Script links are relative from this folder.

options.publicUrlRoot

Type: String Default value: ''

When inserted into the template, the scripts will be prepended with this value