nushell/crates
Yash Thakur da98c23ab3
Use right options in custom completions (#13698)
<!--
if this PR closes one or more issues, you can automatically link the PR
with
them by using one of the [*linking
keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword),
e.g.
- this PR should close #xxxx
- fixes #xxxx

you can also mention related issues, PRs or discussions!
-->

# Description
<!--
Thank you for improving Nushell. Please, check our [contributing
guide](../CONTRIBUTING.md) and talk to the core team before making major
changes.

Description of your pull request goes here. **Provide examples and/or
screenshots** if your changes affect the user experience.
-->

This issue was reported by kira in
[Discord](https://discord.com/channels/601130461678272522/1276981416307069019).
In https://github.com/nushell/nushell/pull/13311, I accidentally made it
so that custom completions are filtered according to the user's
configured completion options (`$env.config.completions`) rather than
the completion options provided as part of the custom completions. This
PR is a quick fix for that.

# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->

It should once again be possible to override match algorithm, case
sensitivity, and substring matching (`positional`) in custom
completions.

# 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` to
check that you're using the standard code style
- `cargo test --workspace` to check that all tests pass (on Windows make
sure to [enable developer
mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging))
- `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the
tests for the standard library

> **Note**
> from `nushell` you can also use the `toolkit` as follows
> ```bash
> use toolkit.nu # or use an `env_change` hook to activate it
automatically
> toolkit check pr
> ```
-->

Added a couple tests.

# 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.
-->

fdncred and I discussed this in Discord a bit and we thought it might be
better to not allow custom completions to override the user's config.
However, `positional` can't currently be set inside one's config, so you
can only do strict prefix matching, no substring matching. Another PR
could do one of the following:
- Document the fact that you can provide completion options inside
custom completions
- Remove the ability to provide completion options with custom
completions and add a `$env.config.completions.positional: true` option
- Remove the ability to provide completion options with custom
completions and add a new match algorithm `substring` (this is the one I
like most, since `positional` only applies to prefix matching anyway)

Separately from these options, we could also allow completers to specify
that they don't Nushell to do any filtering and sorting on the provided
custom completions.
2024-08-26 12:14:57 -05:00
..
nu_plugin_custom_values Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_example Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_formats Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_gstat Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_inc Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_nu_example Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_polars Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_python Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_query Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu_plugin_stress_internals Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-cli Use right options in custom completions (#13698) 2024-08-26 12:14:57 -05:00
nu-cmd-base Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-cmd-extra encode/decode for multiple alphabets (#13428) 2024-08-23 11:18:51 -05:00
nu-cmd-lang Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-cmd-plugin Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-color-config Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-command Fix encode/decode todo's (#13683) 2024-08-24 09:02:02 -05:00
nu-derive-value Change expected type for derived FromValue implementations via attribute (#13647) 2024-08-23 06:47:15 -05:00
nu-engine doc: fix broken doc links (#13644) 2024-08-23 21:17:44 +02:00
nu-explore Remove unnecessary sort in explore search fn (#13690) 2024-08-25 20:13:05 +02:00
nu-glob Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-json Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-lsp Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-parser Improve help output for scripts (#13445) 2024-08-23 21:08:27 +02:00
nu-path Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-plugin Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-plugin-core Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-plugin-engine doc: fix broken doc links (#13644) 2024-08-23 21:17:44 +02:00
nu-plugin-protocol Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-plugin-test-support Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-pretty-hex Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-protocol doc: fix broken doc links (#13644) 2024-08-23 21:17:44 +02:00
nu-std Change the usage misnomer to "description" (#13598) 2024-08-22 12:02:08 +02:00
nu-system Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-table [DRAFT] Check fix for emojie, wrap issues (#13430) 2024-08-23 17:35:42 -05:00
nu-term-grid Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-test-support Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nu-utils Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
nuon Bump version to 0.97.2 (#13666) 2024-08-22 11:36:32 +02:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.