Giter VIP home page Giter VIP logo

grunt-buddyjs's Introduction

grunt-buddyjs

Grunt module for running Buddy.js

Getting Started

This plugin requires Grunt ~0.4.5

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

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

grunt.loadNpmTasks('grunt-buddyjs');

The "buddyjs" task

Overview

This task is a wrapper around buddy.js, a magic number detector.

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

grunt.initConfig({
  buddyjs: {
    src: ['file1.js', 'file2.js'],
    options: {
      // ...
    }
  },
});

Options

options.ignore

Type: Array Default value: [0, 1]

Numbers that will be ignored in the processing.

options.disableIgnore

Type: Boolean Default value: false

Disables the ignore list.

options.enforceConst

Type: Boolean Default value: false

Enforce literals to be declared with the const keyword.

options.noColor

Type: Boolean Default value: false

options.reporter

Type: String Default value: simple

Reporter to use. Options available are simple, json and detailed.

Usage Examples

The following configuration would disable ignoring 0 and 1 as magic numbers and report as JSON.

grunt.initConfig({
  buddyjs: {
    src: ["lib/*.js"],
    options: {
      disableIgnore: true,
      reporter: "json"
    }
  },
});

Release History

  • v0.1.0 - Initial release.

grunt-buddyjs's People

Contributors

danielstjules avatar

Stargazers

 avatar  avatar Michael Anthony avatar Oleg Gabrusenok avatar Gabriel Grinberg avatar Pranav avatar Rutger avatar Sam Billingham avatar Curtis M. Humphrey, Ph.D. avatar Francois-Guillaume Ribreau avatar Ashwin Hegde avatar Jonathan Bonnefoy avatar Luke Chesser avatar Luan Muniz avatar

Watchers

James Cloos avatar Michael Anthony avatar Eugene Bulkin avatar  avatar

grunt-buddyjs's Issues

Not working "buddy ignore" comment

Task log:

Warning: Running "buddyjs:all" (buddyjs) task

./test.js:1337
    Id: -2, // buddy ignore:line
    Name: 'Sample Text'

1 magic numbers found across 21 files
Warning: Task "buddyjs:all" failed. Use --force to continue.

And // buddy ignore:start ... // buddy ignore:end not working too.


It would be great if this feature will be fixed.
Thanks in advance.

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.