mirror of
https://code.forgejo.org/actions/setup-node.git
synced 2025-05-23 06:14:45 +00:00
.
This commit is contained in:
parent
00c3b50fca
commit
ae5dcb46c8
7331 changed files with 1784502 additions and 0 deletions
66
node_modules/pkg-dir/readme.md
generated
vendored
Normal file
66
node_modules/pkg-dir/readme.md
generated
vendored
Normal file
|
@ -0,0 +1,66 @@
|
|||
# pkg-dir [](https://travis-ci.org/sindresorhus/pkg-dir)
|
||||
|
||||
> 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
|
||||
```
|
||||
|
||||
```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`<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)
|
Loading…
Add table
Add a link
Reference in a new issue