# `git-is-clean`

This function will return `true` or `false` depending on if it finds out your repo
is dirty or not.

## Usage

```bash
git-is-clean "path/to/repo" || echo "path/to/repo is dirty!"
```

In this example, if `path/to/repo` is dirty it will `echo` _path/to/repo is dirty!_

## Requires

- `git`

If you use https://github.com/aubreypwd/zsh-plugin-require we will try and install dependancies automatically.

## Install

Using [antigen](https://github.com/zsh-users/antigen):

```bash
antigen bundle aubreypwd/zsh-plugin-git-is-clean@1.0.0
```

## Development

Install the package on `main`:

```bash
antigen bundle ssh://git@github.com/aubreypwd/zsh-plugin-git-is-clean
```

...and contribute upstream by working in `$HOME/.antigen/bundles/aubreypwd/zsh-plugin-git-is-clean`.

## How I use this

```bash
###
 # Watch repositories.
 ##
function __git-is-clean {
    git-is-clean "$1" || ( echo "🚨  $1 is dirty" && tput bel )
}
__git-is-clean "$HOME/Repos/github.com/aubreypwd/iTerm2"
__git-is-clean "$HOME/Repos/github.com/aubreypwd/Alfred.alfredpreferences"
__git-is-clean "$HOME/Repos/github.com/aubreypwd/subl-snippets"
```