mirror of
https://github.com/nushell/nushell.git
synced 2025-06-30 22:50:14 +02:00
Refactor nu-check (#12137)
<!-- 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. --> This PR refactors `nu-check` and makes it possible to check module directories. Also removes the requirement for files to end with .nu: It was too limiting for module directories and there are executable scripts [around](https://github.com/nushell/nu_scripts/tree/main/make_release/release-note) that do not end with .nu, it's a common practice for scripts to omit it. Other changes are: * Removed the `--all` flag and heuristic parse because these are irrelevant now when module syntax is a subset of script syntax (i.e., every module can be parsed as script). * Reduced code duplication and in general tidied up the code * Replaced unspanned errors with spanned ones. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> * `nu-check` doesn't require files to end with .nu * can check module directories * Removed `--all` flag # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `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. -->
This commit is contained in:
@ -176,52 +176,6 @@ fn file_not_exist() {
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_unsupported_file() {
|
||||
Playground::setup("nu_check_test_8", |dirs, sandbox| {
|
||||
sandbox.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"foo.txt",
|
||||
r#"
|
||||
# foo.nu
|
||||
|
||||
export def hello [name: string {
|
||||
$"hello ($name)!"
|
||||
}
|
||||
|
||||
export def hi [where: string] {
|
||||
$"hi ($where)!"
|
||||
}
|
||||
"#,
|
||||
)]);
|
||||
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
nu-check --as-module foo.txt
|
||||
"
|
||||
));
|
||||
|
||||
assert!(actual
|
||||
.err
|
||||
.contains("File extension must be the type of .nu"));
|
||||
})
|
||||
}
|
||||
#[test]
|
||||
fn parse_dir_failure() {
|
||||
Playground::setup("nu_check_test_9", |dirs, _sandbox| {
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
nu-check --as-module ~
|
||||
"
|
||||
));
|
||||
|
||||
assert!(actual
|
||||
.err
|
||||
.contains("File extension must be the type of .nu"));
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_module_success_2() {
|
||||
Playground::setup("nu_check_test_10", |dirs, sandbox| {
|
||||
@ -554,7 +508,7 @@ fn parse_module_success_with_complex_external_stream() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_with_flag_all_success_for_complex_external_stream() {
|
||||
fn parse_with_flag_success_for_complex_external_stream() {
|
||||
Playground::setup("nu_check_test_20", |dirs, sandbox| {
|
||||
sandbox.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"grep.nu",
|
||||
@ -594,7 +548,7 @@ fn parse_with_flag_all_success_for_complex_external_stream() {
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
open grep.nu | nu-check --all --debug
|
||||
open grep.nu | nu-check --debug
|
||||
"
|
||||
));
|
||||
|
||||
@ -603,7 +557,7 @@ fn parse_with_flag_all_success_for_complex_external_stream() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_with_flag_all_failure_for_complex_external_stream() {
|
||||
fn parse_with_flag_failure_for_complex_external_stream() {
|
||||
Playground::setup("nu_check_test_21", |dirs, sandbox| {
|
||||
sandbox.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"grep.nu",
|
||||
@ -643,16 +597,16 @@ fn parse_with_flag_all_failure_for_complex_external_stream() {
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
open grep.nu | nu-check --all --debug
|
||||
open grep.nu | nu-check --debug
|
||||
"
|
||||
));
|
||||
|
||||
assert!(actual.err.contains("syntax error"));
|
||||
assert!(actual.err.contains("Failed to parse content"));
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_with_flag_all_failure_for_complex_list_stream() {
|
||||
fn parse_with_flag_failure_for_complex_list_stream() {
|
||||
Playground::setup("nu_check_test_22", |dirs, sandbox| {
|
||||
sandbox.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"grep.nu",
|
||||
@ -692,38 +646,11 @@ fn parse_with_flag_all_failure_for_complex_list_stream() {
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
open grep.nu | lines | nu-check --all --debug
|
||||
open grep.nu | lines | nu-check --debug
|
||||
"
|
||||
));
|
||||
|
||||
assert!(actual.err.contains("syntax error"));
|
||||
})
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parse_failure_due_conflicted_flags() {
|
||||
Playground::setup("nu_check_test_23", |dirs, sandbox| {
|
||||
sandbox.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"script.nu",
|
||||
r#"
|
||||
greet "world"
|
||||
|
||||
def greet [name] {
|
||||
echo "hello" $name
|
||||
}
|
||||
"#,
|
||||
)]);
|
||||
|
||||
let actual = nu!(
|
||||
cwd: dirs.test(), pipeline(
|
||||
"
|
||||
nu-check -a --as-module script.nu
|
||||
"
|
||||
));
|
||||
|
||||
assert!(actual
|
||||
.err
|
||||
.contains("You cannot have both `--all` and `--as-module` on the same command line"));
|
||||
assert!(actual.err.contains("Failed to parse content"));
|
||||
})
|
||||
}
|
||||
|
||||
@ -793,3 +720,27 @@ fn nu_check_respects_file_pwd() {
|
||||
assert_eq!(actual.out, "true");
|
||||
})
|
||||
}
|
||||
#[test]
|
||||
fn nu_check_module_dir() {
|
||||
Playground::setup("nu_check_test_26", |dirs, sandbox| {
|
||||
sandbox
|
||||
.mkdir("lol")
|
||||
.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"lol/mod.nu",
|
||||
r#"
|
||||
export module foo.nu
|
||||
export def main [] { 'lol' }
|
||||
"#,
|
||||
)])
|
||||
.with_files(vec![FileWithContentToBeTrimmed(
|
||||
"lol/foo.nu",
|
||||
r#"
|
||||
export def main [] { 'lol foo' }
|
||||
"#,
|
||||
)]);
|
||||
|
||||
let actual = nu!(cwd: dirs.test(), pipeline( "nu-check lol"));
|
||||
|
||||
assert_eq!(actual.out, "true");
|
||||
})
|
||||
}
|
||||
|
Reference in New Issue
Block a user