mirror of
https://github.com/github/codeql-action.git
synced 2025-12-27 17:50:07 +08:00
* Bump @ava/typescript from 3.0.1 to 4.0.0 Bumps [@ava/typescript](https://github.com/avajs/typescript) from 3.0.1 to 4.0.0. - [Release notes](https://github.com/avajs/typescript/releases) - [Commits](https://github.com/avajs/typescript/compare/v3.0.1...v4.0.0) --- updated-dependencies: - dependency-name: "@ava/typescript" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Update checked-in dependencies --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions@github.com>
85 lines
2.2 KiB
TypeScript
85 lines
2.2 KiB
TypeScript
export interface RunPathOptions {
|
|
/**
|
|
Working directory.
|
|
|
|
@default process.cwd()
|
|
*/
|
|
readonly cwd?: string | URL;
|
|
|
|
/**
|
|
PATH to be appended. Default: [`PATH`](https://github.com/sindresorhus/path-key).
|
|
|
|
Set it to an empty string to exclude the default PATH.
|
|
*/
|
|
readonly path?: string;
|
|
|
|
/**
|
|
Path to the Node.js executable to use in child processes if that is different from the current one. Its directory is pushed to the front of PATH.
|
|
|
|
This can be either an absolute path or a path relative to the `cwd` option.
|
|
|
|
@default process.execPath
|
|
*/
|
|
readonly execPath?: string;
|
|
}
|
|
|
|
export type ProcessEnv = Record<string, string | undefined>;
|
|
|
|
export interface EnvOptions {
|
|
/**
|
|
The working directory.
|
|
|
|
@default process.cwd()
|
|
*/
|
|
readonly cwd?: string | URL;
|
|
|
|
/**
|
|
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.
|
|
*/
|
|
readonly env?: ProcessEnv;
|
|
|
|
/**
|
|
The path to the current Node.js executable. Its directory is pushed to the front of PATH.
|
|
|
|
This can be either an absolute path or a path relative to the `cwd` option.
|
|
|
|
@default process.execPath
|
|
*/
|
|
readonly execPath?: string;
|
|
}
|
|
|
|
/**
|
|
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;
|
|
|
|
/**
|
|
@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;
|