nushell/crates/nu-command/src
Steven Xu 1d3f6105f5
feat: add a command_not_found hook (#8314)
# 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.
2023-03-20 17:05:22 +13:00
..
bits Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
bytes Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
charting Optional members in cell paths: Attempt 2 (#8379) 2023-03-15 20:50:58 -07:00
conversions Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
database Fix SQLite table creation sql (#8430) 2023-03-13 10:11:28 -07:00
dataframe docs: Use capital letters for CSV and JSON acronyms (#8459) 2023-03-15 21:52:13 -07:00
date Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
debug Restrict closure expression to be something like {|| ...} (#8290) 2023-03-17 07:36:28 -05:00
deprecated Revert "Allow NU_LIBS_DIR and friends to be const" (#8501) 2023-03-17 09:33:24 -05:00
env Revert "Allow NU_LIBS_DIR and friends to be const" (#8501) 2023-03-17 09:33:24 -05:00
experimental Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
filesystem Add rest and glob support to 'open' (#8506) 2023-03-18 08:51:39 +13:00
filters Restrict closure expression to be something like {|| ...} (#8290) 2023-03-17 07:36:28 -05:00
formats Additional flags for commands from csv and from tsv (#8398) 2023-03-16 17:49:46 -05:00
generators Document and critically review ShellError variants - Ep. 2 (#8326) 2023-03-06 11:31:07 +01:00
hash Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
math Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
misc Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
network Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
path Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
platform Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
random Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
shells Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
strings Add char --list example to char command docs (#8474) 2023-03-17 10:15:41 +01:00
system feat: add a command_not_found hook (#8314) 2023-03-20 17:05:22 +13:00
viewers Optional members in cell paths: Attempt 2 (#8379) 2023-03-15 20:50:58 -07:00
default_context.rs SQL-style join command for Nushell tables (#8424) 2023-03-16 16:57:20 -07:00
example_test.rs cratification: Example support (#8231) 2023-02-27 13:58:56 -08:00
hook.rs feat: add a command_not_found hook (#8314) 2023-03-20 17:05:22 +13:00
input_handler.rs Box ShellError in Value::Error (#8375) 2023-03-12 09:57:27 +01:00
lib.rs feat: add a command_not_found hook (#8314) 2023-03-20 17:05:22 +13:00
progress_bar.rs cp progress bar implementation (#8012) 2023-02-22 11:57:38 -08:00
sort_utils.rs Document and critically review ShellError variants - Ep. 3 (#8340) 2023-03-06 18:33:09 +01:00
util.rs feat: add a command_not_found hook (#8314) 2023-03-20 17:05:22 +13:00