mirror of
https://github.com/nushell/nushell
synced 2025-01-15 14:44:14 +00:00
7efb31a4e4
Restructure and streamline token expansion The purpose of this commit is to streamline the token expansion code, by removing aspects of the code that are no longer relevant, removing pointless duplication, and eliminating the need to pass the same arguments to `expand_syntax`. The first big-picture change in this commit is that instead of a handful of `expand_` functions, which take a TokensIterator and ExpandContext, a smaller number of methods on the `TokensIterator` do the same job. The second big-picture change in this commit is fully eliminating the coloring traits, making coloring a responsibility of the base expansion implementations. This also means that the coloring tracer is merged into the expansion tracer, so you can follow a single expansion and see how the expansion process produced colored tokens. One side effect of this change is that the expander itself is marginally more error-correcting. The error correction works by switching from structured expansion to `BackoffColoringMode` when an unexpected token is found, which guarantees that all spans of the source are colored, but may not be the most optimal error recovery strategy. That said, because `BackoffColoringMode` only extends as far as a closing delimiter (`)`, `]`, `}`) or pipe (`|`), it does result in fairly granular correction strategy. The current code still produces an `Err` (plus a complete list of colored shapes) from the parsing process if any errors are encountered, but this could easily be addressed now that the underlying expansion is error-correcting. This commit also colors any spans that are syntax errors in red, and causes the parser to include some additional information about what tokens were expected at any given point where an error was encountered, so that completions and hinting could be more robust in the future. Co-authored-by: Jonathan Turner <jonathandturner@users.noreply.github.com> Co-authored-by: Andrés N. Robalino <andres@androbtech.com>
45 lines
1.5 KiB
Rust
45 lines
1.5 KiB
Rust
use nu_source::{b, DebugDocBuilder, PrettyDebug};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// The syntactic shapes that values must match to be passed into a command. You can think of this as the type-checking that occurs when you call a function.
|
|
#[derive(Debug, Copy, Clone, Serialize, Deserialize)]
|
|
pub enum SyntaxShape {
|
|
/// Any syntactic form is allowed
|
|
Any,
|
|
/// Strings and string-like bare words are allowed
|
|
String,
|
|
/// Values that can be the right hand side of a '.'
|
|
Member,
|
|
/// A dotted path to navigate the table
|
|
ColumnPath,
|
|
/// Only a numeric (integer or decimal) value is allowed
|
|
Number,
|
|
/// A range is allowed (eg, `1..3`)
|
|
Range,
|
|
/// Only an integer value is allowed
|
|
Int,
|
|
/// A filepath is allowed
|
|
Path,
|
|
/// A glob pattern is allowed, eg `foo*`
|
|
Pattern,
|
|
/// A block is allowed, eg `{start this thing}`
|
|
Block,
|
|
}
|
|
|
|
impl PrettyDebug for SyntaxShape {
|
|
/// Prepare SyntaxShape for pretty-printing
|
|
fn pretty(&self) -> DebugDocBuilder {
|
|
b::kind(match self {
|
|
SyntaxShape::Any => "any",
|
|
SyntaxShape::String => "string",
|
|
SyntaxShape::Member => "member",
|
|
SyntaxShape::ColumnPath => "column path",
|
|
SyntaxShape::Number => "number",
|
|
SyntaxShape::Range => "range",
|
|
SyntaxShape::Int => "integer",
|
|
SyntaxShape::Path => "file path",
|
|
SyntaxShape::Pattern => "pattern",
|
|
SyntaxShape::Block => "block",
|
|
})
|
|
}
|
|
}
|