mirror of
https://github.com/nushell/nushell.git
synced 2025-04-01 03:36:53 +02:00
# 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.
129 lines
4.1 KiB
Rust
129 lines
4.1 KiB
Rust
use crate::util::eval_source;
|
|
use nu_command::util::report_error;
|
|
#[cfg(feature = "plugin")]
|
|
use nu_parser::ParseError;
|
|
#[cfg(feature = "plugin")]
|
|
use nu_path::canonicalize_with;
|
|
use nu_protocol::engine::{EngineState, Stack, StateWorkingSet};
|
|
#[cfg(feature = "plugin")]
|
|
use nu_protocol::Spanned;
|
|
use nu_protocol::{HistoryFileFormat, PipelineData};
|
|
#[cfg(feature = "plugin")]
|
|
use nu_utils::utils::perf;
|
|
use std::path::PathBuf;
|
|
|
|
#[cfg(feature = "plugin")]
|
|
const PLUGIN_FILE: &str = "plugin.nu";
|
|
|
|
const HISTORY_FILE_TXT: &str = "history.txt";
|
|
const HISTORY_FILE_SQLITE: &str = "history.sqlite3";
|
|
|
|
#[cfg(feature = "plugin")]
|
|
pub fn read_plugin_file(
|
|
engine_state: &mut EngineState,
|
|
stack: &mut Stack,
|
|
plugin_file: Option<Spanned<String>>,
|
|
storage_path: &str,
|
|
) {
|
|
let start_time = std::time::Instant::now();
|
|
let mut plug_path = String::new();
|
|
// Reading signatures from signature file
|
|
// The plugin.nu file stores the parsed signature collected from each registered plugin
|
|
add_plugin_file(engine_state, plugin_file, storage_path);
|
|
|
|
let plugin_path = engine_state.plugin_signatures.clone();
|
|
if let Some(plugin_path) = plugin_path {
|
|
let plugin_filename = plugin_path.to_string_lossy();
|
|
plug_path = plugin_filename.to_string();
|
|
if let Ok(contents) = std::fs::read(&plugin_path) {
|
|
eval_source(
|
|
engine_state,
|
|
stack,
|
|
&contents,
|
|
&plugin_filename,
|
|
PipelineData::empty(),
|
|
false,
|
|
);
|
|
}
|
|
}
|
|
|
|
perf(
|
|
&format!("read_plugin_file {}", &plug_path),
|
|
start_time,
|
|
file!(),
|
|
line!(),
|
|
column!(),
|
|
engine_state.get_config().use_ansi_coloring,
|
|
);
|
|
}
|
|
|
|
#[cfg(feature = "plugin")]
|
|
pub fn add_plugin_file(
|
|
engine_state: &mut EngineState,
|
|
plugin_file: Option<Spanned<String>>,
|
|
storage_path: &str,
|
|
) {
|
|
if let Some(plugin_file) = plugin_file {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
let cwd = working_set.get_cwd();
|
|
|
|
if let Ok(path) = canonicalize_with(&plugin_file.item, cwd) {
|
|
engine_state.plugin_signatures = Some(path)
|
|
} else {
|
|
let e = ParseError::FileNotFound(plugin_file.item, plugin_file.span);
|
|
report_error(&working_set, &e);
|
|
}
|
|
} else if let Some(mut plugin_path) = nu_path::config_dir() {
|
|
// Path to store plugins signatures
|
|
plugin_path.push(storage_path);
|
|
plugin_path.push(PLUGIN_FILE);
|
|
engine_state.plugin_signatures = Some(plugin_path.clone());
|
|
}
|
|
}
|
|
|
|
pub fn eval_config_contents(
|
|
config_path: PathBuf,
|
|
engine_state: &mut EngineState,
|
|
stack: &mut Stack,
|
|
) {
|
|
if config_path.exists() & config_path.is_file() {
|
|
let config_filename = config_path.to_string_lossy();
|
|
|
|
if let Ok(contents) = std::fs::read(&config_path) {
|
|
eval_source(
|
|
engine_state,
|
|
stack,
|
|
&contents,
|
|
&config_filename,
|
|
PipelineData::empty(),
|
|
false,
|
|
);
|
|
|
|
// Merge the environment in case env vars changed in the config
|
|
match nu_engine::env::current_dir(engine_state, stack) {
|
|
Ok(cwd) => {
|
|
if let Err(e) = engine_state.merge_env(stack, cwd) {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
report_error(&working_set, &e);
|
|
}
|
|
}
|
|
Err(e) => {
|
|
let working_set = StateWorkingSet::new(engine_state);
|
|
report_error(&working_set, &e);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub(crate) fn get_history_path(storage_path: &str, mode: HistoryFileFormat) -> Option<PathBuf> {
|
|
nu_path::config_dir().map(|mut history_path| {
|
|
history_path.push(storage_path);
|
|
history_path.push(match mode {
|
|
HistoryFileFormat::PlainText => HISTORY_FILE_TXT,
|
|
HistoryFileFormat::Sqlite => HISTORY_FILE_SQLITE,
|
|
});
|
|
history_path
|
|
})
|
|
}
|