❤
npm
Sign UpSign In

grunt-format

1.1.2 • Public • Published

grunt-format

Formats Source with grunt

Getting Started

This plugin requires Grunt ~0.4.2

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

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

grunt.loadNpmTasks('grunt-format');

The "format" task

Overview

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

grunt.initConfig({
    format: {
        target: {
            src: ['example/*.js'],
            rules: [
                {
                    // Replaces '//a' with '// a'
                    match: new RegExp('//([a-bA-Z]{1})'),
                    replace: "// $1"
                }
            ]
        }
    },
});

Options

options.maxSize

Type: number Default value: 1

Maximum Filesize, in Megabyte.

options.rules

Type: IRule[] Default value: []

An array of rules to replace, i.e.

[
    {
        match: new RegExp(),
        replace: ""
    }
]

Usage Examples

Default Options

grunt.initConfig({
    format: {
        target: {
            src: ['example/*.js'],
            rules: [
                {
                    // Replaces '//a' with '// a'
                    match: new RegExp('//([a-bA-Z]{1})'),
                    replace: "// $1"
                }
            ]
        }
    },
});

Custom Options

grunt.initConfig({
    format: {
        target: {
            src: ['example/*.js'],
            rules: [
                {
                    // Replaces '//a' with '// a'
                    match: new RegExp('//([a-bA-Z]{1})'),
                    replace: "// $1"
                }
            ],
            options: {
                maxSize: 5
            }
        }
    },
});

Release History

1.1.2

Fixed critical bugs

1.1.1

Added Omitted Rules output

1.1.0

Files with Regex not matching are not rewritten

1.0.3

Modified Log output

1.0.2

Updated Dependencies

1.0.1

Moved rules from options to target, created Readme

1.0.0

Initial Release

Readme

Keywords

none

Package Sidebar

Install

npm i grunt-format

Weekly Downloads

0

Version

1.1.2

License

none

Last publish

Collaborators

  • beryju
Try on RunKit
Report malware