Package Exports

@zkochan/cmd-shim

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

The cmd-shim used in npm to create executable scripts on Windows, since symlinks are not suitable for this purpose there.

On Unix systems, you should use a symbolic link instead.

Installation

npm install --save @zkochan/cmd-shim

API

cmdShim(from, to, opts?, cb)

Create a cmd shim at to for the command line program at from. e.g.

var cmdShim = require('@zkochan/cmd-shim');
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', function (err) {
  if (err) throw err;
});

cmdShim.ifExists(from, to, opts?, cb)

The same as above, but will just continue if the file does not exist. Source:

function cmdShimIfExists (from, to, cb) {
  fs.stat(from, function (er) {
    if (er) return cb()
    cmdShim(from, to, cb)
  })
}

opts

opts.preserveSymlinks - Boolean - if true, --preserve-symlinks is added to the options passed to NodeJS.

var cmdShim = require('@zkochan/cmd-shim');
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true }, function (err) {
  if (err) throw err;
});