JSPM

is-git-clean

1.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 53134
  • Score
    100M100P100Q149659F
  • License MIT

Find out if a git directory is clean or not

Package Exports

  • is-git-clean

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (is-git-clean) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

is-git-clean Build Status

Find out if a git directory is clean or not

Install

$ npm install --save is-git-clean

Usage

const isGitClean = require('is-git-clean');

isGitClean().then(clean => console.log(clean));
//=> true || false

// alternate directory
isGitClean('/some/path')

// options
// `ignore.txt` is ignored and not counted as dirty
isGitClean('/some/path', {files: ['!ignore.txt']})

// sync version
isGitClean.sync()

API

isGitClean([dir], [options])

Returns a promise for a boolean value. true if the directory is clean, false if it is not.

dir

Type: string
Default: process.cwd()

Path to the directory you want to check.

options

Type: object

files

Type: array

An array of multimatch patterns to ignore certain files.

isGitClean.sync([dir], [options])

Synchronous version, with the same API as above. Returns a boolean directly, instead of a Promise.

License

MIT © James Talmage