aboutsummaryrefslogtreecommitdiff
path: root/node_modules/pkg-dir/readme.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/pkg-dir/readme.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/pkg-dir/readme.md')
-rw-r--r--node_modules/pkg-dir/readme.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/node_modules/pkg-dir/readme.md b/node_modules/pkg-dir/readme.md
new file mode 100644
index 00000000..3cab12ef
--- /dev/null
+++ b/node_modules/pkg-dir/readme.md
@@ -0,0 +1,64 @@
+# pkg-dir [![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.org/sindresorhus/pkg-dir)
+
+> 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
+```
+
+```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`<br>
+Default: `process.cwd()`
+
+Directory to start from.
+
+
+## Related
+
+- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
+- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
+- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)