FEATURE: add the first draft of the standard library by amtoine · Pull Request #8150 · nushell/nushell

amtoine · 2023-02-21T10:39:03Z

hello there 👋 😋

as discussed over on the discord server, in #standard-library, there is this new project of putting together a bunch of "standard" scripts and functions and propose a nushell "standard library".
this PR is the first one in that direction 🎉

Note
~~this PR is still a draft to have some feedback 😌~~
this PR is now READY FOR REVIEW 🎉

Description

this PR implements the following few commands:

the assert familly with a private helper _assert
a version of the match statement

i've also added some examples in the docstrings of the functions 👍

User-Facing Changes

the standard library can now be used with

use crates/nu-utils/src/sample_config/std.nu

from the root of the nushell source

Tests + Formatting

i've written a first draft of a tests.nu module which

tests the assert familly of function in test_assert
tests the rest of the standard library in tests

the tests are run with

nu crates/nu-utils/src/sample_config/tests.nu

through the main function and should give no error 👍

Note
if you change one of the test line, there should be an error popping when running the tests 😉

After Submitting

Warning
to be coming

This commit implements the few commands we talked about in the dedicated discord channel, #standard-library: - the `assert` familly with a private helper `_assert` - a version of the `match` statement

Usage: ```bash nu crates/nu-utils/src/sample_config/tests.nu ```

amtoine · 2023-02-23T11:25:06Z

📄 TODO:

add a first draft of std.nu => e730176
add a first draft of tests.nu => 48ccb8b
make sure the tests have a correct form
make sure the tests cover the few first functions
make sure the calling method, both for useing the library and running the tests, are easy to use
add documentation to the std.nu functions
add better error messages (maybe for later?)
probably some other things here 😋

fdncred · 2023-02-23T12:27:29Z

Seems like a good start. It doesn't have to be perfect the first time. We'll continue to iterate.

jmoore34 · 2023-02-23T21:02:01Z

Perhaps assert_eq and such could be subcommands, eg assert eq with a space, for better discoverability

@jmoore34

This change has been proposed by @jmoore34 and validated by @fdncred, advocating better discoverability. Commands used: ```bash sd 'def assert_eq' 'def "assert eq"' crates/nu-utils/src/sample_config/std.nu sd '`assert_eq`' '`assert eq`' crates/nu-utils/src/sample_config/std.nu sd 'assert_eq' 'assert eq' crates/nu-utils/src/sample_config/tests.nu sd 'def assert_ne' 'def "assert ne"' crates/nu-utils/src/sample_config/std.nu sd '`assert_ne`' '`assert ne`' crates/nu-utils/src/sample_config/std.nu sd 'assert_ne' 'assert ne' crates/nu-utils/src/sample_config/tests.nu ```

amtoine · 2023-02-24T08:40:42Z

@fdncred @jmoore34

Perhaps assert_eq and such could be subcommands, eg assert eq with a space, for better discoverability

no problem, i've changed that in 839d7bf 👍

Seems like a good start. It doesn't have to be perfect the first time. We'll continue to iterate.

gotcha 👌
then we can mark that as "ready for review" and merge it if you want.
the TODO can be moved to some other place 😋

amtoine · 2023-02-24T09:01:54Z

mm how can i fix https://github.com/nushell/nushell/actions/runs/4260734684/jobs/7414370252? 😕

sholderbach · 2023-02-25T19:26:57Z

mm how can i fix nushell/nushell/actions/runs/4260734684/jobs/7414370252? 😕

We removed the Windows coverage run for now as our setup was currently incompatible with the limited disk allocation on those workers. Should resolve by merging main.

amtoine · 2023-02-26T10:04:10Z

We removed the Windows coverage run for now as our setup was currently incompatible with the limited disk allocation on those workers. Should resolve by merging main.

got it 👌
i'll merge this branch into main and we'll see if that fixes the CI!

…rary

amtoine · 2023-02-26T10:22:10Z

there it is, merged on very latest main 🤞

codecov · 2023-02-26T10:50:43Z

Codecov Report

Merging #8150 (446e661) into main (b27c770) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8150   +/-   ##
=======================================
  Coverage   68.87%   68.88%           
=======================================
  Files         617      617           
  Lines       99259    99259           
=======================================
+ Hits        68362    68371    +9     
+ Misses      30897    30888    -9

Impacted Files	Coverage Δ
crates/nu-parser/src/parser.rs	`83.82% <0.00%> (+0.18%)`	⬆️

amtoine · 2023-02-26T11:11:11Z

@sholderbach
cool it worked 🤩

sholderbach · 2023-02-27T11:07:18Z

What is the general status? I would favour landing as soon as possible so potential bikeshedding can happen in their respective topical PRs.

amtoine · 2023-02-27T18:03:26Z

What is the general status? I would favour landing as soon as possible so potential bikeshedding can happen in their respective topical PRs.

as been already said, that might be a good start, at least i've done what i had in mind for this very first PR 👍

fdncred · 2023-02-27T23:52:43Z

Let's land this and keep building.

Related to nushell/nushell#8150.

Related to #8150, #8635 and #8632. # Description i've introduced a bad set of tests for the `assert equal` command in #8150... they should not compare `1 + 2` and `4)` or `3)` but the ints. in this PR, i remove this spurious parentheses that were not planned at all 😬 👀 # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` >_ nu crates/nu-utils/standard_library/tests.nu INF|2023-03-28T20:18:13.022|Running tests in test_asserts INF|2023-03-28T20:18:13.173|Running tests in test_dirs INF|2023-03-28T20:18:13.247|Running tests in test_logger INF|2023-03-28T20:18:13.473|Running tests in test_std ``` # After Submitting ``` $nothing ```

Related to nushell#8150, nushell#8635 and nushell#8632. # Description i've introduced a bad set of tests for the `assert equal` command in nushell#8150... they should not compare `1 + 2` and `4)` or `3)` but the ints. in this PR, i remove this spurious parentheses that were not planned at all 😬 👀 # User-Facing Changes ``` $nothing ``` # Tests + Formatting ``` >_ nu crates/nu-utils/standard_library/tests.nu INF|2023-03-28T20:18:13.022|Running tests in test_asserts INF|2023-03-28T20:18:13.173|Running tests in test_dirs INF|2023-03-28T20:18:13.247|Running tests in test_logger INF|2023-03-28T20:18:13.473|Running tests in test_std ``` # After Submitting ``` $nothing ```

add the first batch of commands to standard library

e730176

This commit implements the few commands we talked about in the dedicated discord channel, #standard-library: - the `assert` familly with a private helper `_assert` - a version of the `match` statement

amtoine changed the title ~~FIRST: add the first draft of the standard library~~ FEATURE: add the first draft of the standard library Feb 21, 2023

amtoine mentioned this pull request Feb 22, 2023

FEATURE: wrap the dev instructions from the PR template for easier use #8152

Merged

add a tests.nu module to test std.nu

48ccb8b

Usage: ```bash nu crates/nu-utils/src/sample_config/tests.nu ```

amtoine marked this pull request as ready for review February 24, 2023 08:40

Merge commit 'b27c7702f' into feature/first-draft-of-the-standard-lib…

446e661

…rary

fdncred merged commit 9e589a9 into nushell:main Feb 27, 2023

amtoine deleted the feature/first-draft-of-the-standard-library branch February 28, 2023 17:19

amtoine mentioned this pull request Mar 4, 2023

standard library: a few ideas of commands #8311

Open

14 tasks

amtoine added a commit to goatfiles/nu_scripts that referenced this pull request Mar 4, 2023

remove the match command as it's now in the standard library

9c5bdd8

Related to nushell/nushell#8150.

fdncred added the A:std-library Defining and improving the standard library written in Nu label Mar 14, 2023

amtoine mentioned this pull request Mar 28, 2023

stdlib: fix the assert equal tests #8650

Merged

Conversation

amtoine commented Feb 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

User-Facing Changes

Tests + Formatting

After Submitting

Uh oh!

amtoine commented Feb 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📄 TODO:

Uh oh!

fdncred commented Feb 23, 2023

Uh oh!

jmoore34 commented Feb 23, 2023

Uh oh!

amtoine commented Feb 24, 2023

Uh oh!

amtoine commented Feb 24, 2023

Uh oh!

sholderbach commented Feb 25, 2023

Uh oh!

amtoine commented Feb 26, 2023

Uh oh!

amtoine commented Feb 26, 2023

Uh oh!

codecov bot commented Feb 26, 2023

Codecov Report

Uh oh!

amtoine commented Feb 26, 2023

Uh oh!

sholderbach commented Feb 27, 2023

Uh oh!

amtoine commented Feb 27, 2023

Uh oh!

fdncred commented Feb 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

amtoine commented Feb 21, 2023 •

edited

Loading

amtoine commented Feb 23, 2023 •

edited

Loading