mirror of
https://github.com/nushell/nushell.git
synced 2024-11-23 00:43:33 +01:00
9e3d6c3bfd
# Description We were seeing duplicate entries for the std lib files, and this PR addresses that. Each file should now only be added once. Note: they are still parsed twice because it's hard to recover the module from the output of `parse` but a bit of clever hacking in a future PR might be able to do that. # 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` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` 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.
106 lines
3.0 KiB
Rust
106 lines
3.0 KiB
Rust
use nu_command::create_default_context;
|
|
use nu_protocol::{engine::StateWorkingSet, Category};
|
|
use quickcheck_macros::quickcheck;
|
|
|
|
mod commands;
|
|
mod format_conversions;
|
|
|
|
#[quickcheck]
|
|
fn quickcheck_parse(data: String) -> bool {
|
|
let (tokens, err) = nu_parser::lex(data.as_bytes(), 0, b"", b"", true);
|
|
|
|
if err.is_none() {
|
|
let context = create_default_context();
|
|
{
|
|
let mut working_set = StateWorkingSet::new(&context);
|
|
let _ = working_set.add_file("quickcheck".into(), data.as_bytes());
|
|
|
|
let _ = nu_parser::parse_block(&mut working_set, &tokens, false, false);
|
|
}
|
|
}
|
|
true
|
|
}
|
|
|
|
#[test]
|
|
fn signature_name_matches_command_name() {
|
|
let ctx = crate::create_default_context();
|
|
let decls = ctx.get_decls_sorted(true);
|
|
let mut failures = Vec::new();
|
|
|
|
for (name_bytes, decl_id) in decls {
|
|
let cmd = ctx.get_decl(decl_id);
|
|
let cmd_name = String::from_utf8_lossy(&name_bytes);
|
|
let sig_name = cmd.signature().name;
|
|
let category = cmd.signature().category;
|
|
|
|
if cmd_name != sig_name {
|
|
failures.push(format!(
|
|
"{cmd_name} ({category:?}): Signature name \"{sig_name}\" is not equal to the command name \"{cmd_name}\""
|
|
));
|
|
}
|
|
}
|
|
|
|
assert!(
|
|
failures.is_empty(),
|
|
"Name mismatch:\n{}",
|
|
failures.join("\n")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn commands_declare_input_output_types() {
|
|
let ctx = crate::create_default_context();
|
|
let decls = ctx.get_decls_sorted(true);
|
|
let mut failures = Vec::new();
|
|
|
|
for (_, decl_id) in decls {
|
|
let cmd = ctx.get_decl(decl_id);
|
|
let sig_name = cmd.signature().name;
|
|
let category = cmd.signature().category;
|
|
|
|
if matches!(category, Category::Deprecated | Category::Custom(_)) {
|
|
// Deprecated commands don't have to conform
|
|
// TODO: also upgrade the `--features dataframe` commands
|
|
continue;
|
|
}
|
|
|
|
if cmd.signature().input_output_types.is_empty() {
|
|
failures.push(format!(
|
|
"{sig_name} ({category:?}): No pipeline input/output type signatures found"
|
|
));
|
|
}
|
|
}
|
|
|
|
assert!(
|
|
failures.is_empty(),
|
|
"Command missing type annotations:\n{}",
|
|
failures.join("\n")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn no_search_term_duplicates() {
|
|
let ctx = crate::create_default_context();
|
|
let decls = ctx.get_decls_sorted(true);
|
|
let mut failures = Vec::new();
|
|
|
|
for (name_bytes, decl_id) in decls {
|
|
let cmd = ctx.get_decl(decl_id);
|
|
let cmd_name = String::from_utf8_lossy(&name_bytes);
|
|
let search_terms = cmd.search_terms();
|
|
let category = cmd.signature().category;
|
|
|
|
for search_term in search_terms {
|
|
if cmd_name.contains(search_term) {
|
|
failures.push(format!("{cmd_name} ({category:?}): Search term \"{search_term}\" is substring of command name \"{cmd_name}\""));
|
|
}
|
|
}
|
|
}
|
|
|
|
assert!(
|
|
failures.is_empty(),
|
|
"Duplication in search terms:\n{}",
|
|
failures.join("\n")
|
|
);
|
|
}
|