Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate std testing #11151

Merged
merged 5 commits into from
Dec 2, 2023
Merged

deprecate std testing #11151

merged 5 commits into from
Dec 2, 2023

Conversation

amtoine
Copy link
Member

@amtoine amtoine commented Nov 24, 2023

Description

this PR deprecates the std testing module in favor of Nupm.
the plan is to simply hide the module to the user but still use it internally when running the tests so that

  • users don't start to use this module and rather focus on Nupm
  • devs don't have to install anything to run the tests locally, they can just use toolkit test stdlib for instance

the deprecation message will be very similar to #11097

Note
to demonstrate that the removal of such a command from the exposed modules of std will be transparent and not require the user to install anything, i have it prepared in a branch based on this PR
running toolkit test stdlib will run the standard library tests without an issue and yet use std testing won't work 👌

User-Facing Changes

std testing run-tests will be removed in 0.90

Tests + Formatting

After Submitting

@amtoine amtoine added pr:release-note-mention Addition/Improvement to be mentioned in the release notes deprecation Related to the deprecation of commands labels Nov 24, 2023
@amtoine
Copy link
Member Author

amtoine commented Dec 2, 2023

i've added a note to the deprecation warning to clearly state that Nupm isn't production-ready but that people can still try it if they feel comfortable with a changing and unstable API 👌

| Note
| Nupm is still a work in progress and is NOT production-ready, just as `run-tests` is.
| Please keep in mind that Nupm will change a lot in the near future and we can't recommend it for now.
| However, if you like bleeding edge software and want to give it a spin, we would welcome feedbacks and ideas :pray:

@amtoine amtoine merged commit 76bdda1 into nushell:main Dec 2, 2023
19 checks passed
@amtoine amtoine deleted the deprecate-std-testing branch December 2, 2023 12:15
hardfau1t pushed a commit to hardfau1t/nushell that referenced this pull request Dec 14, 2023
# Description
this PR deprecates the `std testing` module in favor of Nupm.
the plan is to simply hide the module to the user but still use it
internally when running the tests so that
- users don't start to use this module and rather focus on Nupm
- devs don't have to install anything to run the tests locally, they can
just use `toolkit test stdlib` for instance

the deprecation message will be very similar to
nushell#11097

> **Note**
> to demonstrate that the removal of such a command from the exposed
modules of `std` will be transparent and not require the user to install
anything, i have it [prepared in a branch based on this
PR](amtoine/nushell@deprecate-std-testing...amtoine:nushell:hide-std-testing)
> running `toolkit test stdlib` will run the standard library tests
without an issue and yet `use std testing` won't work 👌

# User-Facing Changes
`std testing run-tests` will be removed in `0.90`

# Tests + Formatting

# After Submitting
@amtoine amtoine mentioned this pull request Dec 14, 2023
kubouch pushed a commit that referenced this pull request Jan 25, 2024
follow-up to
- #11151

> **Important**
> land only between 0.89 and 0.90

# Description
this PR hides the `std testing` module from the outside.
- moves `nu-std/std/testing.nu` to `nu-std/testing.nu`
- removes the module from the standard library list of modules to parse
- fixes `toolkit.nu` and the CI

# User-Facing Changes
`std testing` won't be part of the standard library anymore.
# Tests + Formatting

# After Submitting
dmatos2012 pushed a commit to dmatos2012/nushell that referenced this pull request Feb 20, 2024
# Description
this PR deprecates the `std testing` module in favor of Nupm.
the plan is to simply hide the module to the user but still use it
internally when running the tests so that
- users don't start to use this module and rather focus on Nupm
- devs don't have to install anything to run the tests locally, they can
just use `toolkit test stdlib` for instance

the deprecation message will be very similar to
nushell#11097

> **Note**
> to demonstrate that the removal of such a command from the exposed
modules of `std` will be transparent and not require the user to install
anything, i have it [prepared in a branch based on this
PR](amtoine/nushell@deprecate-std-testing...amtoine:nushell:hide-std-testing)
> running `toolkit test stdlib` will run the standard library tests
without an issue and yet `use std testing` won't work 👌

# User-Facing Changes
`std testing run-tests` will be removed in `0.90`

# Tests + Formatting

# After Submitting
dmatos2012 pushed a commit to dmatos2012/nushell that referenced this pull request Feb 20, 2024
follow-up to
- nushell#11151

> **Important**
> land only between 0.89 and 0.90

# Description
this PR hides the `std testing` module from the outside.
- moves `nu-std/std/testing.nu` to `nu-std/testing.nu`
- removes the module from the standard library list of modules to parse
- fixes `toolkit.nu` and the CI

# User-Facing Changes
`std testing` won't be part of the standard library anymore.
# Tests + Formatting

# After Submitting
@IanManske IanManske mentioned this pull request May 11, 2024
fdncred pushed a commit that referenced this pull request May 13, 2024
# Description
Updates the command listed in the PR template to test the standard
library, following from #11151.
FilipAndersson245 pushed a commit to FilipAndersson245/nushell that referenced this pull request May 18, 2024
# Description
Updates the command listed in the PR template to test the standard
library, following from nushell#11151.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Related to the deprecation of commands pr:release-note-mention Addition/Improvement to be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant