@handy-common-utils/oclif-utils
Advanced tools
oclif (https://oclif.io/) related utilities
First add it as a dependency:
npm install @handy-common-utils/oclif-utils
Then you can use it in the code:
import { OclifUtils } from '@handy-common-utils/oclif-utils';
class AwsServerlessDataflow extends Command {
// You can use "typeof AwsServerlessDataflow.Options" in other places to refer to the type
static Options: CommandOptions<typeof AwsServerlessDataflow>
// ... other code ...
static flags = {
version: flags.version({ char: 'v' }),
help: flags.help({ char: 'h' }),
'update-readme.md': flags.boolean({ hidden: true, description: 'For developers only, don\'t use' }),
// ... other code ...
}
static examples = [
'^ -r ap-southeast-2 -s',
`^ -r ap-southeast-2 -s -i '*boi*' -i '*datahub*' \\
-x '*jameshu*' -c`,
`^ -r ap-southeast-2 -s -i '*lr-*' \\
-i '*lead*' -x '*slack*' -x '*lead-prioritization*' \\
-x '*lead-scor*' -x '*LeadCapture*' -c`,
];
protected async init() {
OclifUtils.prependCliToExamples(this); // "^" at the beginning of the examples will be replaced by the actual command
return super.init();
}
async run(argv?: string[]) {
const options = this.parse<CommandFlags<typeof AwsServerlessDataflow>, CommandArgs<typeof AwsServerlessDataflow>>(AwsServerlessDataflow, argv);
if (options.flags['update-readme.md']) {
OclifUtils.injectHelpTextIntoReadmeMd(this); // you need to have <!-- help start -->...<!-- help end --> in your README.md
return;
}
// This would be helpful if a complex command line needs to be shared
console.log(`Command line: ${OclifUtils.reconstructedcommandLine(this, options)}`);
// You can add this in the scripts section of your package.json: "preversion": "./bin/run --update-readme.md && git add README.md"
// ... other code ...
}
}
export = AwsServerlessDataflo
You can either import and use the class as shown above, or you can import individual functions directly like below:
import { prependCliToExamples } from '@handy-common-utils/oclif-utils';
@handy-common-utils/oclif-utils
Globals
Ƭ CommandArgNames<T>: T extends { name: infer A }[] ? A : never
| Name |
|---|
T |
Ƭ CommandArgs<T>: {}
| Name | Type |
|---|---|
T | { args: Array<{ name: string }> } |
Ƭ CommandFlags<T>: T extends Parser.Input<infer F> ? F : never
| Name |
|---|
T |
Ƭ CommandOptions<T>: Parser.Output<CommandFlags<T>, CommandArgs<T>>
| Name | Type |
|---|---|
T | { args: Array<{ name: string }> } |
• Const generateHelpText: generateHelpText = OclifUtils.generateHelpText
• Const injectHelpTextIntoReadmeMd: injectHelpTextIntoReadmeMd = OclifUtils.injectHelpTextIntoReadmeMd
• Const parseCommandLine: parseCommandLine = OclifUtils.parseCommandLine
• Const prependCliToExamples: prependCliToExamples = OclifUtils.prependCliToExamples
• Const reconstructCommandLine: reconstructCommandLine = OclifUtils.reconstructCommandLine
▸ getCommandConfig(commandInstance: Command): Command
| Name | Type |
|---|---|
commandInstance | Command |
Returns: Command
▸ ConstquoteIfNeeded(text: any): string
| Name | Type |
|---|---|
text | any |
Returns: string
@handy-common-utils/oclif-utils
Globals / OclifUtils
▸ Static generateHelpText(commandInstance: Command, options?: Partial<HelpOptions>): string
Generate formatted text content of help to a command
| Name | Type | Description |
|---|---|---|
commandInstance | Command | instance of the Command |
options? | Partial<HelpOptions> | format options |
Returns: string
help content
▸ Static getCommandConfig(commandInstance: Command): Command
| Name | Type |
|---|---|
commandInstance | Command |
Returns: Command
▸ Static injectHelpTextIntoReadmeMd(commandInstance: Command, options?: Partial<HelpOptions>): Promise<void>
| Name | Type |
|---|---|
commandInstance | Command |
options? | Partial<HelpOptions> |
Returns: Promise<void>
▸ Static parseCommandLine<T>(commandInstance: InstanceType<T>): CommandOptions<T>
| Name | Type |
|---|---|
T | { constructor: (...args: any) => any ; args: Array<{ name: string }> } |
| Name | Type |
|---|---|
commandInstance | InstanceType<T> |
Returns: CommandOptions<T>
▸ Static prependCliToExamples(commandInstance: Command): void
Use this function to prepend command line to examples.
This function needs to be called from init() function of the Command.
| Name | Type | Description |
|---|---|---|
commandInstance | Command | instance of the Command |
Returns: void
void
▸ Static reconstructCommandLine<T>(commandInstance: InstanceType<T>, options?: CommandOptions<T>): string
Reconstruct the command line from already parsed options.
| Name | Type |
|---|---|
T | { constructor: (...args: any) => any ; args: Array<{ name: string }> } |
| Name | Type | Description |
|---|---|---|
commandInstance | InstanceType<T> | When calling from the subclass of Command, just pass this |
options? | CommandOptions<T> | already parsed options |
Returns: string
the command line string corresponding to the parsed options
@handy-common-utils/oclif-utils
Globals / SingleCommandHelp
Help
↳ SingleCommandHelp
+ new SingleCommandHelp(commandInstance: Command, options?: Partial<HelpOptions>): SingleCommandHelp
Overrides void
| Name | Type |
|---|---|
commandInstance | Command |
options? | Partial<HelpOptions> |
Returns: SingleCommandHelp
• Protected commandInstance: Command
• Protected config: IConfig
Inherited from SingleCommandHelp.config
• Protected opts: HelpOptions
Inherited from SingleCommandHelp.opts
• render: (input: string) => string
Inherited from SingleCommandHelp.render
• Protectedget sortedCommands(): Plugin[]
Inherited from SingleCommandHelp.sortedCommands
Returns: Plugin[]
• Protectedget sortedTopics(): Topic[]
Inherited from SingleCommandHelp.sortedTopics
Returns: Topic[]
▸ Protectedcommand(command: Command): string
Inherited from SingleCommandHelp.command
deprecated used for readme generation
| Name | Type | Description |
|---|---|---|
command | Command | The command to generate readme help for |
Returns: string
the readme help string for the given command
▸ ProtectedformatCommand(command: Command): string
Inherited from SingleCommandHelp.formatCommand
| Name | Type |
|---|---|
command | Command |
Returns: string
▸ ProtectedformatCommands(commands: Command[]): string
Inherited from SingleCommandHelp.formatCommands
| Name | Type |
|---|---|
commands | Command[] |
Returns: string
▸ ProtectedformatRoot(): string
Inherited from SingleCommandHelp.formatRoot
Returns: string
▸ ProtectedformatTopic(topic: Topic): string
Inherited from SingleCommandHelp.formatTopic
| Name | Type |
|---|---|
topic | Topic |
Returns: string
▸ ProtectedformatTopics(topics: Topic[]): string
Inherited from SingleCommandHelp.formatTopics
| Name | Type |
|---|---|
topics | Topic[] |
Returns: string
▸ generateHelpText(): string
Returns: string
▸ showCommandHelp(command: Command): void
Inherited from SingleCommandHelp.showCommandHelp
Overrides void
| Name | Type |
|---|---|
command | Command |
Returns: void
▸ showHelp(argv: string[]): void
Inherited from SingleCommandHelp.showHelp
Overrides void
| Name | Type |
|---|---|
argv | string[] |
Returns: void
▸ ProtectedshowRootHelp(): void
Inherited from SingleCommandHelp.showRootHelp
Returns: void
▸ ProtectedshowTopicHelp(topic: Topic): void
Inherited from SingleCommandHelp.showTopicHelp
| Name | Type |
|---|---|
topic | Topic |
Returns: void
@handy-common-utils/oclif-utils
Globals / OclifHelpContent
• Optional aliases: undefined | string
• Optional args: undefined | string
• Optional description: undefined | string
• Optional examples: undefined | string
• Optional flags: undefined | string
• Optional usage: undefined | string
FAQs
oclif related utilities
The npm package @handy-common-utils/oclif-utils receives a total of 16 weekly downloads. As such, @handy-common-utils/oclif-utils popularity was classified as not popular.
We found that @handy-common-utils/oclif-utils demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.