residence
TypeScript icon, indicating that this package has built-in type declarations

0.0.217 • Public • Published

Version

Residence

Allows you find a root of a project given current working directory (process.cwd())

Examples

Looking for the NPM project root, by looking for package.json

import * as residence from 'residence';
const rootPath = residence.findProjectRoot(process.cwd());
// root is either null or a project root path, found by looking for the first package.json file

Looking for a project root, by looking for another file

import * as residence from 'residence';
const rootPath = residence.findRootDir(process.cwd(), '.nlu.json');
// walks up the fs towards '/' and returns the path when it finds the first .nlu.json file
// returns null otherwise.

Package Sidebar

Install

npm i residence

Weekly Downloads

23

Version

0.0.217

License

MIT

Unpacked Size

4.53 kB

Total Files

7

Last publish

Collaborators

  • oresoftware