Giter VIP home page Giter VIP logo

git-precheck's Introduction

git-precheck

Installation

$ npm install -g git-precheck

Usage

You can use this from within any git directory to run basic pre-checks before making a commit:

$ git precheck
Installing node dependencies
Extracting build steps from travis

> [email protected] test /home/...
> node scripts/run-tests

# output of your commands...

Summary of build steps:
√  $ npm test
√  $ node scripts/generate-docs.js
√  $ git diff --quiet # make sure no files have changed

What commands does it choose to run? Well, it aims to run whatever Travis CI would attempt to run. How does it decide? Read below...

Integrating within vim

But wait, there's more! If you're a fugitive user, then you get vim-integration for free. You can run prechecks from within vim using:

:Git precheck " or if you were smart and made the short alias...

If you're not a fugitive user (but really, why not?) then you can use it like this:

:!git precheck

Travis CI Compatibility

Yup! It works with Travis as well. If you have a .travis.yml file in your repo, it will attempt to read the script steps from the file and execute those sequentially, just like Travis would. Now you can know if your PR will pass before you push it 👍

Windows Compatibility???

Windows compatibility isn't my biggest priority, but it should still be there. If it isn't, drop me a line and let me know.

git-precheck's People

Contributors

nfischer avatar

Stargazers

 avatar

Watchers

 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.