mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
4ed038808f
PR-URL: https://github.com/nodejs/node/pull/5369 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
# 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.
|
|
|
|
[](https://travis-ci.org/ForbesLindesay/cmd-shim)
|
|
[](https://david-dm.org/ForbesLindesay/cmd-shim)
|
|
[](https://www.npmjs.com/package/cmd-shim)
|
|
|
|
## Installation
|
|
|
|
```
|
|
npm install cmd-shim
|
|
```
|
|
|
|
## API
|
|
|
|
### cmdShim(from, to, cb)
|
|
|
|
Create a cmd shim at `to` for the command line program at `from`.
|
|
e.g.
|
|
|
|
```javascript
|
|
var cmdShim = require('cmd-shim');
|
|
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', function (err) {
|
|
if (err) throw err;
|
|
});
|
|
```
|
|
|
|
### cmdShim.ifExists(from, to, cb)
|
|
|
|
The same as above, but will just continue if the file does not exist.
|
|
Source:
|
|
|
|
```javascript
|
|
function cmdShimIfExists (from, to, cb) {
|
|
fs.stat(from, function (er) {
|
|
if (er) return cb()
|
|
cmdShim(from, to, cb)
|
|
})
|
|
}
|
|
```
|