grunt-doctype

Minimal effort DOCTYPE transformation with grunt.

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-doctype --save-dev

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

grunt.loadNpmTasks('grunt-doctype');

The "doctype" task

Overview

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

grunt.initConfig({
  doctype: {
    options: {
      selector: '/<!DOCTYPE[^>[]*(\[[^]]*\])?>/i'
      transform: function (input) {
        return `<!${input[1].toLowerCase()} HTML>`;
      }
    },
    all: {
      files: {
        'dest-index.html': 'source-index.html',
      },
    },
  },
});

Options

selector

Defaults to /<!(DOCTYPE)([^>]*?)>/i.

grunt.initConfig({
  doctype: {
    all: {
      options: {
        selector: '/<!DOCTYPE[^>[]*(\[[^]]*\])?>/i'
      },
      files: {
        'dest-index.html': 'source-index.html',
      },
    },
  },
});

transform

Defaults to:

function (input) {
  return input[0].toLowerCase();
}

grunt.initConfig({
  doctype: {
    all: {
      options: {
        transform: function (input) {
          return `<!${input[1].toLowerCase()} HTML>`;
        }
      },
      files: {
        'dest-index.html': 'source-index.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

• See CHANGELOG.md for release history