https://github.com/jaid/is-git-repo-dirty

Returns true if a given directory is a dirty git repository.
https://github.com/jaid/is-git-repo-dirty

git git-repo lib library promise util utility

Last synced: 12 days ago
JSON representation

Returns true if a given directory is a dirty git repository.

• Host: GitHub
• URL: https://github.com/jaid/is-git-repo-dirty
• Owner: Jaid
• License: mit
• Created: 2019-07-06T12:22:34.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-03T18:16:51.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T14:49:27.284Z (8 months ago)
• Topics: git, git-repo, lib, library, promise, util, utility
• Language: JavaScript
• Homepage: https://github.com/Jaid/is-git-repo-dirty
• Size: 2.59 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license.txt

Awesome Lists containing this project

README

        
# is-git-repo-dirty

 

     

  

**Promise that returns true if a given directory is a dirty git repository.**

## Installation



```bash

npm install --save is-git-repo-dirty@^1.0.1

```



```bash

yarn add is-git-repo-dirty@^1.0.1

```

## Development

Setting up:

```bash

git clone [email protected]:jaid/is-git-repo-dirty.git

cd is-git-repo-dirty

npm install

```

Testing:

```bash

npm run test:dev

```

Testing in production environment:

```bash

npm run test

```

## License

```text

MIT License

Copyright © 2020, Jaid  (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

```