Skip to content

Commit

Permalink
extract help command
Browse files Browse the repository at this point in the history
  • Loading branch information
voxsim committed Feb 1, 2017
1 parent c9050b8 commit 36aec1c
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 22 deletions.
40 changes: 40 additions & 0 deletions src/cli/commands/help.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/* @flow */

import * as commands from './index.js';
import type {Reporter} from '../../reporters/index.js';
import type Config from '../../config.js';
import NpmRegistry from '../../registries/npm-registry.js';
import parsePackageName from '../../util/parse-package-name.js';
import {sortAlpha, hyphenate} from '../../util/misc.js';
const chalk = require('chalk');

export async function run(
config: Config,
reporter: Reporter,
commander: Object,
args: Array<string>,
): Promise<void> {
const getDocsLink = (name) => `https://yarnpkg.com/en/docs/cli/${name || ''}`;
const getDocsInfo = (name) => 'Visit ' + chalk.bold(getDocsLink(name)) + ' for documentation about this command.';

if (args.length) {
const helpCommand = hyphenate(args[0]);
if (commands[helpCommand]) {
commander.on('--help', () => console.log(' ' + getDocsInfo(helpCommand) + '\n'));
}
} else {
commander.on('--help', () => {
console.log(' Commands:\n');
for (const name of Object.keys(commands).sort(sortAlpha)) {
if (commands[name].useless) {
continue;
}

console.log(` - ${hyphenate(name)}`);
}
console.log('\n Run `' + chalk.bold('yarn help COMMAND') + '` for more information on specific commands.');
console.log(' Visit ' + chalk.bold(getDocsLink()) + ' to learn more about Yarn.\n');
});
}
commander.help();
}
1 change: 1 addition & 0 deletions src/cli/commands/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import * as clean from './clean.js'; export {clean};
import * as config from './config.js'; export {config};
import * as generateLockEntry from './generate-lock-entry.js'; export {generateLockEntry};
import * as global from './global.js'; export {global};
import * as help from './help.js'; export {help};
import * as info from './info.js'; export {info};
import * as init from './init.js'; export {init};
import * as install from './install.js'; export {install};
Expand Down
25 changes: 3 additions & 22 deletions src/cli/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,27 +98,8 @@ const getDocsLink = (name) => `https://yarnpkg.com/en/docs/cli/${name || ''}`;
const getDocsInfo = (name) => 'Visit ' + chalk.bold(getDocsLink(name)) + ' for documentation about this command.';

//
if (commandName === 'help' || commandName === '--help' || commandName === '-h') {
if (commandName === '--help' || commandName === '-h') {
commandName = 'help';
if (args.length) {
const helpCommand = hyphenate(args[0]);
if (commands[helpCommand]) {
commander.on('--help', () => console.log(' ' + getDocsInfo(helpCommand) + '\n'));
}
} else {
commander.on('--help', () => {
console.log(' Commands:\n');
for (const name of Object.keys(commands).sort(sortAlpha)) {
if (commands[name].useless) {
continue;
}

console.log(` - ${hyphenate(name)}`);
}
console.log('\n Run `' + chalk.bold('yarn help COMMAND') + '` for more information on specific commands.');
console.log(' Visit ' + chalk.bold(getDocsLink()) + ' to learn more about Yarn.\n');
});
}
}

// if no args or command name looks like a flag then default to `install`
Expand Down Expand Up @@ -159,7 +140,7 @@ if (command && typeof command.setFlags === 'function') {
command.setFlags(commander);
}

if (commandName === 'help' || args.indexOf('--help') >= 0 || args.indexOf('-h') >= 0) {
if (args.indexOf('--help') >= 0 || args.indexOf('-h') >= 0) {
const examples: Array<string> = (command && command.examples) || [];
if (examples.length) {
commander.on('--help', () => {
Expand Down Expand Up @@ -216,7 +197,7 @@ if (typeof command.hasWrapper === 'function') {
if (commander.json) {
outputWrapper = false;
}
if (outputWrapper) {
if (outputWrapper && commandName !== 'help') {
reporter.header(commandName, pkg);
}

Expand Down

0 comments on commit 36aec1c

Please sign in to comment.