find-project-root

Finds project root

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
find-project-root
1.1.19 years ago9 years agoMinified + gzip package size for find-project-root in KB

Readme

find-project-root Build Status
Finds the project root by custom markers

Getting started

  1. As a binary
```
  $ npm install find-project-root -g
  $ pwd
    /Users/kirstein/workspace/github/kirstein/find-project-root/test
  $ find-project-root
    /Users/kirstein/workspace/github/kirstein/find-project-root
```
  1. As a node module
```
  $ npm install find-project-root
  var findProjectRoot = require('find-project-root');
  // magic
```

What?

Traverses top-down of the project tree starting from a specific path and searches for known markers that indicate project starting point.
Markers:
.hg .git

API

findProjectRoot(path, {options});
options:
maxDepth - int - total number of levels the algorithm can traverse
**default**: 9  
markers - 'str' - markers that it will search for
**default**: [ '.hg', '.git' ]


Example:
var findProjectRoot = require('find-project-root');
var root = findProjectRoot(process.cwd(), {
  maxDepth: 12
});