Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heapwolf/complete
Does your Node.js command line program have lots of arguments? Add custom tab completion!
https://github.com/heapwolf/complete
Last synced: 12 days ago
JSON representation
Does your Node.js command line program have lots of arguments? Add custom tab completion!
- Host: GitHub
- URL: https://github.com/heapwolf/complete
- Owner: heapwolf
- Created: 2011-08-30T19:10:50.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2015-07-14T16:30:59.000Z (over 9 years ago)
- Last Synced: 2024-10-18T16:05:57.961Z (26 days ago)
- Language: JavaScript
- Homepage:
- Size: 284 KB
- Stars: 165
- Watchers: 8
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Synopsis
Custom command line tab completion for node.js applications.
# Example
```javascript
#!/usr/bin/env node
var complete = require('complete'); // get the `complete` module.
//
// list of items to complete on.
//
complete.list = ['apple', 'orange', 'pear', 'lemon', 'mango'];
complete.callback = function(lastSelection, userInput, reducedList) {
if (lastSelection === 'apple') {
complete.add('sauce');
}
};
complete.init();
//
// continue with the application...
//
console.log('program started with the following arguments:', process.argv[2] || 'none provided');
```
# Distribution and Installation
Your installment procedure should place your CLI program in a location made accessible by the `PATH` variable. If users install your program with the NPM `-g` option, your program will be in the path.
``` bash
/usr/local/bin/myprogram -> /usr/local/lib/node_modules/myprogram/bin/myprogram
```
# API
## list
Create a list of commands that you want to autocomplete with.
```javascript
complete.list = ['apple', 'orange', 'pear', 'lemon', 'mango'];
```
## callback
Optionally you can define a callback that will get called when the match when the completion happens.
```javascript
complete.callback = function(lastSelection, userInput, reducedList) {
//
// do something if this is an `orange`. Note that anything that
// you `process.stdout.write()` will be added to the auto complete
// list.
//
};
```
## init()
Initialize the auto completion behavior.
```javascript
complete.init();
```
## Higher Level Example
``` js
var complete = require('complete');
complete({
program: 'my-program',
// Commands
commands: {
'hello': function(words, prev, cur) {
complete.output(cur, ['abc', 'def']);
},
'world': {
'hi': function(words, prev, cur) {
complete.echo('next');
}
}
},
// Position-independent options.
// These will attempted to be
// matched if `commands` fails
// to match.
options: {
'--help': {},
'-h': {},
'--version': {},
'-v': {}
}
});
```
## The above results in
``` bash
$ my-program he
$ my-program hello
$ my-program hello a
$ my-program hello abc
```
# License
(The MIT License)
Copyright (c) 2010 hij1nx
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.