You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
hjl 9372f6120a
add file
10 months ago
..
index.d.ts add file 10 months ago
index.js add file 10 months ago
license add file 10 months ago
package.json add file 10 months ago
readme.md add file 10 months ago

readme.md

pkg-dir Build Status

Find the root directory of a Node.js project or npm package

Install

$ npm install pkg-dir

Usage

/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
// example.js
const pkgDir = require('pkg-dir');

(async () => {
	const rootDir = await pkgDir(__dirname);

	console.log(rootDir);
	//=> '/Users/sindresorhus/foo'
})();

API

pkgDir([cwd])

Returns a Promise for either the project root path or undefined if it couldn't be found.

pkgDir.sync([cwd])

Returns the project root path or undefined if it couldn't be found.

cwd

Type: string
Default: process.cwd()

Directory to start from.

  • pkg-dir-cli - CLI for this module
  • pkg-up - Find the closest package.json file
  • find-up - Find a file by walking up parent directories

License

MIT © Sindre Sorhus