mirror of
https://github.com/nushell/nushell
synced 2025-01-05 01:39:02 +00:00
1d3f6105f5
# Description Add a `command_not_found` function to `$env.config.hooks`. If this function outputs a string, then it's included in the `help`. An example hook on *Arch Linux*, to find packages that contain the binary, looks like: ```nushell let-env config = { # ... hooks: { command_not_found: { |cmd_name| ( try { let pkgs = (pkgfile --binaries --verbose $cmd_name) ( $"(ansi $env.config.color_config.shape_external)($cmd_name)(ansi reset) " + $"may be found in the following packages:\n($pkgs)" ) } catch { null } ) } # ... ``` # User-Facing Changes - Add a `command_not_found` function to `$env.config.hooks`. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
147 lines
5.1 KiB
Rust
147 lines
5.1 KiB
Rust
use crate::NushellPrompt;
|
|
use log::trace;
|
|
use nu_command::util::report_error;
|
|
use nu_engine::eval_subexpression;
|
|
use nu_protocol::{
|
|
engine::{EngineState, Stack, StateWorkingSet},
|
|
Config, PipelineData, Value,
|
|
};
|
|
use reedline::Prompt;
|
|
|
|
// Name of environment variable where the prompt could be stored
|
|
pub(crate) const PROMPT_COMMAND: &str = "PROMPT_COMMAND";
|
|
pub(crate) const PROMPT_COMMAND_RIGHT: &str = "PROMPT_COMMAND_RIGHT";
|
|
pub(crate) const PROMPT_INDICATOR: &str = "PROMPT_INDICATOR";
|
|
pub(crate) const PROMPT_INDICATOR_VI_INSERT: &str = "PROMPT_INDICATOR_VI_INSERT";
|
|
pub(crate) const PROMPT_INDICATOR_VI_NORMAL: &str = "PROMPT_INDICATOR_VI_NORMAL";
|
|
pub(crate) const PROMPT_MULTILINE_INDICATOR: &str = "PROMPT_MULTILINE_INDICATOR";
|
|
// According to Daniel Imms @Tyriar, we need to do these this way:
|
|
// <133 A><prompt><133 B><command><133 C><command output>
|
|
const PRE_PROMPT_MARKER: &str = "\x1b]133;A\x1b\\";
|
|
const POST_PROMPT_MARKER: &str = "\x1b]133;B\x1b\\";
|
|
|
|
fn get_prompt_string(
|
|
prompt: &str,
|
|
config: &Config,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
) -> Option<String> {
|
|
stack
|
|
.get_env_var(engine_state, prompt)
|
|
.and_then(|v| match v {
|
|
Value::Closure {
|
|
val: block_id,
|
|
captures,
|
|
..
|
|
} => {
|
|
let block = engine_state.get_block(block_id);
|
|
let mut stack = stack.captures_to_stack(&captures);
|
|
// Use eval_subexpression to force a redirection of output, so we can use everything in prompt
|
|
let ret_val =
|
|
eval_subexpression(engine_state, &mut stack, block, PipelineData::empty());
|
|
trace!(
|
|
"get_prompt_string (block) {}:{}:{}",
|
|
file!(),
|
|
line!(),
|
|
column!()
|
|
);
|
|
|
|
ret_val
|
|
.map_err(|err| {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
report_error(&working_set, &err);
|
|
})
|
|
.ok()
|
|
}
|
|
Value::Block { val: block_id, .. } => {
|
|
let block = engine_state.get_block(block_id);
|
|
// Use eval_subexpression to force a redirection of output, so we can use everything in prompt
|
|
let ret_val = eval_subexpression(engine_state, stack, block, PipelineData::empty());
|
|
trace!(
|
|
"get_prompt_string (block) {}:{}:{}",
|
|
file!(),
|
|
line!(),
|
|
column!()
|
|
);
|
|
|
|
ret_val
|
|
.map_err(|err| {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
report_error(&working_set, &err);
|
|
})
|
|
.ok()
|
|
}
|
|
Value::String { .. } => Some(PipelineData::Value(v.clone(), None)),
|
|
_ => None,
|
|
})
|
|
.and_then(|pipeline_data| {
|
|
let output = pipeline_data.collect_string("", config).ok();
|
|
|
|
output.map(|mut x| {
|
|
// Just remove the very last newline.
|
|
if x.ends_with('\n') {
|
|
x.pop();
|
|
}
|
|
|
|
if x.ends_with('\r') {
|
|
x.pop();
|
|
}
|
|
x
|
|
})
|
|
})
|
|
}
|
|
|
|
pub(crate) fn update_prompt<'prompt>(
|
|
config: &Config,
|
|
engine_state: &EngineState,
|
|
stack: &Stack,
|
|
nu_prompt: &'prompt mut NushellPrompt,
|
|
) -> &'prompt dyn Prompt {
|
|
let mut stack = stack.clone();
|
|
|
|
let left_prompt_string = get_prompt_string(PROMPT_COMMAND, config, engine_state, &mut stack);
|
|
|
|
// Now that we have the prompt string lets ansify it.
|
|
// <133 A><prompt><133 B><command><133 C><command output>
|
|
let left_prompt_string = if config.shell_integration {
|
|
if let Some(prompt_string) = left_prompt_string {
|
|
Some(format!(
|
|
"{PRE_PROMPT_MARKER}{prompt_string}{POST_PROMPT_MARKER}"
|
|
))
|
|
} else {
|
|
left_prompt_string
|
|
}
|
|
} else {
|
|
left_prompt_string
|
|
};
|
|
|
|
let right_prompt_string =
|
|
get_prompt_string(PROMPT_COMMAND_RIGHT, config, engine_state, &mut stack);
|
|
|
|
let prompt_indicator_string =
|
|
get_prompt_string(PROMPT_INDICATOR, config, engine_state, &mut stack);
|
|
|
|
let prompt_multiline_string =
|
|
get_prompt_string(PROMPT_MULTILINE_INDICATOR, config, engine_state, &mut stack);
|
|
|
|
let prompt_vi_insert_string =
|
|
get_prompt_string(PROMPT_INDICATOR_VI_INSERT, config, engine_state, &mut stack);
|
|
|
|
let prompt_vi_normal_string =
|
|
get_prompt_string(PROMPT_INDICATOR_VI_NORMAL, config, engine_state, &mut stack);
|
|
|
|
// apply the other indicators
|
|
nu_prompt.update_all_prompt_strings(
|
|
left_prompt_string,
|
|
right_prompt_string,
|
|
prompt_indicator_string,
|
|
prompt_multiline_string,
|
|
(prompt_vi_insert_string, prompt_vi_normal_string),
|
|
config.render_right_prompt_on_last_line,
|
|
);
|
|
|
|
let ret_val = nu_prompt as &dyn Prompt;
|
|
trace!("update_prompt {}:{}:{}", file!(), line!(), column!());
|
|
|
|
ret_val
|
|
}
|