@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/promise-utils';
protected async init() {
OclifUtils.prependCliToExamples(this);
return super.init();
}
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/promise-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 prependCliToExamples: prependCliToExamples = OclifUtils.prependCliToExamples
▸ getCommandConfig(commandInstance: Command): Command
| Name | Type |
|---|---|
commandInstance | Command |
Returns: Command
@handy-common-utils/oclif-utils
Globals / OclifUtils
▸ Static generateHelpText(commandInstance: Command, opts?: Partial<HelpOptions>): string
Generate formatted text content of help to a command
| Name | Type | Description |
|---|---|---|
commandInstance | Command | instance of the Command |
opts? | Partial<HelpOptions> | format options |
Returns: string
help content
▸ Static getCommandConfig(commandInstance: Command): Command
| Name | Type |
|---|---|
commandInstance | Command |
Returns: Command
▸ Static injectHelpTextIntoReadmeMd(commandInstance: Command, opts?: Partial<HelpOptions>): Promise<void>
| Name | Type |
|---|---|
commandInstance | Command |
opts? | Partial<HelpOptions> |
Returns: Promise<void>
▸ 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
@handy-common-utils/oclif-utils
Globals / SingleCommandHelp
Help
↳ SingleCommandHelp
+ new SingleCommandHelp(commandInstance: Command, opts?: Partial<HelpOptions>): SingleCommandHelp
Overrides void
| Name | Type |
|---|---|
commandInstance | Command |
opts? | 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 17 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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.