webhook-action/node_modules/pkg-dir
Joel Male 1ada95e04a
v2.0.0 (#12)
- Convert project to Javascript/Typescript
- Allow custom headers to be passed in (optional)
- Allow body to be optional
2020-08-26 10:52:47 +10:00
..
index.js v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
license v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
package.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
readme.md v2.0.0 (#12) 2020-08-26 10:52:47 +10:00

pkg-dir Build Status

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

Install

$ npm install --save pkg-dir

Usage

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

pkgDir(__dirname).then(rootDir => {
	console.log(rootDir);
	//=> '/Users/sindresorhus/foo'
});

API

pkgDir([cwd])

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

pkgDir.sync([cwd])

Returns the project root path or null.

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