2024-05-13 13:37:53 +00:00
|
|
|
use crate::repl::tests::{fail_test, run_test, TestResult};
|
2021-12-25 19:39:42 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_imports_1() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { export def a [] { 1 }; def b [] { 2 } }; use foo; foo a"#,
|
|
|
|
"1",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_imports_2() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { export def a [] { 1 }; def b [] { 2 } }; use foo a; a"#,
|
|
|
|
"1",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_imports_3() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { export def a [] { 1 }; export def b [] { 2 } }; use foo *; b"#,
|
|
|
|
"2",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_imports_4() -> TestResult {
|
|
|
|
fail_test(
|
|
|
|
r#"module foo { export def a [] { 1 }; export def b [] { 2 } }; use foo c"#,
|
|
|
|
"not find import",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_imports_5() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { export def a [] { 1 }; def b [] { '2' }; export def c [] { '3' } }; use foo [a, c]; c"#,
|
|
|
|
"3",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_env_imports_1() -> TestResult {
|
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module foo { export-env { $env.a = '1' } }; use foo; $env.a"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"1",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_env_imports_2() -> TestResult {
|
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module foo { export-env { $env.a = '1'; $env.b = '2' } }; use foo; $env.b"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"2",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2022-09-25 16:52:43 +00:00
|
|
|
fn module_env_imports_3() -> TestResult {
|
2021-12-25 19:39:42 +00:00
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module foo { export-env { $env.a = '1' }; export-env { $env.b = '2' }; export-env {$env.c = '3'} }; use foo; $env.c"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"3",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_and_env_imports_1() -> TestResult {
|
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module spam { export-env { $env.foo = "foo" }; export def foo [] { "bar" } }; use spam; $env.foo"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"foo",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_and_env_imports_2() -> TestResult {
|
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module spam { export-env { $env.foo = "foo" }; export def foo [] { "bar" } }; use spam foo; foo"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"bar",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_def_import_uses_internal_command() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { def b [] { 2 }; export def a [] { b } }; use foo; foo a"#,
|
|
|
|
"2",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn module_env_import_uses_internal_command() -> TestResult {
|
|
|
|
run_test(
|
2023-06-30 19:57:51 +00:00
|
|
|
r#"module foo { def b [] { "2" }; export-env { $env.a = (b) } }; use foo; $env.a"#,
|
2021-12-25 19:39:42 +00:00
|
|
|
"2",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn multi_word_imports() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module spam { export def "foo bar" [] { 10 } }; use spam "foo bar"; foo bar"#,
|
|
|
|
"10",
|
|
|
|
)
|
|
|
|
}
|
2022-03-19 18:58:01 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn export_alias() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module foo { export alias hi = echo hello }; use foo hi; hi"#,
|
|
|
|
"hello",
|
|
|
|
)
|
|
|
|
}
|
Module: support defining const and use const variables inside of function (#9773)
<!--
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.
-->
Relative: #8248
After this pr, user can define const variable inside a module.
![image](https://github.com/nushell/nushell/assets/22256154/e3e03e56-c4b5-4144-a944-d1b20bec1cbd)
And user can export const variables, the following screenshot shows how
it works (it follows
https://github.com/nushell/nushell/issues/8248#issuecomment-1637442612):
![image](https://github.com/nushell/nushell/assets/22256154/b2c14760-3f27-41cc-af77-af70a4367f2a)
## About the change
1. To make module support const, we need to change `parse_module_block`
to support `const` keyword.
2. To suport export `const`, we need to make module tracking variables,
so we add `variables` attribute to `Module`
3. During eval, the const variable may not exists in `stack`, because we
don't eval `const` when we define a module, so we need to find variables
which are already registered in `engine_state`
## One more thing to note about the const value.
Consider the following code
```
module foo { const b = 3; export def bar [] { $b } }
use foo bar
const b = 4;
bar
```
The result will be 3 (which is defined in module) rather than 4. I think
it's expected behavior.
It's something like [dynamic
binding](https://www.gnu.org/software/emacs/manual/html_node/elisp/Dynamic-Binding-Tips.html)
vs [lexical
binding](https://www.gnu.org/software/emacs/manual/html_node/elisp/Lexical-Binding.html)
in lisp like language, and lexical binding should be right behavior
which generates more predicable result, and it doesn't introduce really
subtle bugs in nushell code.
What if user want dynamic-binding?(For example: the example code returns
`4`)
There is no way to do this, user should consider passing the value as
argument to custom command rather than const.
## TODO
- [X] adding tests for the feature.
- [X] support export const out of module to use.
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
# 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.
-->
2023-07-31 23:09:52 +00:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn export_consts() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module spam { export const b = 3; }; use spam b; $b"#,
|
|
|
|
"3",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
2024-10-17 02:25:45 +00:00
|
|
|
#[test]
|
|
|
|
fn dont_export_module_name_as_a_variable() -> TestResult {
|
|
|
|
fail_test(r#"module spam { }; use spam; $spam"#, "variable not found")
|
|
|
|
}
|
|
|
|
|
Module: support defining const and use const variables inside of function (#9773)
<!--
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.
-->
Relative: #8248
After this pr, user can define const variable inside a module.
![image](https://github.com/nushell/nushell/assets/22256154/e3e03e56-c4b5-4144-a944-d1b20bec1cbd)
And user can export const variables, the following screenshot shows how
it works (it follows
https://github.com/nushell/nushell/issues/8248#issuecomment-1637442612):
![image](https://github.com/nushell/nushell/assets/22256154/b2c14760-3f27-41cc-af77-af70a4367f2a)
## About the change
1. To make module support const, we need to change `parse_module_block`
to support `const` keyword.
2. To suport export `const`, we need to make module tracking variables,
so we add `variables` attribute to `Module`
3. During eval, the const variable may not exists in `stack`, because we
don't eval `const` when we define a module, so we need to find variables
which are already registered in `engine_state`
## One more thing to note about the const value.
Consider the following code
```
module foo { const b = 3; export def bar [] { $b } }
use foo bar
const b = 4;
bar
```
The result will be 3 (which is defined in module) rather than 4. I think
it's expected behavior.
It's something like [dynamic
binding](https://www.gnu.org/software/emacs/manual/html_node/elisp/Dynamic-Binding-Tips.html)
vs [lexical
binding](https://www.gnu.org/software/emacs/manual/html_node/elisp/Lexical-Binding.html)
in lisp like language, and lexical binding should be right behavior
which generates more predicable result, and it doesn't introduce really
subtle bugs in nushell code.
What if user want dynamic-binding?(For example: the example code returns
`4`)
There is no way to do this, user should consider passing the value as
argument to custom command rather than const.
## TODO
- [X] adding tests for the feature.
- [X] support export const out of module to use.
# User-Facing Changes
<!-- List of all changes that impact the user experience here. This
helps us keep track of breaking changes. -->
# 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.
-->
2023-07-31 23:09:52 +00:00
|
|
|
#[test]
|
|
|
|
fn func_use_consts() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module spam { const b = 3; export def c [] { $b } }; use spam; spam c"#,
|
|
|
|
"3",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn export_module_which_defined_const() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module spam { export const b = 3; export const c = 4 }; use spam; $spam.b + $spam.c"#,
|
|
|
|
"7",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn cannot_export_private_const() -> TestResult {
|
|
|
|
fail_test(
|
|
|
|
r#"module spam { const b = 3; export const c = 4 }; use spam; $spam.b + $spam.c"#,
|
|
|
|
"cannot find column 'b'",
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_lexical_binding() -> TestResult {
|
|
|
|
run_test(
|
|
|
|
r#"module spam { const b = 3; export def c [] { $b } }; use spam c; const b = 4; c"#,
|
|
|
|
"3",
|
|
|
|
)?;
|
|
|
|
run_test(
|
|
|
|
r#"const b = 4; module spam { const b = 3; export def c [] { $b } }; use spam; spam c"#,
|
|
|
|
"3",
|
|
|
|
)
|
|
|
|
}
|