Giter Club home page Giter Club logo

grunt-config-windgazer-sca's Introduction

Grunt Config for Static Code Analysis

The intend of this repository is to test using a distrubuted grunt-configuration to set up generic code analysis for a number of project that tend to share languages and owners, but not purpose.

I'm using this repository together with some hobby-work to create a proof-of-concept that should need to work within a much more complex environment, both due to the amount of developers involved as well as the project-structures.

How to use

> npm i load-grunt-configs grunt-config-windgazer-sca -D
> vi Gruntfile.js
> grunt sca:all

Make sure you add load-grunt-configs to your Gruntfile, like so:

// Gruntfile.js
module.exports = function (grunt) {
    grunt.loadNpmTasks('grunt-contrib-jshint');

    //loads the various task configuration files
    var configs = require('load-grunt-configs')(grunt);
    grunt.initConfig(configs);

    grunt.registerTask('default', ['sca:all']);
}

Generic design thoughts

Goals

  • distributed. Should be able to npm install and then run grunt sca.
  • configurable. Especcially target locations might need tweaking.
  • sane defaults. Should incorporate as much 'out-of-the-box' configration as is sane.

Ideas

I intend to rig up using load-grunt-configs, this should allow me to easily tackle most of the requirements for 'distribution'. This particular module will allow me to create split config-files, even having sub-tasks split across several configurations. On top of that, it has support for incorporating config-files from node-modules/**.

I hope to add load-grunt-configs as a peer-dependency and subsequently add the various static code checkers, as well as their configuration-settings, to this repository.

Challenges I need to solve:

  • Will 'devdependencies' be installed on the main project.
  • Documentation on using node-modules for distributed config-files is weak.

grunt-config-windgazer-sca's People

Contributors

windgazer avatar

Watchers

 avatar

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.