npmpackage.info

Gathering detailed insights and metrics for is-git-clean

Other packages similar to is-git-clean

is-git-dirty

2.0.2

Check if a repository has untracked or added files

git-is-clean

3.0.4

Check if the Git index and working tree are clean

@types/is-git-clean

1.1.2

TypeScript definitions for is-git-clean

git-dirty

1.0.2

Ensures the working directory is clean and that there are no unpulled changes

Gathering detailed insights and metrics for is-git-clean

is-git-clean - 1.1.0 | npmpackage.info

is-git-clean

Find out if a git directory is clean or not

1.1.0

MIT

JavaScript

3.2

Installations

npm install is-git-clean

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>=0.10.0

Node Version

6.2.1

NPM Version

3.10.5 Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

1

Total

1

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

jamestalmage

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

12 Stars

8 Commits

1 Forks

3 Watchers

1 Branches

2 Contributors

Updated on Dec 21, 2024

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

1.1.0

Package Id

is-git-clean@1.1.0

Size

2.24 kB

NPM Version

3.10.5

Node Version

6.2.1

Published on

Sep 21, 2016

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

execa is-obj multimatch

Dev Dependencies

ava xo

is-git-clean

Find out if a git directory is clean or not

Install

$ npm install --save is-git-clean

Usage

1const isGitClean = require('is-git-clean');
2
3isGitClean().then(clean => console.log(clean));
4//=> true || false
5
6// alternate directory
7isGitClean('/some/path')
8
9// options
10// `ignore.txt` is ignored and not counted as dirty
11isGitClean('/some/path', {files: ['!ignore.txt']})
12
13// sync version
14isGitClean.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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More