grunt-html-smoosher

grunt-html-smoosher

A grunt task which takes a html file, finds all the css and js links, and outputs a version with all the css and js written inline for ease of pasting into a cms

Getting Started

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-html-smoosher --save-dev

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

grunt.loadNpmTasks('grunt-html-smoosher');

The "smoosher" task

Overview

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

grunt.initConfig({
  smoosher: {
    options: {
      jsTags: { // optional
        start: '<script type="text/javascript">', // default: <script>
        end: '</script>'                          // default: </script>
      },
    },
    all: {
      files: {
        'dest-index.html': 'source-index.html',
      },
    },
  },
});

Options

Script Minification

Minify scripts with UglifyJS.

grunt.initConfig({
  smoosher: {
    all: {
      options: {
        minify: true
      },
      files: {
        'dest-index.html': 'source-index.html',
      },
    },
  },
});

Path config

When you have absolute paths for your external assets, it helps to add the local address of your asset files; relative to uncompiled HTML file.

grunt.initConfig({
  smoosher: {
    all: {
      options: {
        jsDir: "../",
        cssDir: "/Library/documents/sharedAssets/"
      },
      files: {
        'dest-index.html': 'source-index.html',
      },
    },
  },
});

Example

If the local cwd for your uncompiled file is /Library/documents/server/src/html then the above settings would resolve:

<script src="/assets/js/script.js" /> will use a local file at /Library/documents/server/src/js/script.js

<link href="/assets/css/styles.css" /> will use a local file at /Library/documents/sharedAssets/assets/css/styles.css

cssTags

Defaults to

{
  start: '<style>',
  end: '</style>'
}

jsTags

Defaults to

{
  start: '<script>',
  end: '</script>'
}

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.