mirror of
https://github.com/nushell/nushell
synced 2024-12-27 05:23:11 +00:00
3148acd3a4
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> https://github.com/nushell/nushell/pull/9773 introduced constants to modules and allowed to export them, but only within one level. This PR: * allows recursive exporting of constants from all submodules * fixes submodule imports in a list import pattern * makes sure exported constants are actual constants Should unblock https://github.com/nushell/nushell/pull/9678 ### Example: ```nushell module spam { export module eggs { export module bacon { export const viking = 'eats' } } } use spam print $spam.eggs.bacon.viking # prints 'eats' use spam [eggs] print $eggs.bacon.viking # prints 'eats' use spam eggs bacon viking print $viking # prints 'eats' ``` ### Limitation 1: Considering the above `spam` module, attempting to get `eggs bacon` from `spam` module doesn't work directly: ```nushell use spam [ eggs bacon ] # attempts to load `eggs`, then `bacon` use spam [ "eggs bacon" ] # obviously wrong name for a constant, but doesn't work also for commands ``` Workaround (for example): ```nushell use spam eggs use eggs [ bacon ] print $bacon.viking # prints 'eats' ``` I'm thinking I'll just leave it in, as you can easily work around this. It is also a limitation of the import pattern in general, not just constants. ### Limitation 2: `overlay use` successfully imports the constants, but `overlay hide` does not hide them, even though it seems to hide normal variables successfully. This needs more investigation. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> Allows recursive constant exports from submodules. # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
252 lines
5.7 KiB
Rust
252 lines
5.7 KiB
Rust
use nu_test_support::nu;
|
|
use pretty_assertions::assert_eq;
|
|
|
|
const MODULE_SETUP: &str = r#"
|
|
module spam {
|
|
export const X = 'x'
|
|
export module eggs {
|
|
export const E = 'e'
|
|
export module bacon {
|
|
export const viking = 'eats'
|
|
export module none {}
|
|
}
|
|
}
|
|
}
|
|
"#;
|
|
|
|
#[test]
|
|
fn const_bool() {
|
|
let inp = &["const x = false", "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "false");
|
|
}
|
|
|
|
#[test]
|
|
fn const_int() {
|
|
let inp = &["const x = 10", "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "10");
|
|
}
|
|
|
|
#[test]
|
|
fn const_float() {
|
|
let inp = &["const x = 1.234", "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "1.234");
|
|
}
|
|
|
|
#[test]
|
|
fn const_binary() {
|
|
let inp = &["const x = 0x[12]", "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert!(actual.out.contains("12"));
|
|
}
|
|
|
|
#[test]
|
|
fn const_datetime() {
|
|
let inp = &["const x = 2021-02-27T13:55:40+00:00", "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert!(actual.out.contains("Sat, 27 Feb 2021 13:55:40"));
|
|
}
|
|
|
|
#[test]
|
|
fn const_list() {
|
|
let inp = &["const x = [ a b c ]", "$x | describe"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "list<string>");
|
|
}
|
|
|
|
#[test]
|
|
fn const_record() {
|
|
let inp = &["const x = { a: 10, b: 20, c: 30 }", "$x | describe"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "record<a: int, b: int, c: int>");
|
|
}
|
|
|
|
#[test]
|
|
fn const_table() {
|
|
let inp = &[
|
|
"const x = [[a b c]; [10 20 30] [100 200 300]]",
|
|
"$x | describe",
|
|
];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "table<a: int, b: int, c: int>");
|
|
}
|
|
|
|
#[test]
|
|
fn const_string() {
|
|
let inp = &[r#"const x = "abc""#, "$x"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "abc");
|
|
}
|
|
|
|
#[test]
|
|
fn const_nothing() {
|
|
let inp = &["const x = $nothing", "$x | describe"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "nothing");
|
|
}
|
|
|
|
#[test]
|
|
fn const_unsupported() {
|
|
let inp = &["const x = ('abc' | str length)"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert!(actual.err.contains("not_a_constant"));
|
|
}
|
|
|
|
#[test]
|
|
fn const_in_scope() {
|
|
let inp = &["do { const x = 'x'; $x }"];
|
|
|
|
let actual = nu!(&inp.join("; "));
|
|
|
|
assert_eq!(actual.out, "x");
|
|
}
|
|
|
|
#[test]
|
|
fn complex_const_export() {
|
|
let inp = &[MODULE_SETUP, "use spam", "$spam.X"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "x");
|
|
|
|
let inp = &[MODULE_SETUP, "use spam", "$spam.eggs.E"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "e");
|
|
|
|
let inp = &[MODULE_SETUP, "use spam", "$spam.eggs.bacon.viking"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "eats");
|
|
|
|
let inp = &[
|
|
MODULE_SETUP,
|
|
"use spam",
|
|
"($spam.eggs.bacon.none | is-empty)",
|
|
];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn complex_const_glob_export() {
|
|
let inp = &[MODULE_SETUP, "use spam *", "$X"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "x");
|
|
|
|
let inp = &[MODULE_SETUP, "use spam *", "$eggs.E"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "e");
|
|
|
|
let inp = &[MODULE_SETUP, "use spam *", "$eggs.bacon.viking"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "eats");
|
|
|
|
let inp = &[MODULE_SETUP, "use spam *", "($eggs.bacon.none | is-empty)"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn complex_const_drill_export() {
|
|
let inp = &[
|
|
MODULE_SETUP,
|
|
"use spam eggs bacon none",
|
|
"($none | is-empty)",
|
|
];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "true");
|
|
}
|
|
|
|
#[test]
|
|
fn complex_const_list_export() {
|
|
let inp = &[
|
|
MODULE_SETUP,
|
|
"use spam [X eggs]",
|
|
"[$X $eggs.E] | str join ''",
|
|
];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "xe");
|
|
}
|
|
|
|
#[test]
|
|
fn exported_const_is_const() {
|
|
let module1 = "module foo {
|
|
export def main [] { 'foo' }
|
|
}";
|
|
|
|
let module2 = "module spam {
|
|
export const MOD_NAME = 'foo'
|
|
}";
|
|
|
|
let inp = &[module1, module2, "use spam", "use $spam.MOD_NAME", "foo"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "foo");
|
|
}
|
|
|
|
#[test]
|
|
fn const_captures_work() {
|
|
let module = "module spam {
|
|
export const X = 'x'
|
|
const Y = 'y'
|
|
|
|
export-env { $env.SPAM = $X + $Y }
|
|
export def main [] { $X + $Y }
|
|
}";
|
|
|
|
let inp = &[module, "use spam", "$env.SPAM"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "xy");
|
|
|
|
let inp = &[module, "use spam", "spam"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "xy");
|
|
}
|
|
|
|
#[ignore = "TODO: Need to fix `overlay hide` to hide the constants brough by `overlay use`"]
|
|
#[test]
|
|
fn complex_const_overlay_use_hide() {
|
|
let inp = &[MODULE_SETUP, "overlay use spam", "$X"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "x");
|
|
|
|
let inp = &[MODULE_SETUP, "overlay use spam", "$eggs.E"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "e");
|
|
|
|
let inp = &[MODULE_SETUP, "overlay use spam", "$eggs.bacon.viking"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "eats");
|
|
|
|
let inp = &[
|
|
MODULE_SETUP,
|
|
"overlay use spam",
|
|
"($eggs.bacon.none | is-empty)",
|
|
];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert_eq!(actual.out, "true");
|
|
|
|
let inp = &[MODULE_SETUP, "overlay use spam", "overlay hide", "$eggs"];
|
|
let actual = nu!(&inp.join("; "));
|
|
assert!(actual.err.contains("nu::parser::variable_not_found"));
|
|
}
|