Giter Club home page Giter Club logo

grunt-verbosity's Introduction

grunt-verbosity

Build Status Dependencies devDependencies

Adjust verbosity for individual grunt tasks

This plugin simply hooks until grunt.log.writeln to allow you to cleanup log output.

Getting Started

This plugin requires Grunt ~0.4.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-verbosity --save-dev

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

grunt.loadNpmTasks('grunt-verbosity');

The verbosity task

Usage

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

grunt.initConfig({
  verbosity: {
    // Default
    option1: {
      // options: { mode: 'hidden' },
      tasks: ['copy']
    },

    // Output is rewritten on the line to show progress but save space
    option2: {
      options: { mode: 'oneline' },
      tasks: ['copy:files']
    },

    // Output is normal.  Useful for debugging without commenting out the whole block
    option3: {
      options: { mode: 'normal' },
      tasks: ['copy:something']
    }
  },
})

Options

options.mode

Type: String Default value: normal

A string value to determine how to modify grunt.log.writeln output.

  • hidden (Default): See the task get executed, but not its output
  • oneline: See the output overwrite the same line to conserve space
  • normal: See the output without modification. Useful for debugging.
  • dot: See each line of output reduced to a dot to show progress.

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

v1.0.1

  • Update devDependencies and make travis tests pass.

v1.0.0

  • Update peerDependencies for grunt v1. No Api changes.

v0.2.2

  • Fix bug with verbosity.writeln and undefined

v0.2.1

  • Fix bug with Verbosity.match not returning an array

v0.2.0

  • Rewrote to not use grunt.util.hooker

v0.1.2

  • Fix BC break with Grunt 0.4.1 - #3 (Thanks @gruber76!)

v0.1.1

  • Add dot mode - #1 (Thanks @getfatday!)

v0.1.0

  • Initial release

grunt-verbosity's People

Contributors

ericclemmons avatar getfatday avatar gruber76 avatar gruntjs-updater avatar steveoh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

grunt-verbosity's Issues

Grunt Verbosity with JsHint

I'm using Grunt Verbosity with grunt-contrib-jshint 0.6.x with a mode of 'normal',.

When I have a jshint error, the error is reported but the filename is not shown.

If I disable Grunt Verbosity, I do see the filename with the error.

The docs indicate:
"normal: See the output without modification. Useful for debugging."

So I found that unexpected.

Is that something that needs to be resolved or did I miss something?

Doesn't seem to work anymore?

I have:

grunt.initConfig({
    verbosity: {
        options: { mode: 'hidden' },
        tasks: [
            'dog',
            'cat',
            'mouse',
            // etc.
        ]
    },
});

And it still seems to print everything, even with hidden on?

No Output Without `--verbose`

I'm trying to use this package, but running into an odd behavior. If I use any mode other than normal (i.e. oneline or dot), I just get a blank line of output:

Running "groundskeeper:default" (groundskeeper) task

However, if I use --verbose on the command line, then I do, indeed, see the behavior that I expect.

Do you see this issue? What info do you need from me?

Incompatible with grunt 0.4.1

Grunt has moved from using log.writeln to output "Running xx task" to using log.header, which has completely broken grunt-verbosity.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.