update socials section
This commit is contained in:
90
node_modules/npm-run-path/index.d.ts
generated
vendored
Normal file
90
node_modules/npm-run-path/index.d.ts
generated
vendored
Normal file
@ -0,0 +1,90 @@
|
||||
type CommonOptions = {
|
||||
/**
|
||||
Working directory.
|
||||
|
||||
@default process.cwd()
|
||||
*/
|
||||
readonly cwd?: string | URL;
|
||||
|
||||
/**
|
||||
The path to the current Node.js executable.
|
||||
|
||||
This can be either an absolute path or a path relative to the `cwd` option.
|
||||
|
||||
@default [process.execPath](https://nodejs.org/api/process.html#processexecpath)
|
||||
*/
|
||||
readonly execPath?: string | URL;
|
||||
|
||||
/**
|
||||
Whether to push the current Node.js executable's directory (`execPath` option) to the front of PATH.
|
||||
|
||||
@default true
|
||||
*/
|
||||
readonly addExecPath?: boolean;
|
||||
|
||||
/**
|
||||
Whether to push the locally installed binaries' directory to the front of PATH.
|
||||
|
||||
@default true
|
||||
*/
|
||||
readonly preferLocal?: boolean;
|
||||
};
|
||||
|
||||
export type RunPathOptions = CommonOptions & {
|
||||
/**
|
||||
PATH to be appended.
|
||||
|
||||
Set it to an empty string to exclude the default PATH.
|
||||
|
||||
@default [`PATH`](https://github.com/sindresorhus/path-key)
|
||||
*/
|
||||
readonly path?: string;
|
||||
};
|
||||
|
||||
export type ProcessEnv = Record<string, string | undefined>;
|
||||
|
||||
export type EnvOptions = CommonOptions & {
|
||||
/**
|
||||
Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.
|
||||
|
||||
@default [process.env](https://nodejs.org/api/process.html#processenv)
|
||||
*/
|
||||
readonly env?: ProcessEnv;
|
||||
};
|
||||
|
||||
/**
|
||||
Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
|
||||
|
||||
@returns The augmented path string.
|
||||
|
||||
@example
|
||||
```
|
||||
import childProcess from 'node:child_process';
|
||||
import {npmRunPath} from 'npm-run-path';
|
||||
|
||||
console.log(process.env.PATH);
|
||||
//=> '/usr/local/bin'
|
||||
|
||||
console.log(npmRunPath());
|
||||
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
|
||||
```
|
||||
*/
|
||||
export function npmRunPath(options?: RunPathOptions): string;
|
||||
|
||||
/**
|
||||
Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries.
|
||||
|
||||
@returns The augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.
|
||||
|
||||
@example
|
||||
```
|
||||
import childProcess from 'node:child_process';
|
||||
import {npmRunPathEnv} from 'npm-run-path';
|
||||
|
||||
// `foo` is a locally installed binary
|
||||
childProcess.execFileSync('foo', {
|
||||
env: npmRunPathEnv()
|
||||
});
|
||||
```
|
||||
*/
|
||||
export function npmRunPathEnv(options?: EnvOptions): ProcessEnv;
|
52
node_modules/npm-run-path/index.js
generated
vendored
Normal file
52
node_modules/npm-run-path/index.js
generated
vendored
Normal file
@ -0,0 +1,52 @@
|
||||
import process from 'node:process';
|
||||
import path from 'node:path';
|
||||
import {fileURLToPath} from 'node:url';
|
||||
import pathKey from 'path-key';
|
||||
|
||||
export const npmRunPath = ({
|
||||
cwd = process.cwd(),
|
||||
path: pathOption = process.env[pathKey()],
|
||||
preferLocal = true,
|
||||
execPath = process.execPath,
|
||||
addExecPath = true,
|
||||
} = {}) => {
|
||||
const cwdString = cwd instanceof URL ? fileURLToPath(cwd) : cwd;
|
||||
const cwdPath = path.resolve(cwdString);
|
||||
const result = [];
|
||||
|
||||
if (preferLocal) {
|
||||
applyPreferLocal(result, cwdPath);
|
||||
}
|
||||
|
||||
if (addExecPath) {
|
||||
applyExecPath(result, execPath, cwdPath);
|
||||
}
|
||||
|
||||
return [...result, pathOption].join(path.delimiter);
|
||||
};
|
||||
|
||||
const applyPreferLocal = (result, cwdPath) => {
|
||||
let previous;
|
||||
|
||||
while (previous !== cwdPath) {
|
||||
result.push(path.join(cwdPath, 'node_modules/.bin'));
|
||||
previous = cwdPath;
|
||||
cwdPath = path.resolve(cwdPath, '..');
|
||||
}
|
||||
};
|
||||
|
||||
// Ensure the running `node` binary is used
|
||||
const applyExecPath = (result, execPath, cwdPath) => {
|
||||
const execPathString = execPath instanceof URL ? fileURLToPath(execPath) : execPath;
|
||||
result.push(path.resolve(cwdPath, execPathString, '..'));
|
||||
};
|
||||
|
||||
export const npmRunPathEnv = ({env = process.env, ...options} = {}) => {
|
||||
env = {...env};
|
||||
|
||||
const pathName = pathKey({env});
|
||||
options.path = env[pathName];
|
||||
env[pathName] = npmRunPath(options);
|
||||
|
||||
return env;
|
||||
};
|
9
node_modules/npm-run-path/license
generated
vendored
Normal file
9
node_modules/npm-run-path/license
generated
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
31
node_modules/npm-run-path/node_modules/path-key/index.d.ts
generated
vendored
Normal file
31
node_modules/npm-run-path/node_modules/path-key/index.d.ts
generated
vendored
Normal file
@ -0,0 +1,31 @@
|
||||
export interface Options {
|
||||
/**
|
||||
Use a custom environment variables object.
|
||||
|
||||
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env).
|
||||
*/
|
||||
readonly env?: Record<string, string | undefined>;
|
||||
|
||||
/**
|
||||
Get the PATH key for a specific platform.
|
||||
|
||||
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform).
|
||||
*/
|
||||
readonly platform?: NodeJS.Platform;
|
||||
}
|
||||
|
||||
/**
|
||||
Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform.
|
||||
|
||||
@example
|
||||
```
|
||||
import pathKey from 'path-key';
|
||||
|
||||
const key = pathKey();
|
||||
//=> 'PATH'
|
||||
|
||||
const PATH = process.env[key];
|
||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
||||
```
|
||||
*/
|
||||
export default function pathKey(options?: Options): string;
|
12
node_modules/npm-run-path/node_modules/path-key/index.js
generated
vendored
Normal file
12
node_modules/npm-run-path/node_modules/path-key/index.js
generated
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
export default function pathKey(options = {}) {
|
||||
const {
|
||||
env = process.env,
|
||||
platform = process.platform
|
||||
} = options;
|
||||
|
||||
if (platform !== 'win32') {
|
||||
return 'PATH';
|
||||
}
|
||||
|
||||
return Object.keys(env).reverse().find(key => key.toUpperCase() === 'PATH') || 'Path';
|
||||
}
|
9
node_modules/npm-run-path/node_modules/path-key/license
generated
vendored
Normal file
9
node_modules/npm-run-path/node_modules/path-key/license
generated
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
41
node_modules/npm-run-path/node_modules/path-key/package.json
generated
vendored
Normal file
41
node_modules/npm-run-path/node_modules/path-key/package.json
generated
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
{
|
||||
"name": "path-key",
|
||||
"version": "4.0.0",
|
||||
"description": "Get the PATH environment variable key cross-platform",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/path-key",
|
||||
"funding": "https://github.com/sponsors/sindresorhus",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "https://sindresorhus.com"
|
||||
},
|
||||
"type": "module",
|
||||
"exports": "./index.js",
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"path",
|
||||
"key",
|
||||
"environment",
|
||||
"env",
|
||||
"variable",
|
||||
"get",
|
||||
"cross-platform",
|
||||
"windows"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@types/node": "^14.14.37",
|
||||
"ava": "^3.15.0",
|
||||
"tsd": "^0.14.0",
|
||||
"xo": "^0.38.2"
|
||||
}
|
||||
}
|
57
node_modules/npm-run-path/node_modules/path-key/readme.md
generated
vendored
Normal file
57
node_modules/npm-run-path/node_modules/path-key/readme.md
generated
vendored
Normal file
@ -0,0 +1,57 @@
|
||||
# path-key
|
||||
|
||||
> Get the [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) environment variable key cross-platform
|
||||
|
||||
It's usually `PATH` but on Windows it can be any casing like `Path`...
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install path-key
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import pathKey from 'path-key';
|
||||
|
||||
const key = pathKey();
|
||||
//=> 'PATH'
|
||||
|
||||
const PATH = process.env[key];
|
||||
//=> '/usr/local/bin:/usr/bin:/bin'
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### pathKey(options?)
|
||||
|
||||
#### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
##### env
|
||||
|
||||
Type: `object`\
|
||||
Default: [`process.env`](https://nodejs.org/api/process.html#process_process_env)
|
||||
|
||||
Use a custom environment variables object.
|
||||
|
||||
#### platform
|
||||
|
||||
Type: `string`\
|
||||
Default: [`process.platform`](https://nodejs.org/api/process.html#process_process_platform)
|
||||
|
||||
Get the PATH key for a specific platform.
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<b>
|
||||
<a href="https://tidelift.com/subscription/pkg/npm-path-key?utm_source=npm-path-key&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||||
</b>
|
||||
<br>
|
||||
<sub>
|
||||
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||||
</sub>
|
||||
</div>
|
49
node_modules/npm-run-path/package.json
generated
vendored
Normal file
49
node_modules/npm-run-path/package.json
generated
vendored
Normal file
@ -0,0 +1,49 @@
|
||||
{
|
||||
"name": "npm-run-path",
|
||||
"version": "5.3.0",
|
||||
"description": "Get your PATH prepended with locally installed binaries",
|
||||
"license": "MIT",
|
||||
"repository": "sindresorhus/npm-run-path",
|
||||
"funding": "https://github.com/sponsors/sindresorhus",
|
||||
"author": {
|
||||
"name": "Sindre Sorhus",
|
||||
"email": "sindresorhus@gmail.com",
|
||||
"url": "https://sindresorhus.com"
|
||||
},
|
||||
"type": "module",
|
||||
"exports": "./index.js",
|
||||
"types": "./index.d.ts",
|
||||
"sideEffects": false,
|
||||
"engines": {
|
||||
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "xo && ava && tsd"
|
||||
},
|
||||
"files": [
|
||||
"index.js",
|
||||
"index.d.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"npm",
|
||||
"run",
|
||||
"path",
|
||||
"package",
|
||||
"bin",
|
||||
"binary",
|
||||
"binaries",
|
||||
"script",
|
||||
"cli",
|
||||
"command-line",
|
||||
"execute",
|
||||
"executable"
|
||||
],
|
||||
"dependencies": {
|
||||
"path-key": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"ava": "^3.15.0",
|
||||
"tsd": "^0.17.0",
|
||||
"xo": "^0.45.0"
|
||||
}
|
||||
}
|
104
node_modules/npm-run-path/readme.md
generated
vendored
Normal file
104
node_modules/npm-run-path/readme.md
generated
vendored
Normal file
@ -0,0 +1,104 @@
|
||||
# npm-run-path
|
||||
|
||||
> Get your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) prepended with locally installed binaries
|
||||
|
||||
In [npm run scripts](https://docs.npmjs.com/cli/run-script) you can execute locally installed binaries by name. This enables the same outside npm.
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install npm-run-path
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import childProcess from 'node:child_process';
|
||||
import {npmRunPath, npmRunPathEnv} from 'npm-run-path';
|
||||
|
||||
console.log(process.env.PATH);
|
||||
//=> '/usr/local/bin'
|
||||
|
||||
console.log(npmRunPath());
|
||||
//=> '/Users/sindresorhus/dev/foo/node_modules/.bin:/Users/sindresorhus/dev/node_modules/.bin:/Users/sindresorhus/node_modules/.bin:/Users/node_modules/.bin:/node_modules/.bin:/usr/local/bin'
|
||||
|
||||
// `foo` is a locally installed binary
|
||||
childProcess.execFileSync('foo', {
|
||||
env: npmRunPathEnv()
|
||||
});
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### npmRunPath(options?)
|
||||
|
||||
`options`: [`Options`](#options)\
|
||||
_Returns_: `string`
|
||||
|
||||
Returns the augmented PATH string.
|
||||
|
||||
### npmRunPathEnv(options?)
|
||||
|
||||
`options`: [`Options`](#options)\
|
||||
_Returns_: `object`
|
||||
|
||||
Returns the augmented [`process.env`](https://nodejs.org/api/process.html#process_process_env) object.
|
||||
|
||||
### options
|
||||
|
||||
Type: `object`
|
||||
|
||||
#### cwd
|
||||
|
||||
Type: `string | URL`\
|
||||
Default: `process.cwd()`
|
||||
|
||||
The working directory.
|
||||
|
||||
#### execPath
|
||||
|
||||
Type: `string | URL`\
|
||||
Default: [`process.execPath`](https://nodejs.org/api/process.html#processexecpath)
|
||||
|
||||
The path to the current Node.js executable.
|
||||
|
||||
This can be either an absolute path or a path relative to the [`cwd` option](#cwd).
|
||||
|
||||
#### addExecPath
|
||||
|
||||
Type: `boolean`\
|
||||
Default: `true`
|
||||
|
||||
Whether to push the current Node.js executable's directory ([`execPath`](#execpath) option) to the front of PATH.
|
||||
|
||||
#### preferLocal
|
||||
|
||||
Type: `boolean`\
|
||||
Default: `true`
|
||||
|
||||
Whether to push the locally installed binaries' directory to the front of PATH.
|
||||
|
||||
#### path
|
||||
|
||||
Type: `string`\
|
||||
Default: [`PATH`](https://github.com/sindresorhus/path-key)
|
||||
|
||||
The PATH to be appended.
|
||||
|
||||
Set it to an empty string to exclude the default PATH.
|
||||
|
||||
Only available with [`npmRunPath()`](#npmrunpathoptions), not [`npmRunPathEnv()`](#npmrunpathenvoptions).
|
||||
|
||||
#### env
|
||||
|
||||
Type: `object`\
|
||||
Default: [`process.env`](https://nodejs.org/api/process.html#processenv)
|
||||
|
||||
Accepts an object of environment variables, like `process.env`, and modifies the PATH using the correct [PATH key](https://github.com/sindresorhus/path-key). Use this if you're modifying the PATH for use in the `child_process` options.
|
||||
|
||||
Only available with [`npmRunPathEnv()`](#npmrunpathenvoptions), not [`npmRunPath()`](#npmrunpathoptions).
|
||||
|
||||
## Related
|
||||
|
||||
- [npm-run-path-cli](https://github.com/sindresorhus/npm-run-path-cli) - CLI for this module
|
||||
- [execa](https://github.com/sindresorhus/execa) - Execute a locally installed binary
|
Reference in New Issue
Block a user