Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggest matching commands if the user makes a typo #358

Merged
merged 6 commits into from
Jun 12, 2019
Merged

Suggest matching commands if the user makes a typo #358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1b84e23
feat: suggest matching commands
jamesgeorge007 Jun 3, 2019
ca1847c
Minor refactor
jamesgeorge007 Jun 4, 2019
98f9fb8
Enclose suggested command within quotes
jamesgeorge007 Jun 4, 2019
e26f4d1
avoid dedicated method for command suggestion purpose
jamesgeorge007 Jun 5, 2019
f31fd51
yarn.lock
jamesgeorge007 Jun 5, 2019
3791361
Add type definitions for didyoumean.js
jamesgeorge007 Jun 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
"cheerio": "^1.0.0-rc.1",
"commander": "^2.8.1",
"denodeify": "^1.2.1",
"didyoumean": "^1.2.1",
jamesgeorge007 marked this conversation as resolved.
Show resolved Hide resolved
"glob": "^7.0.6",
"lodash": "^4.17.10",
"markdown-it": "^8.3.1",
Expand All @@ -58,6 +59,7 @@
"@types/cheerio": "^0.22.1",
"@types/commander": "^2.12.2",
"@types/denodeify": "^1.2.31",
"@types/didyoumean": "^1.2.0",
"@types/glob": "^7.1.1",
"@types/lodash": "^4.14.123",
"@types/markdown-it": "0.0.2",
Expand All @@ -69,8 +71,8 @@
"@types/semver": "^6.0.0",
"@types/tmp": "^0.1.0",
"@types/xml2js": "^0.4.4",
"cpx": "^1.5.0",
"concurrently": "^4.1.0",
"cpx": "^1.5.0",
"mocha": "^5.2.0",
"source-map-support": "^0.4.2",
"typescript": "^3.4.3",
Expand Down
13 changes: 12 additions & 1 deletion src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import * as program from 'commander';
import * as didYouMean from 'didyoumean';

import { packageCommand, ls } from './package';
import { publish, unpublish } from './publish';
import { show } from './show';
Expand Down Expand Up @@ -127,7 +129,16 @@ module.exports = function (argv: string[]): void {

program
.command('*')
.action(() => program.help());
.action((cmd: string) => {
program.outputHelp();
log.error(`Unknown command ${cmd}`);

const availableCommands: string[] = program.commands.map(c => c._name);
const suggestion: string | string[] = didYouMean(cmd, availableCommands);
if (suggestion) {
log.warn(`Did you mean '${suggestion}'?`);
}
});

program.parse(argv);

Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,11 @@ detect-libc@^1.0.2:
resolved "https://registry.yarnpkg.com/detect-libc/-/detect-libc-1.0.3.tgz#fa137c4bd698edf55cd5cd02ac559f91a4c4ba9b"
integrity sha1-+hN8S9aY7fVc1c0CrFWfkaTEups=

didyoumean@^1.2.1:
version "1.2.1"
resolved "https://registry.yarnpkg.com/didyoumean/-/didyoumean-1.2.1.tgz#e92edfdada6537d484d73c0172fd1eba0c4976ff"
integrity sha1-6S7f2tplN9SE1zwBcv0eugxJdv8=

diff@3.5.0:
version "3.5.0"
resolved "https://registry.yarnpkg.com/diff/-/diff-3.5.0.tgz#800c0dd1e0a8bfbc95835c202ad220fe317e5a12"
Expand Down