Struct CliRunner

pub struct CliRunner<'a> { /* private fields */ }

CLI command builder and runner.

Implementations

impl<'a> CliRunner<'a>

pub fn init() -> Self

Initializes CLI environment and returns a builder. This should be called as early as possible.

pub fn name(self, name: &str) -> Self

Set the name of the CLI application to be displayed in help messages.

pub fn about(self, about: &str) -> Self

Set the about message to be displayed in help messages.

pub fn version(self, version: &str) -> Self

Set the version to be displayed by jj version.

pub fn add_extra_config(self, layer: ConfigLayer) -> Self

Adds default configs in addition to the normal defaults.

The layer.source must be Default. Other sources such as User would be replaced by loaded configuration.

pub fn add_extra_config_migration(self, rule: ConfigMigrationRule) -> Self

Adds config migration rule in addition to the default rules.

pub fn add_store_factories(self, store_factories: StoreFactories) -> Self

Adds StoreFactories to be used.

pub fn add_working_copy_factories( self, working_copy_factories: WorkingCopyFactories, ) -> Self

Adds working copy factories to be used.

pub fn set_workspace_loader_factory( self, workspace_loader_factory: Box<dyn WorkspaceLoaderFactory>, ) -> Self

pub fn add_symbol_resolver_extension( self, symbol_resolver: Box<dyn SymbolResolverExtension>, ) -> Self

pub fn add_revset_function_extension( self, name: &'static str, func: RevsetFunction, ) -> Self

pub fn add_commit_template_extension( self, commit_template_extension: Box<dyn CommitTemplateLanguageExtension>, ) -> Self

pub fn add_operation_template_extension( self, operation_template_extension: Box<dyn OperationTemplateLanguageExtension>, ) -> Self

pub fn add_dispatch_hook<F>(self, dispatch_hook_fn: F) -> Self

where F: FnOnce(&mut Ui, &CommandHelper, CliDispatchFn<'_>) -> Result<(), CommandError> + 'a,

Add a hook that gets called when it’s time to run the command. It is the hook’s responsibility to call the given inner dispatch function to run the command.

pub fn add_subcommand<C, F>(self, custom_dispatch_fn: F) -> Self

where C: Subcommand, F: FnOnce(&mut Ui, &CommandHelper, C) -> Result<(), CommandError> + 'a,

Registers new subcommands in addition to the default ones.

pub fn add_global_args<A, F>(self, process_before: F) -> Self

where A: Args, F: FnOnce(&mut Ui, A) -> Result<(), CommandError> + 'a,

Registers new global arguments in addition to the default ones.

pub fn run(self) -> u8