@zkochan/cmd-shim 5.2.1 → 5.3.1

package/LICENSE

@@ -1,27 +1,27 @@
-Copyright (c) Isaac Z. Schlueter ("Author")
-All rights reserved.
-
-The BSD License
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
-BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
-BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) Isaac Z. Schlueter ("Author")
+All rights reserved.
+
+The BSD License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,51 +1,52 @@
-# @zkochan/cmd-shim
-
-> Used in pnpm for command line application support
-
-<!--@shields('travis', 'appveyor', 'npm')-->
-[![Build Status](https://img.shields.io/travis/pnpm/cmd-shim/master.svg)](https://travis-ci.org/pnpm/cmd-shim) [![Build Status on Windows](https://img.shields.io/appveyor/ci/zkochan/cmd-shim-8ah3a/master.svg)](https://ci.appveyor.com/project/zkochan/cmd-shim-8ah3a/branch/master) [![npm version](https://img.shields.io/npm/v/@zkochan/cmd-shim.svg)](https://www.npmjs.com/package/@zkochan/cmd-shim)
-<!--/@-->
-
-The cmd-shim used in [pnpm](https://github.com/rstacruz/pnpm) to create executable scripts.
-
-## Installation
-
-```sh
-npm install --save @zkochan/cmd-shim
-```
-
-## API
-
-### `cmdShim(src, to, opts?): Promise<void>`
-
-Create a cmd shim at `to` for the command line program at `from`.
-e.g.
-
-```javascript
-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-symlinks` is added to the options passed to NodeJS.
-- `opts.nodePath` - _String_ - sets the [NODE_PATH](https://nodejs.org/api/cli.html#cli_node_path_path) env variable.
-- `opts.nodeExecPath` - _String_ - sets the path to the Node.js executable.
-- `opts.createCmdFile` - _Boolean_ - is `true` on Windows by default. If true, creates a cmd file.
-- `opts.createPwshFile` - _Boolean_ - is `true` by default. If true, creates a powershell file.
-- `opts.progArgs` - String - optional arguments that will be prepend to any CLI arguments
-
-```javascript
-const cmdShim = require('@zkochan/cmd-shim')
-cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
-  .catch(err => console.error(err))
-```
-
-## License
-
-[BSD-2-Clause](./LICENSE) © [Zoltan Kochan](http://kochan.io)
+# @zkochan/cmd-shim
+
+> Used in pnpm for command line application support
+
+<!--@shields('travis', 'appveyor', 'npm')-->
+[![Build Status](https://img.shields.io/travis/pnpm/cmd-shim/master.svg)](https://travis-ci.org/pnpm/cmd-shim) [![Build Status on Windows](https://img.shields.io/appveyor/ci/zkochan/cmd-shim-8ah3a/master.svg)](https://ci.appveyor.com/project/zkochan/cmd-shim-8ah3a/branch/master) [![npm version](https://img.shields.io/npm/v/@zkochan/cmd-shim.svg)](https://www.npmjs.com/package/@zkochan/cmd-shim)
+<!--/@-->
+
+The cmd-shim used in [pnpm](https://github.com/rstacruz/pnpm) to create executable scripts.
+
+## Installation
+
+```sh
+npm install --save @zkochan/cmd-shim
+```
+
+## API
+
+### `cmdShim(src, to, opts?): Promise<void>`
+
+Create a cmd shim at `to` for the command line program at `from`.
+e.g.
+
+```javascript
+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-symlinks` is added to the options passed to NodeJS.
+- `opts.nodePath` - _String_ - sets the [NODE_PATH](https://nodejs.org/api/cli.html#cli_node_path_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_ - is `true` on Windows by default. If true, creates a cmd file.
+- `opts.createPwshFile` - _Boolean_ - is `true` by default. If true, creates a powershell file.
+- `opts.progArgs` - String - optional arguments that will be prepend to any CLI arguments
+
+```javascript
+const cmdShim = require('@zkochan/cmd-shim')
+cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
+  .catch(err => console.error(err))
+```
+
+## License
+
+[BSD-2-Clause](./LICENSE) © [Zoltan Kochan](http://kochan.io)

package/index.d.ts

@@ -1,73 +1,74 @@
-declare namespace cmdShim {
-    interface Options {
-        /**
-         * If a PowerShell script should be created.
-         *
-         * @default true
-         */
-        createPwshFile?: boolean;
-        /**
-         * If a Windows Command Prompt script should be created.
-         *
-         * @default false
-         */
-        createCmdFile?: boolean;
-        /**
-         * If symbolic links should be preserved.
-         *
-         * @default false
-         */
-        preserveSymlinks?: boolean;
-        /**
-         * The path to the executable file.
-         */
-        prog?: string;
-        /**
-         * The arguments to initialize the `node` process with.
-         */
-        args?: string;
-        /**
-         * The arguments to initialize the target process with, before the actual CLI arguments
-         */
-        progArgs?: string[];
-        /**
-         * The value of the $NODE_PATH environment variable.
-         *
-         * The single `string` format is only kept for legacy compatibility,
-         * and the array form should be preferred.
-         */
-        nodePath?: string | string[];
-        /**
-         * fs implementation to use.  Must implement node's `fs` module interface.
-         */
-        fs?: typeof import('fs');
-        nodeExecPath?: string;
-    }
-}
-declare type Options = cmdShim.Options;
-export = cmdShim;
-/**
- * Try to create shims.
- *
- * @param src Path to program (executable or script).
- * @param to Path to shims.
- * Don't add an extension if you will create multiple types of shims.
- * @param opts Options.
- * @throws If `src` is missing.
- */
-declare function cmdShim(src: string, to: string, opts?: Options): Promise<void>;
-declare namespace cmdShim {
-    var ifExists: typeof cmdShimIfExists;
-}
-/**
- * Try to create shims.
- *
- * Does nothing if `src` doesn't exist.
- *
- * @param src Path to program (executable or script).
- * @param to Path to shims.
- * Don't add an extension if you will create multiple types of shims.
- * @param opts Options.
- */
-declare function cmdShimIfExists(src: string, to: string, opts?: Options): Promise<void>;
+declare namespace cmdShim {
+    interface Options {
+        /**
+         * If a PowerShell script should be created.
+         *
+         * @default true
+         */
+        createPwshFile?: boolean;
+        /**
+         * If a Windows Command Prompt script should be created.
+         *
+         * @default false
+         */
+        createCmdFile?: boolean;
+        /**
+         * If symbolic links should be preserved.
+         *
+         * @default false
+         */
+        preserveSymlinks?: boolean;
+        /**
+         * The path to the executable file.
+         */
+        prog?: string;
+        /**
+         * The arguments to initialize the `node` process with.
+         */
+        args?: string;
+        /**
+         * The arguments to initialize the target process with, before the actual CLI arguments
+         */
+        progArgs?: string[];
+        /**
+         * The value of the $NODE_PATH environment variable.
+         *
+         * The single `string` format is only kept for legacy compatibility,
+         * and the array form should be preferred.
+         */
+        nodePath?: string | string[];
+        /**
+         * fs implementation to use.  Must implement node's `fs` module interface.
+         */
+        fs?: typeof import('fs');
+        nodeExecPath?: string;
+        prependToPath?: string;
+    }
+}
+declare type Options = cmdShim.Options;
+export = cmdShim;
+/**
+ * Try to create shims.
+ *
+ * @param src Path to program (executable or script).
+ * @param to Path to shims.
+ * Don't add an extension if you will create multiple types of shims.
+ * @param opts Options.
+ * @throws If `src` is missing.
+ */
+declare function cmdShim(src: string, to: string, opts?: Options): Promise<void>;
+declare namespace cmdShim {
+    var ifExists: typeof cmdShimIfExists;
+}
+/**
+ * Try to create shims.
+ *
+ * Does nothing if `src` doesn't exist.
+ *
+ * @param src Path to program (executable or script).
+ * @param to Path to shims.
+ * Don't add an extension if you will create multiple types of shims.
+ * @param opts Options.
+ */
+declare function cmdShimIfExists(src: string, to: string, opts?: Options): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAWA,kBAAU,OAAO,CAAC;IAChB,UAAiB,OAAO;QACtB;;;;WAIG;QACH,cAAc,CAAC,EAAE,OAAO,CAAA;QAExB;;;;WAIG;QACH,aAAa,CAAC,EAAE,OAAO,CAAA;QAEvB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QAEnB;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;QAE5B;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,IAAI,CAAC,CAAA;QAKxB,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB;CACF;AACD,aAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAE9B,SAAS,OAAO,CAAA;AAqEhB;;;;;;;;GAQG;AACH,iBAAe,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAI9E;kBAJc,OAAO;;;AAMtB;;;;;;;;;GASG;AACH,iBAAS,eAAe,CAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAWA,kBAAU,OAAO,CAAC;IAChB,UAAiB,OAAO;QACtB;;;;WAIG;QACH,cAAc,CAAC,EAAE,OAAO,CAAA;QAExB;;;;WAIG;QACH,aAAa,CAAC,EAAE,OAAO,CAAA;QAEvB;;;;WAIG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QAEnB;;;;;WAKG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;QAE5B;;WAEG;QACH,EAAE,CAAC,EAAE,cAAc,IAAI,CAAC,CAAA;QAKxB,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB;CACF;AACD,aAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAE9B,SAAS,OAAO,CAAA;AAqEhB;;;;;;;;GAQG;AACH,iBAAe,OAAO,CAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAG9E;kBAHc,OAAO;;;AAKtB;;;;;;;;;GASG;AACH,iBAAS,eAAe,CAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhF"}