extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-04-21 19:58:21 +02:00
Code Issues Packages Projects Releases Wiki Activity
1dd861b10f
nushell/crates/nu-std/std-rfc
History
zc he 44b7cfd696
refactor: tree-sitter-nu friendly alternative expressions (#15301) 
# Description

Choose more tree-sitter-nu-friendly (if not better) expressions in nu
scripts.
The changes made in this PR all come from known issues of
`tree-sitter-nu`.

1. nested single/double quotes:
https://github.com/nushell/tree-sitter-nu/issues/125
2. module path of `use` command:
https://github.com/nushell/tree-sitter-nu/issues/165
3. where predicates of boolean column:
https://github.com/nushell/tree-sitter-nu/issues/177
4. `error make` keyword:
https://github.com/nushell/tree-sitter-nu/issues/179

Those issues are either hard to fix or "not planned" for syntactical
precision considerations ATM.

# User-Facing Changes

Should be none

# Tests + Formatting

# After Submitting
2025-03-12 08:48:19 -05:00
..
clip docs(std-rfc): use actual examples rather than doc comments (#15097) 2025-02-11 16:33:27 -06:00
conversions docs(std-rfc): use actual examples rather than doc comments (#15097) 2025-02-11 16:33:27 -06:00
kv Refactor kv commands: replace inline params in SQL queries (#15108) 2025-02-13 23:23:59 -05:00
path docs(std-rfc): use actual examples rather than doc comments (#15097) 2025-02-11 16:33:27 -06:00
str docs(std-rfc): use actual examples rather than doc comments (#15097) 2025-02-11 16:33:27 -06:00
tables refactor: tree-sitter-nu friendly alternative expressions (#15301) 2025-03-12 08:48:19 -05:00
mod.nu Move std-rfc into Nushell (#15042) 2025-02-09 09:03:37 -05:00
README.md Update README.md 2025-02-10 09:06:09 -05:00

README.md

std-rfc

Overview and Requirements

This module includes potential candidate commands (and other definitions) for inclusion in the Standard Library (std) that is built in to Nushell. As a general guideline, candidates should:

  • Be general purpose features that will be useful to a number of users
  • Include doc comments for definitions and parameters that can be used with help <command>
  • Include tests
  • Since doc comments are fairly limited, additional documentation can be included in a GitHub discussion. This documentation can then be moved to the main website when the feature is promoted to std. See this example for some table helpers.

Showcase and Discussion

While primary feedback should take place in the PR, we have also established a Drawing Board Discord channel which can be used for several purposes:

  • Ideation before a PR is submitted
  • Raise awareness of the feature
  • Short-term questions and discussion

Note: The Drawing Board is not just for std-rfc. Please tag your topic with std-library if it is about a Standard Library idea.

Promotion Evaluation

In general, new std-rfc features will be evaluated after they have been trialed for a sufficient period, which may vary depending on the feature. After that period, the feature may be:

  • Promoted to std
  • Removed from std-rfc
  • Or changes may be requested and then reevaluated later