jj/examples/custom-command/main.rs
Glen Choo 7c2400f3e5 ui: add pager
Teach Ui's writing functions to write to a pager without touching the
process's file descriptors. This is done by introducing UiOutput::Paged,
which spawns a pager that Ui's functions can write to.

The pager program can be chosen via `ui.pager`. (defaults to Defaults to
$PAGER, and 'less' if that is unset (falling back to 'less' also makes
the tests pass).

Currently, commands are paginated if:

- they have "long" output (as defined by jj developers)
- jj is invoked in a terminal

The next commit will allow pagination to be turned off via a CLI option.
More complex pagination toggling (e.g. showing a pager even if the
output doesn't look like a terminal, using a pager for shorter ouput) is
left for a future PR.
2022-11-30 06:14:39 +08:00

69 lines
2.5 KiB
Rust

// Copyright 2022 The Jujutsu Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use clap::{FromArgMatches, Subcommand};
use jujutsu::cli_util::{
create_ui, handle_command_result, parse_args, short_commit_description, CommandError,
};
use jujutsu::commands::{default_app, run_command};
use jujutsu::ui::Ui;
use jujutsu_lib::commit_builder::CommitBuilder;
#[derive(clap::Parser, Clone, Debug)]
enum CustomCommands {
Frobnicate(FrobnicateArgs),
}
/// Frobnicate a revisions
#[derive(clap::Args, Clone, Debug)]
struct FrobnicateArgs {
/// The revision to frobnicate
#[arg(default_value = "@")]
revision: String,
}
fn run(ui: &mut Ui) -> Result<(), CommandError> {
let app = CustomCommands::augment_subcommands(default_app());
let (command_helper, matches) = parse_args(ui, app, std::env::args_os())?;
match CustomCommands::from_arg_matches(&matches) {
// Handle our custom command
Ok(CustomCommands::Frobnicate(args)) => {
let mut workspace_command = command_helper.workspace_helper(ui)?;
let commit = workspace_command.resolve_single_rev(&args.revision)?;
let mut tx = workspace_command.start_transaction("Frobnicate");
let new_commit = CommitBuilder::for_rewrite_from(ui.settings(), &commit)
.set_description("Frobnicated!".to_string())
.write_to_repo(tx.mut_repo());
workspace_command.finish_transaction(ui, tx)?;
writeln!(
ui,
"Frobnicated revision: {}",
short_commit_description(&new_commit)
)?;
Ok(())
}
// Handle default commands
Err(_) => run_command(ui, &command_helper, &matches),
}
}
fn main() {
jujutsu::cleanup_guard::init();
let (mut ui, result) = create_ui();
let result = result.and_then(|()| run(&mut ui));
let exit_code = handle_command_result(&mut ui, result);
ui.finalize_writes();
std::process::exit(exit_code);
}