@antongolub/git-root

Find the closest .git containing path — the git root.


Motivation

It's known for certain the best way to find git root:
``shell
git rev-parse --show-toplevel
`
However, if git executable or child_process.exec are not available for some (security?) reasons, it's advisable to use tools like this one.
Inspired by pkg-dir.

Features

* Searches for .git up the dir tree
* Handles gitdir: redirects
* TS and Flow typings out of box
* Sync/async methods

Install

`shell
yarn add @antongolub/git-root
`

Usage

`ts
import { gitRoot, gitRootSync } from '@antongolub/git-root'

// async
const gitRoot1 = await gitRoot('/optional/cwd/path/')

// sync
const gitRoot2 = gitRoot('/defaults/to/process/cwd/', true)

// sync too
const gitRoot3 = gitRoot.sync()

// gitRootSync is an alias for gitRoot.sync
const gitRoot4 = gitRootSync()
``

Alternatives

* find-git-root
* git-root
* git-toplevel
* git-root-path

License

MIT