https://github.com/kaelzhang/nodegit-is

The definitive checking library for git
https://github.com/kaelzhang/nodegit-is

git is-git is-git-root

Last synced: 9 days ago
JSON representation

The definitive checking library for git

• Host: GitHub
• URL: https://github.com/kaelzhang/nodegit-is
• Owner: kaelzhang
• License: other
• Created: 2019-09-19T03:50:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-19T06:32:38.000Z (over 5 years ago)
• Last Synced: 2024-12-13T13:16:18.621Z (9 days ago)
• Topics: git, is-git, is-git-root
• Language: JavaScript
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/kaelzhang/nodegit-is.svg?branch=master)](https://travis-ci.org/kaelzhang/nodegit-is)

[![Coverage](https://codecov.io/gh/kaelzhang/nodegit-is/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/nodegit-is)

# @nodegit/is

The definitive checking library for git

## Install

```sh

$ npm i @nodegit/is

```

## Usage

```js

const is = require('@nodegit/is')

// Test if the current working directory is a git repo

// or inside a git repo

is.git()

// Which is equivalent to

is.git(process.cwd())

// Test if the current working directory is the root of a git repo

is.gitRoot()

```

### git(dir = process.cwd()): boolean

- **dir** `string=process.cwd()` the directory to be tested. If not specified, the current working directory will be used

Returns `boolean` true if `cwd` is the root of a git repo or inside a git repo

### gitRoot(dir = process.cwd()): boolean

- **dir**

Returns `boolean` true if `cwd` is the root of a git repo

## License

[MIT](LICENSE)