oxc-css-parser 0.0.7

Parser for CSS, SCSS, Sass, and Less.
Documentation
//! Error management.

use crate::pos::Span;
#[cfg(feature = "serialize")]
use serde::Serialize;
use std::fmt::Display;

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serialize", derive(Serialize))]
#[cfg_attr(feature = "serialize", serde(rename_all = "camelCase"))]
pub struct Error {
    pub kind: ErrorKind,
    pub span: Span,
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "serialize", derive(Serialize))]
pub enum ErrorKind {
    Unexpected(/* expected */ &'static str, /* actual */ &'static str),
    ExpectOneOf(/* expected */ Vec<&'static str>, /* actual */ &'static str),

    UnknownToken,
    InvalidNumber,
    InvalidEscape,
    InvalidHash,
    ExpectRightBraceForLessVar,
    UnexpectedLinebreak,
    UnexpectedEof,
    UnterminatedString,

    ExpectRule,
    UnexpectedWhitespace,
    UnexpectedWhitespaceOrComments,
    ExpectSimpleSelector,
    ExpectTypeSelector,
    ExpectIdSelector,
    ExpectWqName,
    ExpectAttributeSelectorMatcher,
    ExpectAttributeSelectorValue,
    ExpectComponentValue,
    ExpectSassExpression,
    ExpectDedentOrEof,
    ExpectString,
    ExpectUrl,
    InvalidUrl,
    UnexpectedTemplateInCss,
    ExpectMediaFeatureComparison,
    ExpectMediaAnd,
    ExpectMediaOr,
    ExpectMediaNot,
    ExpectContainerConditionAnd,
    ExpectContainerConditionOr,
    ExpectContainerConditionNot,
    ExpectStyleConditionAnd,
    ExpectStyleConditionOr,
    ExpectStyleConditionNot,
    ExpectStyleQuery,
    ExpectSassKeyword(&'static str),
    InvalidAnPlusB,
    ExpectInteger,
    ExpectUnsignedInteger,
    ExpectImportantAnnotation,
    ExpectSassUseNamespace,
    InvalidUnicodeRange,
    UnexpectedSassElseAtRule,
    ExpectSassAtRootWithOrWithout,
    ExpectNthOf,
    ExpectKeyframeBlock,
    MixedDelimiterKindInLessMixin,
    ExpectLessKeyword(&'static str),
    ExpectLessExtendRule,
    ExpectScopeTo,

    TryParseError,
    CSSWideKeywordDisallowed,
    MediaTypeKeywordDisallowed(String),
    UnknownKeyframeSelectorIdent,
    InvalidRatioDenominator,
    ExpectMediaFeatureName,
    ExpectDashedIdent,
    InvalidIdSelectorName,
    ReturnOutsideFunction,
    MaxCodePointExceeded,
    UnicodeRangeStartGreaterThanEnd,
    UnexpectedNthMatcher,
    InvalidSassFlagName(String),
    UnexpectedSassFlag(&'static str),
    DuplicatedSassFlag(&'static str),
    LessGuardOnMultipleComplexSelectors,
    UnexpectedLessMixinCall,
    UnexpectedSimpleBlock,
    TopLevelDeclaration,

    // Spec parse errors that CSS Syntax recovers from at EOF / newline. The AST
    // and recovery stay conformant; these are recorded in `recoverable_errors()`
    // so downstream consumers can tell recovered-from-broken input apart from
    // valid CSS. See <https://drafts.csswg.org/css-syntax-3/>.
    /// A `{}`-block left open at end of file (§5.4.4); `UnterminatedString`
    /// (already defined) covers the EOF-terminated string (§4.3.5).
    EofInBlock,
    /// A string terminated by a newline instead of its quote — a
    /// `<bad-string-token>` (§4.3.5).
    BadString,
    /// A `(`/`[` group left open at end of file.
    UnclosedParen,
}

impl Display for ErrorKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Unexpected(expected, actual) => {
                write!(f, "expect token `{expected}`, but found `{actual}`")
            }
            Self::ExpectOneOf(expected, actual) => {
                if let [init @ .., last] = &expected[..] {
                    let joined = init
                        .iter()
                        .map(|token| format!("`{token}`"))
                        .collect::<Vec<_>>()
                        .join(", ");
                    write!(f, "expect one of {joined} or `{last}`, but found `{actual}`",)
                } else {
                    panic!("the number of expected tokens must be at least 2")
                }
            }

            Self::UnknownToken => write!(f, "unknown token"),
            Self::InvalidNumber => write!(f, "invalid number"),
            Self::InvalidEscape => write!(f, "invalid escape"),
            Self::InvalidHash => write!(f, "invalid hash token"),
            Self::ExpectRightBraceForLessVar => write!(f, "`}}` for Less variable is expected"),
            Self::UnexpectedLinebreak => write!(f, "unexpected linebreak"),
            Self::UnexpectedEof => write!(f, "unexpected end of file"),
            Self::UnterminatedString => write!(f, "unterminated string"),

            Self::ExpectRule => write!(f, "CSS rule is expected"),
            Self::UnexpectedWhitespace => write!(f, "unexpected whitespace"),
            Self::UnexpectedWhitespaceOrComments => write!(f, "unexpected whitespace or comments"),
            Self::ExpectSimpleSelector => write!(f, "simple selector is expected"),
            Self::ExpectTypeSelector => write!(f, "type selector is expected"),
            Self::ExpectIdSelector => write!(f, "ID selector is expected"),
            Self::ExpectWqName => write!(f, "WqName is expected"),
            Self::ExpectAttributeSelectorMatcher => {
                write!(f, "attribute selector matcher is expected")
            }
            Self::ExpectAttributeSelectorValue => write!(f, "attribute selector value is expected"),
            Self::ExpectComponentValue => write!(f, "component value is expected"),
            Self::ExpectSassExpression => write!(f, "Sass expression is expected"),
            Self::ExpectDedentOrEof => write!(f, "dedentation or end of file is expected"),
            Self::ExpectString => write!(f, "string is expected"),
            Self::ExpectUrl => write!(f, "URL is expected"),
            Self::InvalidUrl => write!(f, "invalid URL"),
            Self::UnexpectedTemplateInCss => write!(f, "template isn't allowed in CSS"),
            Self::ExpectMediaFeatureComparison => write!(f, "media feature comparison is expected"),
            Self::ExpectMediaAnd => write!(f, "media query `and` is expected"),
            Self::ExpectMediaOr => write!(f, "media query `or` is expected"),
            Self::ExpectMediaNot => write!(f, "media query `not` is expected"),
            Self::ExpectContainerConditionAnd => write!(f, "container condition `and` is expected"),
            Self::ExpectContainerConditionOr => write!(f, "container condition `or` is expected"),
            Self::ExpectContainerConditionNot => write!(f, "container condition `not` is expected"),
            Self::ExpectStyleConditionAnd => write!(f, "style condition `and` is expected"),
            Self::ExpectStyleConditionOr => write!(f, "style condition `or` is expected"),
            Self::ExpectStyleConditionNot => write!(f, "style condition `not` is expected"),
            Self::ExpectStyleQuery => write!(f, "style query is expected"),
            Self::ExpectSassKeyword(keyword) => write!(f, "Sass keyword `{keyword}` is expected"),
            Self::InvalidAnPlusB => write!(f, "invalid An+B syntax"),
            Self::ExpectInteger => write!(f, "an integer is expected"),
            Self::ExpectUnsignedInteger => write!(f, "unsigned integer is expected"),
            Self::ExpectImportantAnnotation => write!(f, "`!important` is expected"),
            Self::ExpectSassUseNamespace => {
                write!(f, "`*` or ident for Sass namespace is expected")
            }
            Self::InvalidUnicodeRange => write!(f, "invalid unicode range"),
            Self::UnexpectedSassElseAtRule => write!(f, "Sass `@else` at-rule is disallowed here"),
            Self::ExpectSassAtRootWithOrWithout => {
                write!(f, "Sass identifier `with` or `without` is expected")
            }
            Self::ExpectNthOf => write!(f, "`of` is expected"),
            Self::ExpectKeyframeBlock => write!(f, "keyframe block is expected"),
            Self::MixedDelimiterKindInLessMixin => write!(
                f,
                "using both `;` and `,` as delimiters in the same Less mixin is disallowed"
            ),
            Self::ExpectLessKeyword(keyword) => write!(f, "Less keyword `{keyword}` is expected"),
            Self::ExpectLessExtendRule => write!(f, "Less extend rule is expected"),
            Self::ExpectScopeTo => write!(f, "keyword `to` of `@scope` at-rule is expected"),

            Self::TryParseError => unreachable!(),
            Self::CSSWideKeywordDisallowed => {
                write!(f, "using CSS wide keyword as identifier is disallowed")
            }
            Self::MediaTypeKeywordDisallowed(keyword) => {
                write!(f, "keyword `{keyword}` as media type is disallowed")
            }
            Self::UnknownKeyframeSelectorIdent => write!(f, "unknown keyframe selector"),
            Self::InvalidRatioDenominator => write!(f, "ratio denominator is invalid"),
            Self::ExpectMediaFeatureName => write!(f, "media feature name is expected"),
            Self::ExpectDashedIdent => write!(f, "dashed identifier is expected"),
            Self::InvalidIdSelectorName => write!(f, "invalid ID selector name"),
            Self::ReturnOutsideFunction => write!(f, "`@return` is disallowed outside function"),
            Self::MaxCodePointExceeded => {
                write!(f, "unicode range end value exceeds max allowed code point")
            }
            Self::UnicodeRangeStartGreaterThanEnd => {
                write!(f, "unicode range start value can't greater than end value")
            }
            Self::UnexpectedNthMatcher => {
                write!(f, "elements matcher is allowed in `:nth-child` and `:nth-last-child` only")
            }
            Self::InvalidSassFlagName(flag) => write!(f, "invalid Sass flag name `{flag}`"),
            Self::UnexpectedSassFlag(flag) => write!(f, "Sass flag `!{flag}` is disallowed"),
            Self::DuplicatedSassFlag(flag) => write!(f, "duplicated Sass flag `!{flag}`"),
            Self::LessGuardOnMultipleComplexSelectors => {
                write!(f, "Less guards are only allowed on a single complex selector")
            }
            Self::UnexpectedLessMixinCall => write!(f, "Less mixin call is disallowed"),
            Self::UnexpectedSimpleBlock => write!(f, "simple block is disallowed"),
            Self::TopLevelDeclaration => write!(f, "declaration at top level is disallowed"),

            Self::EofInBlock => write!(f, "unclosed block before end of file"),
            Self::BadString => write!(f, "unterminated string before line break"),
            Self::UnclosedParen => write!(f, "unclosed parenthesis before end of file"),
        }
    }
}

pub type PResult<T> = Result<T, Error>;