JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 69921012
  • Score
    100M100P100Q246427F
  • License MIT

Get your PATH prepended with locally installed binaries

Package Exports

  • npm-run-path

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (npm-run-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm-run-path Build Status

Get your PATH prepended with locally installed binaries

In npm run scripts you can execute locally installed binaries by name. This enables the same outside npm.

Install

$ npm install --save npm-run-path

Usage

const childProcess = require('child_process');
const npmRunPath = require('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: npmRunPath.env()
});

API

npmRunPath([options])

options

cwd

Type: string
Default: process.cwd()

Working directory.

path

Type: string
Default: PATH

PATH to be appended.
Set it to an empty string to exclude the default PATH.

npmRunPath.env([options])

options

cwd

Type: string
Default: process.cwd()

Working directory.

env

Type: Object

Accepts an object of environment variables, like process.env, and modifies the PATH using the correct PATH key. Use this if you're modifying the PATH for use in the child_process options.

License

MIT © Sindre Sorhus