nushell/crates
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
..
nu_plugin_custom_values bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu_plugin_example bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu_plugin_formats bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu_plugin_gstat Replace &Span with Span since Span is Copy (#9770) 2023-07-31 21:47:46 +02:00
nu_plugin_inc bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu_plugin_python update nu_plugin_python due to signature changes (#8107) 2023-02-18 13:27:24 +00:00
nu_plugin_query Replace &Span with Span since Span is Copy (#9770) 2023-07-31 21:47:46 +02:00
nu-cli Replace &Span with Span since Span is Copy (#9770) 2023-07-31 21:47:46 +02:00
nu-cmd-base bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-cmd-dataframe Merged overloaded commands (#9860) 2023-07-31 07:34:12 -05:00
nu-cmd-extra Replace &Span with Span since Span is Copy (#9770) 2023-07-31 21:47:46 +02:00
nu-cmd-lang Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
nu-color-config bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-command Replace &Span with Span since Span is Copy (#9770) 2023-07-31 21:47:46 +02:00
nu-engine Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
nu-explore bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-glob bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-json bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-parser Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
nu-path bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-plugin bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-pretty-hex bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-protocol Module: support defining const and use const variables inside of function (#9773) 2023-08-01 07:09:52 +08:00
nu-std bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-system bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-table bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-term-grid bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-test-support bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
nu-utils bump to dev version 0.83.2 (#9866) 2023-07-30 22:16:57 +02:00
README.md Remove old nushell/merge engine-q 2022-02-07 14:54:06 -05:00

Nushell core libraries and plugins

These sub-crates form both the foundation for Nu and a set of plugins which extend Nu with additional functionality.

Foundational libraries are split into two kinds of crates:

  • Core crates - those crates that work together to build the Nushell language engine
  • Support crates - a set of crates that support the engine with additional features like JSON support, ANSI support, and more.

Plugins are likewise also split into two types:

  • Core plugins - plugins that provide part of the default experience of Nu, including access to the system properties, processes, and web-connectivity features.
  • Extra plugins - these plugins run a wide range of different capabilities like working with different file types, charting, viewing binary data, and more.