-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
118 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,131 +1,41 @@ | ||
| /** This module is the main entrypoint for the **@carnesen/cli** package */ | ||
|
|
||
| // The `c` namespace module has convenience methods for creating a command-line | ||
| // interface with just a single import from this package. | ||
| import * as c from './c'; | ||
| export { c }; | ||
| // The `c` namespace object is a compact, convenient API | ||
| export * as c from './c'; | ||
|
|
||
| // | ||
| // Command factory | ||
| // | ||
| export { CCliCommand, CCliCommandOptions } from './c-cli-command'; | ||
| // The full API | ||
| export * from './c-cli-command'; | ||
| export * from './c-cli-command-group'; | ||
| export * from './c-cli'; | ||
|
|
||
| // | ||
| // Command group factory | ||
| // | ||
| export { | ||
| CCliCommandGroup, | ||
| CCliCommandGroupOptions, | ||
| CCliSubcommand, | ||
| } from './c-cli-command-group'; | ||
|
|
||
| // | ||
| // Command-line interface (CLI) factory | ||
| // | ||
| export { CCli, CCliOptions } from './c-cli'; | ||
|
|
||
| // | ||
| // Argument group factories | ||
| // | ||
| // boolean flag | ||
| export { | ||
| CCliFlagArgGroup, | ||
| CCliFlagArgGroupOptions, | ||
| } from './arg-groups/c-cli-flag-arg-group'; | ||
|
|
||
| // JSON | ||
| export { | ||
| CCliJsonArgGroup, | ||
| CCliJsonArgGroupOptions, | ||
| } from './arg-groups/c-cli-json-arg-group'; | ||
|
|
||
| // number | ||
| export { | ||
| CCliNumberArgGroup, | ||
| CCliNumberArgGroupOptions, | ||
| } from './arg-groups/c-cli-number-arg-group'; | ||
|
|
||
| // number array | ||
| export { | ||
| CCliNumberArrayArgGroup, | ||
| CCliNumberArrayArgGroupOptions, | ||
| } from './arg-groups/c-cli-number-array-arg-group'; | ||
|
|
||
| // string | ||
| export { | ||
| CCliStringArgGroup, | ||
| CCliStringArgGroupOptions, | ||
| } from './arg-groups/c-cli-string-arg-group'; | ||
|
|
||
| // string array | ||
| export { | ||
| CCliStringArrayArgGroup, | ||
| CCliStringArrayArgGroupOptions, | ||
| } from './arg-groups/c-cli-string-array-arg-group'; | ||
| export * from './arg-groups/c-cli-flag-arg-group'; | ||
| export * from './arg-groups/c-cli-json-arg-group'; | ||
| export * from './arg-groups/c-cli-number-arg-group'; | ||
| export * from './arg-groups/c-cli-number-array-arg-group'; | ||
| export * from './arg-groups/c-cli-string-arg-group'; | ||
| export * from './arg-groups/c-cli-string-array-arg-group'; | ||
| export * from './arg-groups/c-cli-string-choice-arg-group'; | ||
|
|
||
| // string choice (literal union) | ||
| export { | ||
| CCliStringChoiceArgGroup, | ||
| CCliStringChoiceArgGroupOptions, | ||
| } from './arg-groups/c-cli-string-choice-arg-group'; | ||
|
|
||
| // | ||
| // The rest of the exports in this module support "advanced" features | ||
| // | ||
|
|
||
| // | ||
| // Description functions | ||
| // | ||
| import { | ||
| renderCCliDescription, | ||
| RenderCCliDescriptionOptions, | ||
| CCliDescriptionFunction, | ||
| } from './c-cli-description'; | ||
|
|
||
| export { | ||
| renderCCliDescription, | ||
| RenderCCliDescriptionOptions, | ||
| CCliDescriptionFunction, | ||
| }; | ||
|
|
||
| // | ||
| // Logging | ||
| // | ||
| export { CCliLogger } from './c-cli-logger'; | ||
| export { CCliNoopLogger } from './c-cli-noop-logger'; | ||
| export { CCliConsoleLogger } from './c-cli-console-logger'; | ||
|
|
||
| // | ||
| // Isomorphic type mimicking the Node.js global `process` | ||
| // | ||
| export { CCliProcess } from './c-cli-process'; | ||
|
|
||
| // | ||
| // Text decoration | ||
| // | ||
| export { CCliAnsiColor } from './c-cli-ansi-color'; | ||
| export { CCliColor } from './c-cli-color'; | ||
| export { CCliNoopColor } from './c-cli-noop-color'; | ||
| export { cCliColorFactory } from './c-cli-color-factory'; | ||
| export * from './c-cli-ansi-color'; | ||
| export * from './c-cli-color-factory'; | ||
| export * from './c-cli-color'; | ||
| export * from './c-cli-console-logger'; | ||
| export * from './c-cli-description'; | ||
| export * from './c-cli-logger'; | ||
| export * from './c-cli-noop-color'; | ||
| export * from './c-cli-noop-logger'; | ||
| export * from './c-cli-process'; | ||
|
|
||
| // | ||
| // Error constructors | ||
| // | ||
| export { CCliTerseError } from './c-cli-terse-error'; | ||
| export { CCliUsageError } from './c-cli-usage-error'; | ||
| export * from './c-cli-terse-error'; | ||
| export * from './c-cli-usage-error'; | ||
|
|
||
| // | ||
| // Custom argument group | ||
| // | ||
| export { | ||
| CCliArgGroup, | ||
| CCliArgGroupOptions, | ||
| CCliParseArgs, | ||
| } from './c-cli-arg-group'; | ||
| export * from './c-cli-arg-group'; | ||
|
|
||
| // | ||
| // FOR INTERNAL USE ONLY | ||
| // | ||
| export { navigateCCliTree, NavigateCCliTreeResult } from './navigate-cli-tree'; | ||
| export { CCliWordMark } from './c-cli-word-mark'; | ||
| export { CCliRoot, CCliTree, CCliLeaf } from './c-cli-tree'; | ||
| export * from './navigate-cli-tree'; | ||
| export * from './c-cli-word-mark'; | ||
| export * from './c-cli-tree'; |