package/LICENSE000664 0000002071 3560116604 010267 0ustar00000000 000000 The MIT License (MIT) Copyright (c) 2014 Matteo Collina 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. package/example.js000664 0000001235 3560116604 011254 0ustar00000000 000000 'use strict' const program = require('./')() const minimist = require('minimist') const result = program .register('abcd', function (args) { console.log('just do', args) }) .register({ command: 'restore', strict: true }, function (args) { console.log('restore', args) }) .register('args', function (args) { args = minimist(args) console.log('just do', args) }) .register('abcde code', function (args) { console.log('doing something', args) }) .register('another command', function (args) { console.log('anothering', args) }) .parse(process.argv.splice(2)) if (result) { console.log('no command called, args', result) } package/index.js000664 0000007240 3560116604 010732 0ustar00000000 000000 /* The MIT License (MIT) Copyright (c) 2014-2021 Matteo Collina 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. */ 'use strict' const leven = require('leven') function commist () { const commands = [] function lookup (array) { if (typeof array === 'string') { array = array.split(' ') } return commands.map(function (cmd) { return cmd.match(array) }).filter(function (match) { return match.partsNotMatched === 0 }).sort(function (a, b) { if (a.inputNotMatched > b.inputNotMatched) { return 1 } if (a.inputNotMatched === b.inputNotMatched && a.totalDistance > b.totalDistance) { return 1 } return -1 }).map(function (match) { return match.cmd }) } function parse (args) { const matching = lookup(args) if (matching.length > 0) { matching[0].call(args) // return null if there is nothing left to do return null } return args } function register (inputCommand, func) { let commandOptions = { command: inputCommand, strict: false, func: func } if (typeof inputCommand === 'object') { commandOptions = Object.assign(commandOptions, inputCommand) } const matching = lookup(commandOptions.command) matching.forEach(function (match) { if (match.string === commandOptions.command) { throw new Error('command already registered: ' + commandOptions.command) } }) commands.push(new Command(commandOptions)) return this } return { register: register, parse: parse, lookup: lookup } } function Command (options) { this.string = options.command this.strict = options.strict this.parts = this.string.split(' ') this.length = this.parts.length this.func = options.func this.parts.forEach(function (part) { if (part.length < 3) { throw new Error('command words must be at least 3 chars: ' + options.command) } }) } Command.prototype.call = function call (argv) { this.func(argv.slice(this.length)) } Command.prototype.match = function match (string) { return new CommandMatch(this, string) } function CommandMatch (cmd, array) { this.cmd = cmd this.distances = cmd.parts.map(function (elem, i) { if (array[i] !== undefined) { if (cmd.strict) { return elem === array[i] ? 0 : undefined } else { return leven(elem, array[i]) } } else { return undefined } }).filter(function (distance, i) { return distance !== undefined && distance < cmd.parts[i].length - 2 }) this.partsNotMatched = cmd.length - this.distances.length this.inputNotMatched = array.length - this.distances.length this.totalDistance = this.distances.reduce(function (acc, i) { return acc + i }, 0) } module.exports = commist package/test.js000664 0000010264 3560116604 010602 0ustar00000000 000000 'use strict' const test = require('tape').test const commist = require('./') test('registering a command', function (t) { t.plan(2) const program = commist() program.register('hello', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) const result = program.parse(['hello', 'a', '-x', '23']) t.notOk(result, 'must return null, the command have been handled') }) test('registering two commands', function (t) { t.plan(1) const program = commist() program.register('hello', function (args) { t.ok(false, 'must pick the right command') }) program.register('world', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) program.parse(['world', 'a', '-x', '23']) }) test('registering two commands (bis)', function (t) { t.plan(1) const program = commist() program.register('hello', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) program.register('world', function (args) { t.ok(false, 'must pick the right command') }) program.parse(['hello', 'a', '-x', '23']) }) test('registering two words commands', function (t) { t.plan(1) const program = commist() program.register('hello', function (args) { t.ok(false, 'must pick the right command') }) program.register('hello world', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) program.parse(['hello', 'world', 'a', '-x', '23']) }) test('registering two words commands (bis)', function (t) { t.plan(1) const program = commist() program.register('hello', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) program.register('hello world', function (args) { t.ok(false, 'must pick the right command') }) program.parse(['hello', 'a', '-x', '23']) }) test('registering ambiguous commands throws exception', function (t) { const program = commist() function noop () {} program.register('hello', noop) program.register('hello world', noop) program.register('hello world matteo', noop) try { program.register('hello world', noop) t.ok(false, 'must throw if double-registering the same command') } catch (err) { } t.end() }) test('looking up commands', function (t) { const program = commist() function noop1 () {} function noop2 () {} function noop3 () {} program.register('hello', noop1) program.register('hello world matteo', noop3) program.register('hello world', noop2) t.equal(program.lookup('hello')[0].func, noop1) t.equal(program.lookup('hello world matteo')[0].func, noop3) t.equal(program.lookup('hello world')[0].func, noop2) t.end() }) test('looking up commands with abbreviations', function (t) { const program = commist() function noop1 () {} function noop2 () {} function noop3 () {} program.register('hello', noop1) program.register('hello world matteo', noop3) program.register('hello world', noop2) t.equal(program.lookup('hel')[0].func, noop1) t.equal(program.lookup('hel wor mat')[0].func, noop3) t.equal(program.lookup('hel wor')[0].func, noop2) t.end() }) test('looking up strict commands', function (t) { const program = commist() function noop1 () {} function noop2 () {} program.register({ command: 'restore', strict: true }, noop1) program.register({ command: 'rest', strict: true }, noop2) t.equal(program.lookup('restore')[0].func, noop1) t.equal(program.lookup('rest')[0].func, noop2) t.equal(program.lookup('remove')[0], undefined) t.end() }) test('executing commands from abbreviations', function (t) { t.plan(1) const program = commist() program.register('hello', function (args) { t.deepEqual(args, ['a', '-x', '23']) }) program.register('hello world', function (args) { t.ok(false, 'must pick the right command') }) program.parse(['hel', 'a', '-x', '23']) }) test('a command must be at least 3 chars', function (t) { const program = commist() function noop1 () {} try { program.register('h', noop1) t.ok(false, 'not thrown') } catch (err) { } t.end() }) test('a command part must be at least 3 chars', function (t) { const program = commist() function noop1 () {} try { program.register('h b', noop1) t.ok(false, 'not thrown') } catch (err) { } t.end() }) package/package.json000664 0000001300 3560116604 011542 0ustar00000000 000000 { "name": "commist", "version": "2.0.0", "description": "Build your commands on minimist!", "main": "index.js", "scripts": { "test": "standard && tape test.js" }, "pre-commit": "test", "repository": { "type": "git", "url": "https://github.com/mcollina/commist.git" }, "author": "Matteo Collina ", "license": "MIT", "bugs": { "url": "https://github.com/mcollina/commist/issues" }, "homepage": "https://github.com/mcollina/commist", "dependencies": { "leven": "^3.1.0", "minimist": "^1.1.0" }, "devDependencies": { "minimist": "^1.1.0", "pre-commit": "^1.0.0", "standard": "^16.0.0", "tape": "^5.0.0" } } package/README.md000664 0000003053 3560116604 010542 0ustar00000000 000000 commist ======= [![Build Status](https://travis-ci.com/mcollina/commist.svg?branch=master)](https://travis-ci.com/mcollina/commist) Build command line application with multiple commands the easy way. To be used with [minimist](http://npm.im/minimist). ```js var program = require('commist')() , minimist = require('minimist') , result result = program .register('abcd', function(args) { console.log('just do', args) }) .register({ command: 'restore', equals: true }, function(args) { console.log('restore', args) }) .register('args', function(args) { args = minimist(args) console.log('just do', args) }) .register('abcde code', function(args) { console.log('doing something', args) }) .register('another command', function(args) { console.log('anothering', args) }) .parse(process.argv.splice(2)) if (result) { console.log('no command called, args', result) } ``` When calling _commist_ programs, you can abbreviate down to three char words. In the above example, these are valid commands: ``` node example.js abc node example.js abc cod node example.js anot comm ``` Moreover, little spelling mistakes are corrected too: ``` node example.js abcs cod ``` If you want that the command must be strict equals, you can register the command with the json configuration: ```js program.register({ command: 'restore', strict: true }, function(args) { console.log('restore', args) }) ``` Acknowledgements ---------------- This project was kindly sponsored by [nearForm](http://nearform.com). License ------- MIT package/.github/workflows/ci.yml000664 0000000702 3560116604 013774 0ustar00000000 000000 name: ci on: [push, pull_request] jobs: test: runs-on: ubuntu-latest strategy: matrix: node-version: [10.x, 12.x, 14.x, 16.x] steps: - uses: actions/checkout@v2 - name: Use Node.js uses: actions/setup-node@v1 with: node-version: ${{ matrix.node-version }} - name: Install run: | npm install - name: Run tests run: | npm run test