Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(command): refactor help command
- Loading branch information
Showing
10 changed files
with
239 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,213 +1,26 @@ | ||
| import { encode } from 'https://deno.land/std@v0.52.0/encoding/utf8.ts'; | ||
| import { blue, bold, dim, magenta, red, yellow } from 'https://deno.land/std@v0.52.0/fmt/colors.ts'; | ||
| import { IFlagOptions, IFlags } from '../../flags/lib/types.ts'; | ||
| import { Table } from '../../table/lib/table.ts'; | ||
| import format from '../../x/format.ts'; | ||
| import { ArgumentsParser } from '../lib/arguments-parser.ts'; | ||
| import { IFlags } from '../../flags/lib/types.ts'; | ||
| import { BaseCommand } from '../lib/base-command.ts'; | ||
| import { IEnvVariable, IHelpCommand, IOption } from '../lib/types.ts'; | ||
| import { CommandListType } from '../types/command-list.ts'; | ||
| import { ParentCommandListType } from '../types/parent-command-list.ts'; | ||
|
|
||
| /** | ||
| * Generates well formatted and colored help output for specified command. | ||
| */ | ||
| export class HelpCommand extends BaseCommand implements IHelpCommand { | ||
|
|
||
| public constructor( protected parent: BaseCommand ) { | ||
| export class HelpCommand extends BaseCommand { | ||
|
|
||
| public constructor( cmd?: BaseCommand ) { | ||
| super(); | ||
|
|
||
| this | ||
| .type( 'command', new CommandListType() ) | ||
| this.type( 'command', new ParentCommandListType() ) | ||
| .arguments( '[command:command]' ) | ||
|
|
||
| .description( 'Show this help or the help of a sub-command.' ) | ||
|
|
||
| .action( ( flags: IFlags, name?: string ) => { | ||
| this.show( name ); | ||
| Deno.exit( 0 ); | ||
| } ); | ||
| } | ||
|
|
||
| public show( name?: string ) { | ||
| Deno.stdout.writeSync( encode( this.getHelp( name ) ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Render help output. | ||
| */ | ||
| public getHelp( name?: string ): string { | ||
|
|
||
| const cmd: BaseCommand | undefined = name ? this.parent.getCommand( name, false ) : this.parent; | ||
|
|
||
| if ( !cmd ) { | ||
| throw this.error( new Error( `Sub-command not found: ${ name }` ) ); | ||
| } | ||
|
|
||
| let output = ''; | ||
| const indent = 2; | ||
|
|
||
| const renderHelp = () => { | ||
|
|
||
| // Header | ||
| renderLine(); | ||
| output += Table.from( getHeader() ) | ||
| .indent( indent ) | ||
| .padding( 1 ) | ||
| .toString(); | ||
|
|
||
| // Description | ||
| if ( cmd.getDescription() ) { | ||
| renderLabel( 'Description' ); | ||
| output += Table.from( getDescription() ) | ||
| .indent( indent * 2 ) | ||
| .maxCellWidth( 140 ) | ||
| .padding( 1 ) | ||
| .toString(); | ||
| } | ||
|
|
||
| // Options | ||
| if ( cmd.hasOptions() ) { | ||
| renderLabel( 'Options' ); | ||
| output += Table.from( getOptions() ) | ||
| .padding( [ 2, 2, 1, 2 ] ) | ||
| .indent( indent * 2 ) | ||
| .maxCellWidth( [ 60, 60, 80, 60 ] ) | ||
| .toString(); | ||
| } | ||
|
|
||
| // Commands | ||
| if ( cmd.hasCommands( false ) ) { | ||
| renderLabel( 'Commands' ); | ||
| output += Table.from( getCommands() ) | ||
| .padding( [ 2, 2, 1, 2 ] ) | ||
| .indent( indent * 2 ) | ||
| .toString(); | ||
| } | ||
|
|
||
| // Environment variables | ||
| if ( cmd.hasEnvVars( false ) ) { | ||
| renderLabel( 'Environment variables' ); | ||
| output += Table.from( getEnvVars() ) | ||
| .padding( 2 ) | ||
| .indent( indent * 2 ) | ||
| .toString(); | ||
| } | ||
|
|
||
| // Examples | ||
| if ( cmd.hasExamples() ) { | ||
| renderLabel( 'Examples' ); | ||
| output += Table.from( getExamples() ) | ||
| .padding( 1 ) | ||
| .indent( indent * 2 ) | ||
| .maxCellWidth( 150 ) | ||
| .toString(); | ||
| } | ||
|
|
||
| renderLine(); | ||
| }; | ||
|
|
||
| const renderLine = ( ...args: any[] ) => output += ( args.length ? ' '.repeat( indent ) + format( ...args ) : '' ) + '\n'; | ||
|
|
||
| const renderLabel = ( label: string ) => { | ||
| renderLine(); | ||
| renderLine( bold( `${ label }:` ) ); | ||
| renderLine(); | ||
| }; | ||
|
|
||
| const getHeader = (): string[][] => { | ||
|
|
||
| return [ | ||
| [ bold( 'Usage:' ), magenta( `${ cmd.getName() }${ cmd.getArgsDefinition() ? ' ' + cmd.getArgsDefinition() : '' }` ) ], | ||
| [ bold( 'Version:' ), yellow( `v${ cmd.getVersion() }` ) ] | ||
| ]; | ||
| }; | ||
|
|
||
| const getDescription = (): string[][] => { | ||
|
|
||
| return [ | ||
| [ cmd.getDescription() ] | ||
| ]; | ||
| }; | ||
|
|
||
| const getOptions = (): string[][] => { | ||
|
|
||
| return [ | ||
| ...cmd.getOptions( false ).map( ( option: IOption ) => [ | ||
| option.flags.split( /,? +/g ).map( flag => blue( flag ) ).join( ', ' ), | ||
| ArgumentsParser.highlightArguments( option.typeDefinition || '' ), | ||
| red( bold( '-' ) ), | ||
| option.description.split( '\n' ).shift() as string, | ||
| getHints( option ) | ||
| ] ) | ||
| ]; | ||
| }; | ||
|
|
||
| const getCommands = (): string[][] => { | ||
|
|
||
| return [ | ||
| ...cmd.getCommands( false ).map( ( command: BaseCommand ) => [ | ||
| [ command.getName(), ...command.getAliases() ].map( name => blue( name ) ).join( ', ' ), | ||
| ArgumentsParser.highlightArguments( command.getArgsDefinition() || '' ), | ||
| red( bold( '-' ) ), | ||
| command.getDescription().split( '\n' ).shift() as string | ||
| ] ) | ||
| ]; | ||
| }; | ||
|
|
||
| const getEnvVars = (): string[][] => { | ||
|
|
||
| return [ | ||
| ...cmd.getEnvVars( false ).map( ( envVar: IEnvVariable ) => [ | ||
| envVar.names.map( name => blue( name ) ).join( ', ' ), | ||
| ArgumentsParser.highlightArgumentDetails( envVar.details ), | ||
| `${ red( bold( '-' ) ) } ${ envVar.description }` | ||
| ] ) | ||
| ]; | ||
| }; | ||
|
|
||
| const getExamples = (): string[][] => { | ||
|
|
||
| let first = true; | ||
| const rows: string[][] = []; | ||
| cmd.getExamples().map( example => { | ||
| if ( !first ) { | ||
| rows.push( [] ); | ||
| if ( !cmd ) { | ||
| cmd = name ? this.getGlobalParent()?.getBaseCommand( name ) : this.getGlobalParent(); | ||
| } | ||
| if ( !cmd ) { | ||
| throw new Error( `Failed to generate help for command '${ name }'. Command not found.` ); | ||
| } | ||
| first = false; | ||
| rows.push( [ | ||
| dim( bold( `${ capitalize( example.name ) }:` ) ), | ||
| `\n${ example.description }` | ||
| ] ); | ||
| cmd.help(); | ||
| Deno.exit( 0 ); | ||
| } ); | ||
|
|
||
| return rows; | ||
| }; | ||
|
|
||
| const getHints = ( option: IFlagOptions ): string => { | ||
| const hints = []; | ||
|
|
||
| option.required && hints.push( yellow( `required` ) ); | ||
| typeof option.default !== 'undefined' && hints.push( blue( bold( `Default: ` ) ) + blue( format( option.default ) ) ); | ||
| option.depends && option.depends.length && hints.push( red( bold( `depends: ` ) ) + option.depends.map( depends => red( depends ) ).join( ', ' ) ); | ||
| option.conflicts && option.conflicts.length && hints.push( red( bold( `conflicts: ` ) ) + option.conflicts.map( conflict => red( conflict ) ).join( ', ' ) ); | ||
|
|
||
| if ( hints.length ) { | ||
| return `(${ hints.join( ', ' ) })`; | ||
| } | ||
|
|
||
| return ''; | ||
| }; | ||
|
|
||
| renderHelp(); | ||
|
|
||
| return output; | ||
| } | ||
| } | ||
|
|
||
| function capitalize( string: string ): string { | ||
| if ( !string ) { | ||
| return ''; | ||
| } | ||
| return string.charAt( 0 ).toUpperCase() + string.slice( 1 ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.