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

feat: default to current working directory when no plugins are provided #15

Merged
merged 3 commits into from
Feb 2, 2021
Merged

feat: default to current working directory when no plugins are provided #15

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
38e78de
feat: default to current working directory when no plugins are provided
mdonnalley Feb 2, 2021
0e1c729
chore: code review
mdonnalley Feb 2, 2021
10172cf
chore: code review
mdonnalley Feb 2, 2021
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
2 changes: 1 addition & 1 deletion messages/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"commandDescription": "generate the command reference guide located",
"pluginFlagDescription": "comma separated list of plugin names to be part of the generation",
"pluginFlagDescription": "comma separated list of plugin names to be part of the generation. Defaults to the current working directory if it's a valid oclif plugin.",
Copy link
Contributor

Choose a reason for hiding this comment

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

Still sounds weird to me because this is a plugin list, and you are saying it defaults to the current working directory which is a file path, not a plugin. Maybe defaults to the oclif plugin in the current working directory

"hiddenFlagDescription": "show hidden commands",
"outputdirFlagDescription": "output directory to put generated files",
"erroronwarningFlagDescription": "fail the command if there are any warnings"
Expand Down
28 changes: 22 additions & 6 deletions src/commands/commandreference/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@

import { IPlugin } from '@oclif/config';
import { flags, SfdxCommand } from '@salesforce/command';
import { Messages, SfdxError } from '@salesforce/core';
import { AnyJson, Dictionary, ensure, JsonMap } from '@salesforce/ts-types';
import { fs, Messages, SfdxError } from '@salesforce/core';
import { AnyJson, Dictionary, ensure, getString, JsonMap } from '@salesforce/ts-types';
import chalk = require('chalk');
import * as os from 'os';
import * as path from 'path';
import { Ditamap } from '../../ditamap/ditamap';
import { Docs } from '../../docs';
import { events, mergeDeep } from '../../utils';
Expand All @@ -34,15 +36,29 @@ export default class CommandReferenceGenerate extends SfdxCommand {
}),
plugins: flags.array({
char: 'p',
description: messages.getMessage('pluginFlagDescription'),
required: true
description: messages.getMessage('pluginFlagDescription')
}),
hidden: flags.boolean({ description: messages.getMessage('hiddenFlagDescription') }),
erroronwarnings: flags.boolean({ description: messages.getMessage('erroronwarningFlagDescription') })
};

public async run(): Promise<AnyJson> {
const plugins = this.flags.plugins
let pluginNames: string[];
if (!this.flags.plugins) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add some error messaging? For example, I can do sfdx plugins:install command-reference then sfdx commandreference:generate in any directory I want.

const pJsonPath = path.join(process.cwd(), 'package.json');
if (await fs.fileExists(pJsonPath)) {
const packageJson = await fs.readJson(pJsonPath);
pluginNames = [getString(packageJson, 'name')];
} else {
throw new SfdxError(
'No package.json found in current working directory. Please cd into a directory that contains a valid oclif plugin'
Copy link
Contributor

Choose a reason for hiding this comment

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

No plugins provided. Provide the '--plugins' flag or cd into a directory that contains a valid oclif plugin.

);
}
} else {
pluginNames = this.flags.plugins;
}

const plugins = pluginNames
.map(plugin => plugin.trim())
.map(name => {
let pluginName = name;
Expand All @@ -57,7 +73,7 @@ export default class CommandReferenceGenerate extends SfdxCommand {
}
return pluginName;
});

this.ux.log(`Generating command refernce for the following plugins:${plugins.map(name => `${os.EOL} - ${name}`)}`);
Ditamap.outputDir = this.flags.outputdir;

Ditamap.cliVersion = this.config.version.replace(/-[0-9a-zA-Z]+$/, '');
Expand Down