grunt-bom-removal

A Byte Order Mark (BOM) removal task for grunt.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
grunt-bom-removal
1.0.18 years ago11 years agoMinified + gzip package size for grunt-bom-removal in KB

Readme

grunt-bom-removal
A Byte Order Mark removal task for grunt.

WARNING

As a note it does a direct rewrite of the file, just without the BOM, please make sure you have tested grunt-bom-removal before using it any code, just in case for some reason it decides to eat your code for lunch.

Getting Started

This plugin requires Grunt ~1.0.0
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-bom-removal --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-bom-removal');

This plugin was designed to work with Grunt 1.0.x. If you're still using an older version it's strongly recommended that you upgrade.

BOM task

Run this task with the grunt bom command.
Task targets, files and options may be specified according to the grunt Configuring tasks
guide.

Options

printMissed

Type: Boolean
Default: false
This allows to print in log missed files without BOM.

Usage Examples

There are three formats you can use to run this task.

Short

bom: ["path/to/file/one.txt", "path/to/file/two.js"]

Medium (specific targets with global options)

bom: {
  build: ["path/to/file/one.txt", "path/to/file/two.txt"],
  release: ["path/to/another/file/one.js", "path/to/another/file/two.js"]
},

Long (specific targets with per target options)

bom: {
  build: {
    src: ["path/to/file/one.txt", "path/to/file/two.txt"]
  }
}

License

Copyright (c) 2013 Andrey Zaytsev Licensed under the MIT license.