Skip to content

refactor(ast): simplify serializing literal types #8937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Feb 7, 2025
Merged

refactor(ast): simplify serializing literal types #8937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 30 additions & 32 deletions crates/oxc_ast/src/ast/literal.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ use oxc_syntax::number::{BigintBase, NumberBase};
#[ast(visit)]
#[derive(Debug, Clone)]
#[generate_derive(CloneIn, GetSpan, GetSpanMut, ContentEq, ESTree)]
#[estree(rename = "Literal", via = crate::serialize::ESTreeLiteral, add_ts = "raw: string | null")]
#[estree(
rename = "Literal",
add_fields(raw = crate::serialize::boolean_literal_raw(self)),
add_ts = "raw: string | null",
)]
pub struct BooleanLiteral {
/// Node location in source code
pub span: Span,
Expand All @@ -34,7 +38,14 @@ pub struct BooleanLiteral {
#[ast(visit)]
#[derive(Debug, Clone)]
#[generate_derive(CloneIn, GetSpan, GetSpanMut, ContentEq, ESTree)]
#[estree(rename = "Literal", via = crate::serialize::ESTreeLiteral, add_ts = "value: null, raw: \"null\" | null")]
#[estree(
rename = "Literal",
add_fields(
value = (),
raw = crate::serialize::null_literal_raw(self),
),
add_ts = "value: null, raw: \"null\" | null",
)]
pub struct NullLiteral {
/// Node location in source code
pub span: Span,
Expand All @@ -46,7 +57,7 @@ pub struct NullLiteral {
#[ast(visit)]
#[derive(Debug, Clone)]
#[generate_derive(CloneIn, ContentEq, GetSpan, GetSpanMut, ESTree)]
#[estree(rename = "Literal", via = crate::serialize::ESTreeLiteral)]
#[estree(rename = "Literal")]
pub struct NumericLiteral<'a> {
/// Node location in source code
pub span: Span,
Expand All @@ -69,7 +80,7 @@ pub struct NumericLiteral<'a> {
#[ast(visit)]
#[derive(Debug, Clone)]
#[generate_derive(CloneIn, ContentEq, GetSpan, GetSpanMut, ESTree)]
#[estree(rename = "Literal", via = crate::serialize::ESTreeLiteral)]
#[estree(rename = "Literal")]
pub struct StringLiteral<'a> {
/// Node location in source code
pub span: Span,
Expand All @@ -89,7 +100,14 @@ pub struct StringLiteral<'a> {
#[ast(visit)]
#[derive(Debug, Clone)]
#[generate_derive(CloneIn, ContentEq, GetSpan, GetSpanMut, ESTree)]
#[estree(rename = "Literal", via = crate::serialize::ESTreeLiteral, add_ts = "value: null, bigint: string")]
#[estree(
rename = "Literal",
add_fields(
value = (),
bigint = crate::serialize::bigint_literal_bigint(self),
),
add_ts = "value: null, bigint: string",
)]
pub struct BigIntLiteral<'a> {
/// Node location in source code
pub span: Span,
Expand All @@ -109,16 +127,15 @@ pub struct BigIntLiteral<'a> {
#[derive(Debug)]
#[generate_derive(CloneIn, ContentEq, GetSpan, GetSpanMut, ESTree)]
#[estree(
rename = "Literal",
via = crate::serialize::ESTreeLiteral,
add_ts = "value: {} | null, regex: { pattern: string, flags: string }"
rename = "Literal",
add_fields(value = crate::serialize::EmptyObject),
add_ts = "value: {} | null",
)]
pub struct RegExpLiteral<'a> {
/// Node location in source code
pub span: Span,
/// The parsed regular expression. See [`oxc_regular_expression`] for more
/// details.
#[estree(skip)]
pub regex: RegExp<'a>,
/// The regular expression as it appears in source code
///
Expand All @@ -136,8 +153,10 @@ pub struct RegExpLiteral<'a> {
#[estree(no_type)]
pub struct RegExp<'a> {
/// The regex pattern between the slashes
#[estree(ts_type = "string")]
pub pattern: RegExpPattern<'a>,
/// Regex flags after the closing slash
#[estree(ts_type = "string")]
pub flags: RegExpFlags,
}

Expand All @@ -147,6 +166,7 @@ pub struct RegExp<'a> {
#[ast]
#[derive(Debug)]
#[generate_derive(CloneIn, ESTree)]
#[estree(custom_serialize, no_ts_def)]
pub enum RegExpPattern<'a> {
/// Unparsed pattern. Contains string slice of the pattern.
/// Pattern was not parsed, so may be valid or invalid.
Expand Down Expand Up @@ -204,28 +224,6 @@ bitflags! {
/// Dummy type to communicate the content of `RegExpFlags` to `oxc_ast_tools`.
#[ast(foreign = RegExpFlags)]
#[generate_derive(ESTree)]
#[estree(
custom_serialize,
custom_ts_def = "
type RegExpFlags = {
/** Global flag */
G: 1;
/** Ignore case flag */
I: 2;
/** Multiline flag */
M: 4;
/** DotAll flag */
S: 8;
/** Unicode flag */
U: 16;
/** Sticky flag */
Y: 32;
/** Indices flag */
D: 64;
/** Unicode sets flag */
V: 128;
}
"
)]
#[estree(custom_serialize, no_ts_def)]
#[expect(dead_code)]
struct RegExpFlagsAlias(u8);
60 changes: 44 additions & 16 deletions crates/oxc_ast/src/generated/derive_estree.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1886,37 +1886,75 @@ impl Serialize for ModuleExportName<'_> {

impl Serialize for BooleanLiteral {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("value", &self.value)?;
map.serialize_entry("raw", &crate::serialize::boolean_literal_raw(self))?;
map.end()
}
}

impl Serialize for NullLiteral {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("value", &())?;
map.serialize_entry("raw", &crate::serialize::null_literal_raw(self))?;
map.end()
}
}

impl Serialize for NumericLiteral<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("value", &self.value)?;
map.serialize_entry("raw", &self.raw)?;
map.end()
}
}

impl Serialize for StringLiteral<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("value", &self.value)?;
map.serialize_entry("raw", &self.raw)?;
map.end()
}
}

impl Serialize for BigIntLiteral<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("raw", &self.raw)?;
map.serialize_entry("value", &())?;
map.serialize_entry("bigint", &crate::serialize::bigint_literal_bigint(self))?;
map.end()
}
}

impl Serialize for RegExpLiteral<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
crate::serialize::ESTreeLiteral::from(self).serialize(serializer)
let mut map = serializer.serialize_map(None)?;
map.serialize_entry("type", "Literal")?;
map.serialize_entry("start", &self.span.start)?;
map.serialize_entry("end", &self.span.end)?;
map.serialize_entry("regex", &self.regex)?;
map.serialize_entry("raw", &self.raw)?;
map.serialize_entry("value", &crate::serialize::EmptyObject)?;
map.end()
}
}

Expand All @@ -1929,16 +1967,6 @@ impl Serialize for RegExp<'_> {
}
}

impl Serialize for RegExpPattern<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
match self {
RegExpPattern::Raw(it) => it.serialize(serializer),
RegExpPattern::Invalid(it) => it.serialize(serializer),
RegExpPattern::Pattern(it) => it.serialize(serializer),
}
}
}

impl Serialize for JSXElement<'_> {
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut map = serializer.serialize_map(None)?;
Expand Down
Loading
Loading