Giter Club home page Giter Club logo

node-is-git-dirty's Introduction

is-git-dirty

Build Status Build status Coverage Status

Checks synchronously if the git repository is clean. This assumes that no files are added, untracked or modified.

Installation

$ npm i is-git-dirty --save

or

$ yarn add is-git-dirty

Usage

Returns:

  • null: Directory is not a git repository
  • true: Files are added, untracked or modified
  • false: No files are added, untracked or modified. Git is clean
import isGitDirty from 'is-git-dirty';

isGitDirty(); // true or false of process.cwd()
isGitDirty('any/git/repo'); // true or false

LICENSE

MIT © Jan Peer Stöcklmair

node-is-git-dirty's People

Contributors

jpeer264 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

tomfuertes

node-is-git-dirty's Issues

readme is wrong

Hello, and thanks for the library.

The main export is called isGitClean, not isGitDirty, so the instructions should probably be inverted. (?)

Additionally, can you add information on TypeScript usage to the readme?

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.