# is-git-dirty

> Check if a repository has untracked or added files

Latest version **2.0.2** (published 2023-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-git-dirty
pnpm add is-git-dirty
yarn add is-git-dirty
bun add is-git-dirty
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2023-03-03 |
| First published | 2018-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Jan Peer Stöcklmair |
| Maintainers | jpeer |
| Keywords | is, git, clean, dirty, HEAD, repo, is-git, exists |

## Links

- npm: https://www.npmjs.com/package/is-git-dirty
- Repository: https://github.com/JPeer264/node-is-git-dirty
- Homepage: https://github.com/JPeer264/node-is-git-dirty#readme
- Issues: https://github.com/JPeer264/node-is-git-dirty/issues
- npm.io page: https://npm.io/package/is-git-dirty

## Dependencies (2)

- [execa](https://npm.io/package/execa.md) ^4.0.3
- [is-git-repository](https://npm.io/package/is-git-repository.md) ^2.0.0

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2023-03-03
- 2.0.1 — 2020-07-23
- 2.0.0 — 2020-07-23
- 1.0.0 — 2018-04-22

## README

# is-git-dirty

[![Build Status](https://travis-ci.com/JPeer264/node-is-git-dirty.svg?branch=main)](https://travis-ci.com/JPeer264/node-is-git-dirty)
[![Build status](https://ci.appveyor.com/api/projects/status/ehj6762gbj1e2qyc?svg=true)](https://ci.appveyor.com/project/JPeer264/node-is-git-dirty)
[![Coverage Status](https://coveralls.io/repos/github/JPeer264/node-is-git-dirty/badge.svg?branch=main)](https://coveralls.io/github/JPeer264/node-is-git-dirty?branch=main)

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

## Installation

```sh
$ npm i is-git-dirty --save
```
or
```sh
$ 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

```js
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](https://www.jpeer.at)

---
_Source: https://npm.io/package/is-git-dirty · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._