nushell/crates/nu-cmd-lang/src/core_commands
WindSoilder f6033ac5af
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-08-01 07:09:52 +08:00
..
overlay remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
scope split $nu variable into scope commands and simpler $nu (#9487) 2023-06-21 09:33:01 +12:00
alias.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
break_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00
collect.rs Input output checking (#9680) 2023-07-14 15:20:35 +12:00
const_.rs Fix broken constants in scopes (#9679) 2023-07-14 00:02:05 +03:00
continue_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00
def_env.rs remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
def.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
describe.rs Cratification: Break out nu_cmd_lang into a separate crate (#8181) 2023-02-24 09:54:42 -06:00
do_.rs Restrict closure expression to be something like {|| ...} (#8290) 2023-03-17 07:36:28 -05:00
echo.rs Cratification: Break out nu_cmd_lang into a separate crate (#8181) 2023-02-24 09:54:42 -06:00
error_make.rs allow records to have type annotations (#8914) 2023-04-26 08:16:55 -05:00
export_alias.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
export_const.rs Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
export_def_env.rs remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
export_def.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
export_extern.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
export_module.rs Allow creating modules from directories (#9066) 2023-05-06 21:39:54 +03:00
export_use.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
export.rs Cratification: Break out nu_cmd_lang into a separate crate (#8181) 2023-02-24 09:54:42 -06:00
extern_.rs Custom command input/output types (#9690) 2023-07-15 09:51:28 +12:00
extern_wrapped.rs Custom command input/output types (#9690) 2023-07-15 09:51:28 +12:00
for_.rs Remove autoprinting of for loop (#8843) 2023-04-11 05:23:22 +12:00
hide_env.rs remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
hide.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
if_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00
ignore.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
lazy_make.rs Feature: Userland LazyRecords (#8332) 2023-05-17 18:35:22 -05:00
let_.rs fix input signature of let/mut (#9695) 2023-07-15 19:41:48 +12:00
loop_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00
match_.rs add match guards (#9621) 2023-07-16 12:25:12 +12:00
mod.rs Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
module.rs remove let-env, focus on mutating $env (#9574) 2023-07-01 07:57:51 +12:00
mut_.rs fix input signature of let/mut (#9695) 2023-07-15 19:41:48 +12:00
register.rs Clarify how register works (#8583) 2023-03-23 13:02:22 -05:00
return_.rs Uniformize usage() and extra_usage() message ending for commands helper. (#8268) 2023-02-28 21:33:02 -08:00
try_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00
use_.rs Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
version.rs Changes global allocator to mimalloc, improving performance. (#9415) 2023-06-14 17:27:12 -05:00
while_.rs Remove parser keywords label from commands that do not need it (#8780) 2023-04-07 01:12:21 +03:00