Giter VIP home page Giter VIP logo

qc's Introduction

Trussle QC

QC is a tool that performs quality control checks on a Javascript repository. It makes sure that:

If any of these checks don't pass, QC won't let you push your changes. Mean, I know - but it's the only way you'll learn.


Installation

QC should be installed as a dependency in your project:

npm install --save-dev @trussle/qc

If you're using mocha, you'll need to change from using mocha to using _mocha; this avoids forking the process, which causes some issues with code coverage.

Usage

On installation, QC will do a few things:

  • If there is no .eslintrc.js file, one is added to the root of the project.
  • If there is no .istanbul.yml file, one is added to the root of your project.
  • It will set up a Git pre-push hook that runs itself when pushing code, to make sure you're behaving ๐Ÿ˜˜

If you want to run QC yourself, just run ./node_modules/.bin/qc or set up the following script in your package.json:

{
    "scripts": {
        "qc": "qc"
    }
}

Assumptions

Please read this section very carefully: if any of these assumptions are not true about your project, QC will fail.

QC assumes the following about your package:

  • There is a test script in your package.json which points to an executable in the ./node_modules/.bin directory (not global; usually _mocha).

qc's People

Watchers

 avatar  avatar  avatar  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.