import DocsCommand from 'atscm-cli/src/cli/commands/Docs.js'

public class | source

DocsCommand

Command → DocsCommand

The command invoked when running "docs". Handles the options --cli and --browser.

Static Member Summary

Static Public Members
public static get	RemoteDocsBase: string Base URL of the hosted API documentation.

Public Constructor
public	constructor(name: string, description: string) Creates a new DocsCommand with the specified name and description.

Public Methods
public	addressToOpen(cli: AtSCMCli): {address: string, isPath: boolean} Returns the path or url to open.
public	localDocsPath(cli: AtSCMCli): string Returns the path to the local api docs.
public	remoteDocsUrl(cli: AtSCMCli): string Returns the URL of the remote api docs.
public	requiresEnvironment(cli: AtSCMCli): boolean Returns `false` if the `--cli` option is used.
public	run(cli: AtSCMCli): Promise Opens the requested docs in the requested browser.

From class Command
public get	demandCommand: number[] The minimum and maximum number of (non-option) arguments the command handles.
public get	options: Map<string, Option> The options available for the command.
public get	strict: boolean If an error should be thrown for unknown arguments.
public get	usage: string Returns the usage string for the command.
public	description: String The command descriptions.
public	name: String The command's name.
private	_options: Object The command's raw options.
public	requiresEnvironment(cli: AtSCMCli): boolean Returns `true` if the command requires a Liftoff.Environment before it can be run.
public	run(cli: AtSCMCli) Runs the command with the current Cli instance.

Base URL of the hosted API documentation.

Creates a new DocsCommand with the specified name and description.

Returns the path or url to open. This is resolved in the following way:

If --remote is passed, always return the URL of the hosted docs of atscm-cli or atscm based on the --cli option passed.
If --cli is passed, always return the path to the local atscm-cli docs.
Otherwise, check if a local module was found:
- If true return the local module docs path,
- else return the URL of the hosted atscm docs.