grunt-include-source

grunt-include-source

Include your sources into your HTML files automatically. Also supports including Bower components that expose their source files via the sources property in the bower.json file.

Getting Started

This plugin requires Grunt ~0.4.4

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 --save-dev grunt-include-source

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

grunt.loadNpmTasks('grunt-include-source');

The "includeSource" task

Overview

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

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

Options

options.basePath

Type: String Default value: ''

The base path to use when expanding files.

options.baseUrl

Type: String Default value: ''

The base URL to use for included files in the final result. For example, setting baseUrl to public/ will result in files being included from public/path/to/your/file.

options.templates

Type: Object

The templates for sources included in html, haml, scss, less files. Definition of single template overrides its default equivalent only.

Example:

includeSource: {
  options: {
    basePath: 'app',
    baseUrl: 'public/',
    templates: {
      html: {
        js: '<script src="{filePath}"></script>',
        css: '<link rel="stylesheet" type="text/css" href="{filePath}" />',
      },
      haml: {
        js: '%script{src: "{filePath}"}/',
        css: '%link{href: "{filePath}", rel: "stylesheet"}/'
      },
      scss: {
        scss: '@import "{filePath}";',
        css: '@import "{filePath}";',
      },
      less: {
        less: '@import "{filePath}";',
        css: '@import "{filePath}";',
      }
    }
  },
  myTarget: {
    files: {
      'dist/index.html': 'app/index.tpl.html'
    }
  }
}

As it was mentioned above, it is possible to override only necessary templates.

Include syntax

Currently supported: html, haml, scss and less

HTML syntax

<!-- include: options_go_here_as_json -->

SCSS and LESS syntax

// include: options_go_here_as_json

include.type

The type of files that are being included. Necessary for choosing the template for output. See options.templates for currently supported types. Supported types are dependend on the file type you include them from.

include.bower

DEPRECATED: Use another Grunt plugin which is better suited for this usecase, like grunt-bower-install. This plugin doesn't support the main property for example and is mainly used for development purposes to directly include external sources.

Include files of the specified Bower component. The component should have a bower.json meta data with a property called sources. This property should contain the files grouped by type, which are passed through the grunt.file.expand method.

Example:

{
  "name": "package.name",
  ...
  "sources": {
    "js": [
      "src/scripts/**/*.js",
      "lib/compiled-templates.js"
    ],
    "css": "src/styles/**/*.css"
  }
}

include.files

Include the given files. Files are passed through the grunt.file.expand method.

include.basePath

Set to override the basePath set in the options.

include.baseUrl

Set to override the baseUrl set in the options.

include.ordering

Type: String Default value: undefined

Ordering method to be used when including files. Currently supported methods are:

• undefined (default) - included files are sorted by their paths alphabetically in ascending order.
• 'top-down' - files from the parent directory will be included before files from subdirectories.

Usage Examples

Configure your task like this:

grunt.initConfig({
  includeSource: {
    options: {
      basePath: 'app',
      baseUrl: 'public/'
    },
    myTarget: {
      files: {
        'dist/index.html': 'app/index.tpl.html'
      }
    }
  }
})

The file index.tpl.html could contain, for example:

<!doctype html>
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
        <title>Index</title>
        <meta name="description" content="">
        <meta name="viewport" content="width=device-width">

        <!-- 
          Automatically include Bower components. Use the "sources" object in your bower.json
          to specify which source files are which.
        -->
        <!-- include: "type": "css", "bower": "yourComponent" -->
        
        <!--
          Include CSS files from a "tmp" directory, put there by another task.
          This shows how to override the default "basePath" set in the options.
        -->
        <!-- include: "type": "css", "basePath": "tmp", "files": "styles/**/*.css" -->
    </head>
    <body>
        <!-- include: "type": "js", "bower": "yourComponent" -->
        <!-- include: "type": "js", "files": "scripts/**/*.js" -->
    </body>
</html>

And the resulting file index.html will look something like:

<!doctype html>
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
        <title>Index</title>
        <meta name="description" content="">
        <meta name="viewport" content="width=device-width">

        <!-- 
          Automatically include Bower components. Use the "sources" object in your bower.json
          to specify which source files are which.
        -->
        <!-- include: "type": "css", "bower": "yourComponent" -->
        
        <!--
          Include CSS files from a "tmp" directory, put there by another task.
          This shows how to override the default "basePath" set in the options.
        -->
        <link href="public/styles/main.css" rel="stylesheet" type="text/css" />
        <link href="public/styles/anotherFile.css" rel="stylesheet" type="text/css" />
    </head>
    <body>
        <script src="public/bower_components/yourComponent/main.js"></script>
        <script src="public/scripts/app.js"></script>
        <script src="public/scripts/anotherFile.js"></script>
        <script src="public/scripts/controllers/evenMore.js"></script>
    </body>
</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

2014-04-27 ver. 0.3.7

• DEPRECATED: Bower support, see readme.
• support for HAML (see https://github.com/jwvdiermen/grunt-include-source/pull/17)
• tags generated for HTML now use HTML5 syntax by default.
• added basic tests
• updated dependencies.

2014-04-18 ver. 0.3.6

• added support for include.ordering option.
• added automated indentation for included entries (see https://github.com/jwvdiermen/grunt-include-source/issues/14)