diff --git a/stdlib-candidate-old/README.md b/stdlib-candidate-old/README.md new file mode 100644 index 0000000..95c0892 --- /dev/null +++ b/stdlib-candidate-old/README.md @@ -0,0 +1,3 @@ +# std-lib candidate + +This is the deprecated `stdlib-candidate` module. Please see the [new version](https://github.com/nushell/nu_scripts/tree/main/stdlib-candidate). If you have a submission here, you can move it to the new repo. Please refer to the [README](https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/README.md) there for the process. diff --git a/stdlib-candidate-old/nupm.nuon b/stdlib-candidate-old/nupm.nuon new file mode 100644 index 0000000..12c19a6 --- /dev/null +++ b/stdlib-candidate-old/nupm.nuon @@ -0,0 +1,8 @@ +{ + name: "std-rfc" + description: "Official candidates for Nushell standard library" + documentation: "https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/std-rfc/README.md" + license: "https://github.com/nushell/nu_scripts/blob/main/LICENSE" + version: 0.3.0 + type: "module" +} diff --git a/stdlib-candidate/std-rfc/bench.nu b/stdlib-candidate-old/std-rfc/bench.nu similarity index 100% rename from stdlib-candidate/std-rfc/bench.nu rename to stdlib-candidate-old/std-rfc/bench.nu diff --git a/stdlib-candidate/std-rfc/bulk-rename.nu b/stdlib-candidate-old/std-rfc/bulk-rename.nu similarity index 100% rename from stdlib-candidate/std-rfc/bulk-rename.nu rename to stdlib-candidate-old/std-rfc/bulk-rename.nu diff --git a/stdlib-candidate/std-rfc/conversions/into.nu b/stdlib-candidate-old/std-rfc/conversions/into.nu similarity index 100% rename from stdlib-candidate/std-rfc/conversions/into.nu rename to stdlib-candidate-old/std-rfc/conversions/into.nu diff --git a/stdlib-candidate/std-rfc/conversions/mod.nu b/stdlib-candidate-old/std-rfc/conversions/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/conversions/mod.nu rename to stdlib-candidate-old/std-rfc/conversions/mod.nu diff --git a/stdlib-candidate/std-rfc/flatter.nu b/stdlib-candidate-old/std-rfc/flatter.nu similarity index 100% rename from stdlib-candidate/std-rfc/flatter.nu rename to stdlib-candidate-old/std-rfc/flatter.nu diff --git a/stdlib-candidate/std-rfc/get-latest-release-linux.nu b/stdlib-candidate-old/std-rfc/get-latest-release-linux.nu similarity index 100% rename from stdlib-candidate/std-rfc/get-latest-release-linux.nu rename to stdlib-candidate-old/std-rfc/get-latest-release-linux.nu diff --git a/stdlib-candidate/std-rfc/math/mod.nu b/stdlib-candidate-old/std-rfc/math/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/math/mod.nu rename to stdlib-candidate-old/std-rfc/math/mod.nu diff --git a/stdlib-candidate/std-rfc/mod.nu b/stdlib-candidate-old/std-rfc/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/mod.nu rename to stdlib-candidate-old/std-rfc/mod.nu diff --git a/stdlib-candidate/std-rfc/nu_style.nu b/stdlib-candidate-old/std-rfc/nu_style.nu similarity index 100% rename from stdlib-candidate/std-rfc/nu_style.nu rename to stdlib-candidate-old/std-rfc/nu_style.nu diff --git a/stdlib-candidate/std-rfc/print.nu b/stdlib-candidate-old/std-rfc/print.nu similarity index 100% rename from stdlib-candidate/std-rfc/print.nu rename to stdlib-candidate-old/std-rfc/print.nu diff --git a/stdlib-candidate/std-rfc/record/README.md b/stdlib-candidate-old/std-rfc/record/README.md similarity index 100% rename from stdlib-candidate/std-rfc/record/README.md rename to stdlib-candidate-old/std-rfc/record/README.md diff --git a/stdlib-candidate/std-rfc/record/mod.nu b/stdlib-candidate-old/std-rfc/record/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/record/mod.nu rename to stdlib-candidate-old/std-rfc/record/mod.nu diff --git a/stdlib-candidate/std-rfc/script-parsing.nu b/stdlib-candidate-old/std-rfc/script-parsing.nu similarity index 100% rename from stdlib-candidate/std-rfc/script-parsing.nu rename to stdlib-candidate-old/std-rfc/script-parsing.nu diff --git a/stdlib-candidate/std-rfc/set-env.nu b/stdlib-candidate-old/std-rfc/set-env.nu similarity index 100% rename from stdlib-candidate/std-rfc/set-env.nu rename to stdlib-candidate-old/std-rfc/set-env.nu diff --git a/stdlib-candidate/std-rfc/str/dedent/mod.nu b/stdlib-candidate-old/std-rfc/str/dedent/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/str/dedent/mod.nu rename to stdlib-candidate-old/std-rfc/str/dedent/mod.nu diff --git a/stdlib-candidate/std-rfc/str/mod.nu b/stdlib-candidate-old/std-rfc/str/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/str/mod.nu rename to stdlib-candidate-old/std-rfc/str/mod.nu diff --git a/stdlib-candidate/std-rfc/str/xpend.nu b/stdlib-candidate-old/std-rfc/str/xpend.nu similarity index 100% rename from stdlib-candidate/std-rfc/str/xpend.nu rename to stdlib-candidate-old/std-rfc/str/xpend.nu diff --git a/stdlib-candidate/std-rfc/tables/col-indices.nu b/stdlib-candidate-old/std-rfc/tables/col-indices.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/col-indices.nu rename to stdlib-candidate-old/std-rfc/tables/col-indices.nu diff --git a/stdlib-candidate/std-rfc/tables/mod.nu b/stdlib-candidate-old/std-rfc/tables/mod.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/mod.nu rename to stdlib-candidate-old/std-rfc/tables/mod.nu diff --git a/stdlib-candidate/std-rfc/tables/reject-column-ranges.nu b/stdlib-candidate-old/std-rfc/tables/reject-column-ranges.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/reject-column-ranges.nu rename to stdlib-candidate-old/std-rfc/tables/reject-column-ranges.nu diff --git a/stdlib-candidate/std-rfc/tables/reject-ranges.nu b/stdlib-candidate-old/std-rfc/tables/reject-ranges.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/reject-ranges.nu rename to stdlib-candidate-old/std-rfc/tables/reject-ranges.nu diff --git a/stdlib-candidate/std-rfc/tables/row-indices.nu b/stdlib-candidate-old/std-rfc/tables/row-indices.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/row-indices.nu rename to stdlib-candidate-old/std-rfc/tables/row-indices.nu diff --git a/stdlib-candidate/std-rfc/tables/select-column-ranges.nu b/stdlib-candidate-old/std-rfc/tables/select-column-ranges.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/select-column-ranges.nu rename to stdlib-candidate-old/std-rfc/tables/select-column-ranges.nu diff --git a/stdlib-candidate/std-rfc/tables/select-ranges.nu b/stdlib-candidate-old/std-rfc/tables/select-ranges.nu similarity index 100% rename from stdlib-candidate/std-rfc/tables/select-ranges.nu rename to stdlib-candidate-old/std-rfc/tables/select-ranges.nu diff --git a/stdlib-candidate/tests/bench.nu b/stdlib-candidate-old/tests/bench.nu similarity index 100% rename from stdlib-candidate/tests/bench.nu rename to stdlib-candidate-old/tests/bench.nu diff --git a/stdlib-candidate/tests/bulk-rename.nu b/stdlib-candidate-old/tests/bulk-rename.nu similarity index 100% rename from stdlib-candidate/tests/bulk-rename.nu rename to stdlib-candidate-old/tests/bulk-rename.nu diff --git a/stdlib-candidate/tests/conversions.nu b/stdlib-candidate-old/tests/conversions.nu similarity index 100% rename from stdlib-candidate/tests/conversions.nu rename to stdlib-candidate-old/tests/conversions.nu diff --git a/stdlib-candidate/tests/math.nu b/stdlib-candidate-old/tests/math.nu similarity index 100% rename from stdlib-candidate/tests/math.nu rename to stdlib-candidate-old/tests/math.nu diff --git a/stdlib-candidate/tests/mod.nu b/stdlib-candidate-old/tests/mod.nu similarity index 100% rename from stdlib-candidate/tests/mod.nu rename to stdlib-candidate-old/tests/mod.nu diff --git a/stdlib-candidate/tests/record.nu b/stdlib-candidate-old/tests/record.nu similarity index 100% rename from stdlib-candidate/tests/record.nu rename to stdlib-candidate-old/tests/record.nu diff --git a/stdlib-candidate/tests/script-parsing.nu b/stdlib-candidate-old/tests/script-parsing.nu similarity index 100% rename from stdlib-candidate/tests/script-parsing.nu rename to stdlib-candidate-old/tests/script-parsing.nu diff --git a/stdlib-candidate/tests/str_dedent.nu b/stdlib-candidate-old/tests/str_dedent.nu similarity index 100% rename from stdlib-candidate/tests/str_dedent.nu rename to stdlib-candidate-old/tests/str_dedent.nu diff --git a/stdlib-candidate/tests/str_xpend.nu b/stdlib-candidate-old/tests/str_xpend.nu similarity index 100% rename from stdlib-candidate/tests/str_xpend.nu rename to stdlib-candidate-old/tests/str_xpend.nu diff --git a/stdlib-candidate/tests/tables.nu b/stdlib-candidate-old/tests/tables.nu similarity index 100% rename from stdlib-candidate/tests/tables.nu rename to stdlib-candidate-old/tests/tables.nu diff --git a/stdlib-candidate/README.md b/stdlib-candidate/README.md index 4c84971..18f4bd4 100644 --- a/stdlib-candidate/README.md +++ b/stdlib-candidate/README.md @@ -1,4 +1,40 @@ # std-lib candidate -This folder is where we can add scripts that might want to be in std-lib at some point. It can serve both as a holding place for scripts that are waiting on nushell changes, as well as a place to develop and discuss such scripts. +## 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 +* Have broad appeal to other users +* Include doc comments for definitions and parameters that can be used with `help ` +* Include tests + +The last two (doc and tests) do not need to be in place at the time of the initial inclusion in `stdlib-candidate`, but are, of course, required in order to promote to `std`. + +## Showcase and Discussion + +While primary feedback should take place in the PR, we have also established a [Drawing Board Discord Showcase](https://discord.gg/C3eMKV58MQ) which can be used for several purposes: + +* Ideation before a PR is submitted +* Raise awareness of the PR +* Short-term questions and discussion + +Note: The Drawing Board is not just for stdlib-candidate. Please tag your topic with `std-library` if it is about a Standard Library idea. + +## Promotion Evaluation + +In general, PRs will be evaluated after they have been trialed for a sufficient period, expected to be around 2 months. After that period, the feature may be: + +* Promoted to `std` +* Removed from `stdlib-candidate` +* Or changes may be requested and then reevaluated later + +## NUPM Note + +When submitting a PR, please bump the module's `nupm.nuon`. + +# Previous Repo + +Note: As of December 2024, the candidate module has been "reset" to start fresh. The previous version has been moved to https://github.com/nushell/nu_scripts/tree/main/stdlib-candidate-old + diff --git a/stdlib-candidate/nupm.nuon b/stdlib-candidate/nupm.nuon index 12c19a6..600a777 100644 --- a/stdlib-candidate/nupm.nuon +++ b/stdlib-candidate/nupm.nuon @@ -3,6 +3,6 @@ description: "Official candidates for Nushell standard library" documentation: "https://github.com/nushell/nu_scripts/blob/main/stdlib-candidate/std-rfc/README.md" license: "https://github.com/nushell/nu_scripts/blob/main/LICENSE" - version: 0.3.0 + version: 0.4.0 type: "module" }