nushell/crates/nu-parser/src/lib.rs

mod deparse;
mod flatten;
mod known_external;
mod lex;
mod lite_parser;
mod parse_keywords;
mod parse_patterns;
mod parser;
mod parser_path;
mod type_check;

pub use deparse::{escape_for_script_arg, escape_quote_string};
pub use flatten::{
    flatten_block, flatten_expression, flatten_pipeline, flatten_pipeline_element, FlatShape,
};
pub use known_external::KnownExternal;
pub use lex::{lex, lex_signature, Token, TokenContents};
pub use lite_parser::{lite_parse, LiteBlock, LiteElement};
pub use parse_keywords::*;
pub use parser_path::*;

pub use parser::{
    is_math_expression_like, parse, parse_block, parse_expression, parse_external_call,
    parse_unit_value, trim_quotes, trim_quotes_str, unescape_unquote_string, DURATION_UNIT_GROUPS,
};

#[cfg(feature = "plugin")]
pub use parse_keywords::parse_register;
Fix quoting for command line args (#5384) * Fix quoting for command line args * Replace custom quoting with escape_quote_string * Use raw string for now 2022-04-30 20:23:05 +02:00			`mod deparse;`
refactor to subcrates 2021-08-10 20:51:08 +02:00			`mod flatten;`
Add support for defining known externals with their own custom completions (#4425) * WIP for known externals * Now completions can work from scripts * Add support for definiing externs * finish cleaning up old proof-of-concept 2022-02-11 19:38:10 +01:00			`mod known_external;`
refactor to subcrates 2021-08-10 20:51:08 +02:00			`mod lex;`
Small parser refactors (#7568) 2022-12-22 12:41:44 +01:00			`mod lite_parser;`
Add support for module imports 2021-09-26 20:39:19 +02:00			`mod parse_keywords;`
Add pattern matching (#8590) # Description This adds `match` and basic pattern matching. An example: ``` match $x { 1..10 => { print "Value is between 1 and 10" } { foo: $bar } => { print $"Value has a 'foo' field with value ($bar)" } [$a, $b] => { print $"Value is a list with two items: ($a) and ($b)" } _ => { print "Value is none of the above" } } ``` Like the recent changes to `if` to allow it to be used as an expression, `match` can also be used as an expression. This allows you to assign the result to a variable, eg) `let xyz = match ...` I've also included a short-hand pattern for matching records, as I think it might help when doing a lot of record patterns: `{$foo}` which is equivalent to `{foo: $foo}`. There are still missing components, so consider this the first step in full pattern matching support. Currently missing: * Patterns for strings * Or-patterns (like the `\|` in Rust) * Patterns for tables (unclear how we want to match a table, so it'll need some design) * Patterns for binary values * And much more # User-Facing Changes [see above] # 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 > 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-03-24 02:52:01 +01:00			`mod parse_patterns;`
refactor to subcrates 2021-08-10 20:51:08 +02:00			`mod parser;`
Add virtual path abstraction layer (#9245) 2023-05-23 22:48:50 +02:00			`mod parser_path;`
refactor to subcrates 2021-08-10 20:51:08 +02:00			`mod type_check;`

fix arg parse (#5754) * fix arg parse * add ut, fix clippy * simplify code * fmt code 2022-06-11 10:52:31 +02:00			`pub use deparse::{escape_for_script_arg, escape_quote_string};`
Parser refactoring for improving pipelines (#7162) * Remove lite_parse file * Add LiteElement to represent different pipeline elem types * Add PipelineElement to Pipelines * Remove lite_parse specific tests 2022-11-18 22:46:48 +01:00			`pub use flatten::{`
			`flatten_block, flatten_expression, flatten_pipeline, flatten_pipeline_element, FlatShape,`
			`};`
Add support for defining known externals with their own custom completions (#4425) * WIP for known externals * Now completions can work from scripts * Add support for definiing externs * finish cleaning up old proof-of-concept 2022-02-11 19:38:10 +01:00			`pub use known_external::KnownExternal;`
allow lists to have type annotations (#8529) this pr refines #8270 and closes #8109 # description examples: the original syntax is okay ```nu def okay [nums: list] {} # the type of list will be list<any> ``` empty annotations are allowed in any variation the last two may be caught by a future formatter, but do not affect `nu` code currently ```nu def okay [nums: list<>] {} # okay def okay [nums: list< >] {} # weird but also okay def okay [nums: list< >] {} # also weird but okay ``` types are allowed (See [notes](#notes) below) ```nu def okay [nums: list<int>] {} # `test [a b c]` will throw an error def okay [nums: list< int > {} # any amount of space within the angle brackets is okay def err [nums: list <int>] {} # this is not okay, `nums` and `<int>` will be parsed as # two separate params, ``` nested annotations are allowed in many variations ```nu def okay [items: list<list<int>>] {} def okay [items: list<list>] {} ``` any unterminated annotation is caught ```nu Error: nu::parser::unexpected_eof × Unexpected end of code. ╭─[source:1:1] 1 │ def err [nums: list<int] {} · ▲ · ╰── expected closing > ╰──── ``` unknown types are flagged ```nu Error: nu::parser::unknown_type × Unknown type. ╭─[source:1:1] 1 │ def err [nums: list<str>] {} · ─┬─ · ╰── unknown type ╰──── Error: nu::parser::unknown_type × Unknown type. ╭─[source:1:1] 1 │ def err [nums: list<int, string>] {} · ─────┬───── · ╰── unknown type ╰──── ``` # notes the error message for mismatched types in not as intuitive ```nu Error: nu::parser::parse_mismatch × Parse mismatch during operation. ╭─[source:1:1] 1 │ def err [nums: list<int>] {}; err [a b c] · ┬ · ╰── expected int ╰──── ``` it should be something like this ```nu Error: nu::parser::parse_mismatch × Parse mismatch during operation. ╭─[source:1:1] 1 │ def err [nums: list<int>] {}; err [a b c] · ──┬── · ╰── expected list<int> ╰──── ``` this is currently not implemented 2023-03-24 12:54:06 +01:00			`pub use lex::{lex, lex_signature, Token, TokenContents};`
Small parser refactors (#7568) 2022-12-22 12:41:44 +01:00			`pub use lite_parser::{lite_parse, LiteBlock, LiteElement};`
nu-cli/completions: completion for use and source (#5210) * nu-cli/completions: completion for use and source * handle subfolders for different base dirs * fix clippy errors 2022-04-18 14:59:13 +02:00			`pub use parse_keywords::*;`
Add virtual path abstraction layer (#9245) 2023-05-23 22:48:50 +02:00			`pub use parser_path::*;`
Start support for commandline args to nu itself (#851) * cmdline args wip * WIP * redirect working * Add help and examples * Only show flags in signature of more than help 2022-01-26 15:42:39 +01:00
Add support for math-like externals (#4606) 2022-02-22 16:55:28 +01:00			`pub use parser::{`
improve parsing of values with units (#9190) closes #9111 # Description this pr improves parsing of values with units (`filesizes`, `durations` and any other future values) by: 1. allowing underscores in the value part ```nu > 42kb # okay > 42_sec # okay > 1_000_000mib # okay > 69k_b # not okay, underscores not allowed in the unit ``` 2. improving error messages involving these values ```nu > sleep 40-sec # before Error: nu::parser::parse_mismatch × Parse mismatch during operation. ╭─[entry #42:1:1] 1 │ sleep 40-sec · ──┬── · ╰── expected duration with valid units ╰──── # now Error: × duration value must be a number ╭─[entry #41:1:1] 1 │ sleep 40-sec · ─┬─ · ╰── not a number ╰──── ``` 3. unifying parsing of these values. now all of these use one function # User-Facing Changes filesizes and durations can now have underscores for readability 2023-05-18 01:54:35 +02:00			`is_math_expression_like, parse, parse_block, parse_expression, parse_external_call,`
			`parse_unit_value, trim_quotes, trim_quotes_str, unescape_unquote_string, DURATION_UNIT_GROUPS,`
Add support for math-like externals (#4606) 2022-02-22 16:55:28 +01:00			`};`
plugin feature flag 2021-11-02 21:56:00 +01:00
			`#[cfg(feature = "plugin")]`
Plugin repeated (#417) * not repeated decl in file and help * implemented heashmap for repeated * sorted scope commands 2021-12-03 15:29:55 +01:00			`pub use parse_keywords::parse_register;`