Skip to content

Fix help information for react-native-cli commands #9173

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

Closed
rozele wants to merge 3 commits into from
Closed

Fix help information for react-native-cli commands #9173

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c60dcf9
Fix help information for react-native-cli commands
rozele Aug 2, 2016
5b89e19
Adding back deleted code for examples.
rozele Aug 3, 2016
9fb4645
Fix CLI help when examples property is present.
rozele Aug 3, 2016
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
10 changes: 6 additions & 4 deletions local-cli/cliEntry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,13 @@ function printHelpInformation() {
cmdName = cmdName + '|' + this._alias;
}

const usage = this.usage();
const usageIsString = typeof(usage) === 'string';
const usageString = usageIsString ? usage : '[options]';
Copy link
Contributor Author

@rozele rozele Aug 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's going to be an issue with this eventually. For example, how does one add an examples section to the link command? If you did add examples, you'd lose the original usage() value ([options] [packageName]).


let output = [
'',
chalk.bold(chalk.cyan((` react-native ${cmdName} [options]`))),
chalk.bold(chalk.cyan((` react-native ${cmdName} ${usageString}`))),
` ${this._description}`,
'',
` ${chalk.bold('Options:')}`,
Expand All @@ -62,9 +66,7 @@ function printHelpInformation() {
'',
];

const usage = this.usage();

if (usage !== '[options]') {
if (!usageIsString) {
const formattedUsage = usage.map(
example => ` ${example.desc}: \n ${chalk.cyan(example.cmd)}`,
).join('\n\n');
Expand Down