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

Jump to bottom

docs: remove outdated Command.Default example #63

Merged
merged 2 commits into from
Dec 29, 2020
Merged

docs: remove outdated Command.Default example #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
486c49e
docs: remove outdated Command.Default example
paul-soporan Dec 29, 2020
d22936c
docs: remove reference to path field
paul-soporan Dec 29, 2020
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
13 changes: 4 additions & 9 deletions sources/advanced/Command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,14 @@ export abstract class Command<Context extends BaseContext = BaseContext> {
/**
* Defines a schema to apply before running the `execute` method. The
* schema is expected to be generated by Typanion.
*
*
* @see https://github.com/arcanis/typanion
*/
static schema?: LooseTest<{[key: string]: unknown}>[];

/**
* Standard function that'll get executed by `Cli#run` and `Cli#runExit`.
*
*
* Expected to return an exit code or nothing (which Clipanion will treat
* as if 0 had been returned).
*/
Expand Down Expand Up @@ -170,14 +170,9 @@ export abstract class Command<Context extends BaseContext = BaseContext> {
static isOption: typeof isOptionSymbol = isOptionSymbol;

/**
* Just an helper to use along with the `path` / paths` fields, to make it
* Just an helper to use along with the `paths` fields, to make it
* clearer that a command is the default one.
*
* @example
* class MyCommand extends Command {
* static path = Command.Default;
* }
*
*
* @example
* class MyCommand extends Command {
* static paths = [Command.Default];
Expand Down