nushell/crates/nu-cmd-extra/README.md
Stefan Holderbach 067ceedf79
Remove feat extra and include in default (#12140)
# Description
The intended effect of the `extra` feature has been undermined by
introducing the full builds on our release pages and having more
activity on some of the extra commands.

To simplify the feature matrix let's get rid of it and focus our effort
on truly either refining a command to well-specified behavior or
discarding it entirely from the `nu` binary and moving it into plugins.

## Details
- Remove `--features extra` from CI
- Don't explicitly name `extra` in full build wf
- Remove feature extra from build-help scripts
- Update README in `nu-cmd-extra`
- Remove feature `extra`
- Fix previously dead `format pattern` tests
- Relax signature of `to html`
- Fix/ignore `html::test_no_color_flag`
- Remove dead features from `version`
- Refine `to html` type signature

# User-Facing Changes
The commands that were previously only available when building with
`--features extra` will now be available to everyone. This increases the
number of dependencies slightly but has a limited impact on the overall
binary size.

# Tests + Formatting
Some tests that were left in `nu-command` during cratification were dead
because the feature was not passed to `nu-command` and only to
`nu-cmd-lang` for feature-flag mention in `version`.
Those tests have now been either fixed or ignored in one case.

# After Submitting
There may be places in the documentation where we point to `--features
extra` that will now be moot (apart from the generated command help)
2024-03-10 17:29:02 +01:00

13 lines
669 B
Markdown

# nu-cmd-extra
The commands in this crate are the *extra commands* of Nushell. These commands
are not in a state to be guaranteed to be part of the 1.0 API; meaning that
there is no guarantee longer term that these commands will be around into the
future.
For a while we did exclude them behind the `--features extra` compile time
flag, meaning that the default release did not contain them. As we (the Nushell
team) shipped a full build including both `extra` and `dataframe` for some
time, we chose to sunset the `extra` feature but keep the commands in this
crate for now. In the future the commands may be moved to more topical crates
or discarded into plugins.