Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stevenvachon/grunt-log-headers

Hide the running task name header in Grunt's logger.
https://github.com/stevenvachon/grunt-log-headers

grunt-plugins logger nodejs

Last synced: 2 months ago
JSON representation

Hide the running task name header in Grunt's logger.

Awesome Lists containing this project

README

        

# grunt-log-headers [![NPM Version][npm-image]][npm-url]

> Hide the running task name header in Grunt's logger.

## Getting Started
This plugin requires Grunt `>=0.4`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-log-headers --save-dev
```

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

```js
require('grunt-log-headers')(grunt);
```

## There is no task

### Overview
Unlike typical Grunt plugins, this one has no task. It's actually a hack that wraps a part of Grunt's core.

*Note:* Because of the nature of this plugin, complications may occur with any other similar "hacked" plugins.

### Global Options

#### options.gruntLogHeader
Type: `Boolean`
Default value: `true`

Show the running task header or not. This can be applied to *any* task.

### Usage Example
```js
module.exports = function(grunt) {
grunt.initConfig({
sometask: {
options: {
gruntLogHeader: false,
},
sometarget1: {
options: {
gruntLogHeader: true,
},

}
sometarget2: {

},
},
});

require('grunt-log-headers')(grunt);
grunt.loadNpmTasks('sometask');
}
```

## Release History
* 1.0.2 supports grunt `1.x` and npm `3.x`
* 1.0.1 package.json fixes
* 1.0.0 release
* 0.1.0 initial release

[npm-image]: https://img.shields.io/npm/v/grunt-log-headers.svg
[npm-url]: https://npmjs.org/package/grunt-log-headers