Package Exports
- @zkochan/cmd-shim
- @zkochan/cmd-shim/index.js
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 (@zkochan/cmd-shim) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@zkochan/cmd-shim
Used in pnpm for command line application support
The cmd-shim used in pnpm to create executable scripts.
Installation
npm install --save @zkochan/cmd-shimAPI
cmdShim(src, to, opts?): Promise<void>
Create a cmd shim at to for the command line program at from.
e.g.
const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name')
.catch(err => console.error(err))cmdShim.ifExists(src, to, opts?): Promise<void>
The same as above, but will just continue if the file does not exist.
Arguments:
opts.preserveSymlinks- Boolean - if true,--preserve-symlinksis added to the options passed to NodeJS.opts.nodePath- String - sets the NODE_PATH env variable.opts.prependToPath- String - prepends the passed path to PATH before executing the Node.js program.opts.nodeExecPath- String - sets the path to the Node.js executable.opts.createCmdFile- Boolean - istrueon Windows by default. If true, creates a cmd file.opts.createPwshFile- Boolean - istrueby default. If true, creates a powershell file.opts.progArgs- String - optional arguments that will be prepend to any CLI arguments
const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
.catch(err => console.error(err))