https://github.com/glorywong/check-git-clean

Check the cleanliness of a Git working directory, identifying untracked, unstaged, and uncommitted changes.
https://github.com/glorywong/check-git-clean

changes clean git nodejs repository status typescript uncommitted unstaged untracked

Last synced: 9 months ago
JSON representation

Check the cleanliness of a Git working directory, identifying untracked, unstaged, and uncommitted changes.

• Host: GitHub
• URL: https://github.com/glorywong/check-git-clean
• Owner: GloryWong
• License: mit
• Created: 2024-08-12T13:48:31.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-04-06T21:41:09.000Z (9 months ago)
• Last Synced: 2025-04-06T22:26:44.536Z (9 months ago)
• Topics: changes, clean, git, nodejs, repository, status, typescript, uncommitted, unstaged, untracked
• Language: TypeScript
• Homepage:
• Size: 263 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![GitHub License](https://img.shields.io/github/license/GloryWong/check-git-clean)

![GitHub commit activity](https://img.shields.io/github/commit-activity/w/GloryWong/check-git-clean)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/GloryWong/check-git-clean/release.yml)

![GitHub Release](https://img.shields.io/github/v/release/GloryWong/check-git-clean)

![GitHub Release Date](https://img.shields.io/github/release-date/GloryWong/check-git-clean)

![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/GloryWong/check-git-clean)

![GitHub watchers](https://img.shields.io/github/watchers/GloryWong/check-git-clean)

![GitHub forks](https://img.shields.io/github/forks/GloryWong/check-git-clean)

![GitHub Repo stars](https://img.shields.io/github/stars/GloryWong/check-git-clean)

![NPM Version](https://img.shields.io/npm/v/check-git-clean)

![NPM Type Definitions](https://img.shields.io/npm/types/check-git-clean)

![NPM Downloads](https://img.shields.io/npm/dw/check-git-clean)

![Node Current](https://img.shields.io/node/v/check-git-clean)

# check-git-clean

Check the cleanliness of a Git working directory, identifying untracked, unstaged, and uncommitted changes.

## Install

Using pnpm:

```bash

pnpm add check-git-clean

```

Using yarn:

```bash

yarn add check-git-clean

```

Using npm:

```bash

npm install check-git-clean

```

## Usage

```javascript

import { checkGitClean } from 'check-git-clean'

/**

 * Check if a local git repository is clean.

 * Ignore files defined in [git-ignore-patterns](git-ignore-patterns),

 * which contains commonly git-ignored files for node project.

 * @param dir (optional). Default to `process.cwd()`

 * @return Object { `isClean`, `untracked`, `unstaged`, `uncommitted` }

 */

const { isClean, untracked, unstaged, uncommitted } = await checkGitClean()

```

## Authors

👤 **GloryWong**

* Website: https://glorywong.com

* GitHub: [@GloryWong](https://github.com/GloryWong)

## Show Your Support

Give a ⭐️ if this project helped you!