grunt-size

The best Grunt plugin ever.

grunt-size

The best Grunt plugin ever.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Gruntbefore, be sure to check out the Getting Startedguide, as it explains how to create a Gruntfileas 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-size --save-dev

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

grunt.loadNpmTasks('grunt-size');

The "size" task

Overview

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

grunt.initConfig({
  size: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.separator

Type: StringDefault value: ', '

A string value that is used to do something with whatever.

options.punctuation

Type: StringDefault value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testingfile has the content Testingand the 123file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  size: {
    options: {},
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})

Custom Options

In this example, custom options are used to do something else with whatever else. So if the testingfile has the content Testingand the 123file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  size: {
    options: {
      separator: ': ',
      punctuation: ' !!!',
    },
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})

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

(Nothing yet)

HomePage

https://github.com/liaoxuezhi/grunt-size

Repository

https://github.com/liaoxuezhi/grunt-size


上一篇:grunt-jsbint
下一篇:ruglify

相关推荐

官方社区

扫码加入 JavaScript 社区