node-alias

Alias the long version of a command to the short version, with optional messaging.

A very simple module for aliasing a command; works well with commander.js and commander.js-error.

To demonstrate, here is an example from npm-publish-release; in file bin/npm-publish-release.js:

require('node-alias')('npr', __dirname);

Produces:

$ npm-publish-release
[INFO]: You can also use 'npr' as an alias.
... # runs command

Git style sub-commands

Also works with git(1) style sub-commands. Here is an example from gh-release-manager; in file bin/gh-release-manager.js:

require('node-alias')('grm jsdoc', __dirname);

Assumes a file by the same name, converted to kebab-case, exists in the same location (i.e. bin/grm-jsdoc.js). If needed, a separate location can be specified using the path option.

alias(short, path, options)

short {string} - The short command name. must be a file in path by the same name (as far as require is concerned).
path {string} - The path where the short command file actually exists. Pass __dirname to use the same directory (i.e. when using Git style sub-commands to pair with commander.js.
options {object} - Additional options to customize the behavior.

Options

message {mixed} - Can be true, false, or a custom message. If set to true, displays a default message. Defaults to true.
color {string} - Specify a custom chalk color for the message. Ignored if message === false.

Contributing

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Current Tags

1.0.4 ... latest (9 years ago)

5 Versions

1.0.4 ... 9 years ago
1.0.3 ... 9 years ago
1.0.2 ... 9 years ago
1.0.1 ... 9 years ago
1.0.0 ... 9 years ago