grunt-qc-cdnify

0.1.1 • Public • Published

grunt-cdnify Build Status Dependency Status

Grunt plugin for rewriting static resource URLs found in your HTML and CSS.

What it does

The task looks through your specified files for URLs to rewrite, in the following places:

  • <img src="____">
  • <script src="____"></script>
  • <link rel="stylesheet" href="____">
  • background-image: url(____); in your CSS (including inside <style> tags in your HTML)

See options below for how it modifies them.

Options

You should set either base or rewriter (not both).

base

For the most common use case, just set a base string for your URLs – eg, '//cdn.example.com/'. The cdnify task will automatically search for all local URLs in your files, and prefix them with this string. (It will automatically avoid double-slashes.)

Example:

cdnify: {
  someTarget: {
    options: {
      base: '//cdn.example.com/stuff/'
    },
    files: [{
      expand: true,
      cwd: 'app',
      src: '**/*.{css,html}',
      dest: 'dist'
    }]
  }
}

rewriter

For more control, you can specify a custom rewriter function instead. In this case, the task will search for all URLs (not just local ones) and run your function on each one. Your function should return the new value.

Example:

cdnify: {
  someTarget: {
    options: {
      rewriter: function (url) {
        if (url.indexOf('data:') === 0)
          return url; // leave data URIs untouched
        else
          return url + '?12345'; // add query string to all other URLs
      }
    },
    files: [{
      expand: true,
      cwd: 'app',
      src: '**/*.{css,html}',
      dest: 'dist'
    }]
  }
}

css (boolean)

Whether to modify CSS. Applies to both *.css files and <style> elements. Default: true.

html (boolean/object)

Whether/how to modify HTML. Defaults to true, which will update HTML according to this standard config:

{
  'img[src]': 'src',
  'link[rel=stylesheet]': 'href',
  'script[src]': 'src',
  'video[poster]': 'poster',
  'source[src]': 'src'
}

That is, any elements matching the CSS selector img[src] will have their src attributes cdnified, etc.

To customise this config, you can set the html option to an object of custom selector:attribute pairs. These will be added to the standard set shown above – if you want to not use one of the standard pairs, you have to explicitly override it with false.

For example:

options: {
  html: {
    'img[ng-src]': 'ng-src', // cdnify angular images
    'script[src]': false // don't cdnify script tags
  }
}

Readme

Keywords

none

Package Sidebar

Install

npm i grunt-qc-cdnify

Weekly Downloads

1

Version

0.1.1

License

none

Last publish

Collaborators

  • vece