fix(ast/estree): Fix BindingProperty (#10193)

therewillbecode · overlookmotel · web-flow · commit 760188e680cd · 2025-04-03T12:08:31.000+01:00
Adds the `optional` field to the Estree serialiser for the `BindingProperty` node. Part of our broader work to align our AST's ESTree output with that of TS-ESLint's. Relates to #9705 --------- Co-authored-by: overlookmotel <theoverlookmotel@gmail.com>
diff --git a/crates/oxc_ast/src/ast/js.rs b/crates/oxc_ast/src/ast/js.rs
@@ -1583,8 +1583,8 @@ pub struct ObjectPattern<'a> {
 #[generate_derive(CloneIn, Dummy, TakeIn, GetSpan, GetSpanMut, ContentEq, ESTree)]
 #[estree(
     rename = "Property",
-    add_fields(method = False, kind = Init),
-    field_order(span, method, shorthand, computed, key, value, kind),
+    add_fields(method = False, kind = Init, optional = TsFalse),
+    field_order(span, method, shorthand, computed, key, value, kind, optional),
 )]
 pub struct BindingProperty<'a> {
     pub span: Span,
diff --git a/crates/oxc_ast/src/generated/derive_estree.rs b/crates/oxc_ast/src/generated/derive_estree.rs
@@ -1302,6 +1302,7 @@ impl ESTree for BindingProperty<'_> {
         state.serialize_field("key", &self.key);
         state.serialize_field("value", &self.value);
         state.serialize_field("kind", &crate::serialize::Init(self));
+        state.serialize_ts_field("optional", &crate::serialize::TsFalse(self));
         state.end();
     }
 }
diff --git a/napi/parser/deserialize-ts.js b/napi/parser/deserialize-ts.js
@@ -757,6 +757,7 @@ function deserializeBindingProperty(pos) {
     key: deserializePropertyKey(pos + 8),
     value: deserializeBindingPattern(pos + 24),
     kind: 'init',
+    optional: false,
   };
 }
 
diff --git a/npm/oxc-types/types.d.ts b/npm/oxc-types/types.d.ts
@@ -534,6 +534,7 @@ export interface BindingProperty extends Span {
   key: PropertyKey;
   value: BindingPattern;
   kind: 'init';
+  optional?: false;
 }
 
 export interface ArrayPattern extends Span {
diff --git a/tasks/coverage/snapshots/estree_typescript.snap b/tasks/coverage/snapshots/estree_typescript.snap

Original file line number	Diff line number	Diff line change
`@@ -1302,6 +1302,7 @@ impl ESTree for BindingProperty<'_> {`
`1302`	`1302`	`state.serialize_field("key", &self.key);`
`1303`	`1303`	`state.serialize_field("value", &self.value);`
`1304`	`1304`	`state.serialize_field("kind", &crate::serialize::Init(self));`
	`1305`	`+ state.serialize_ts_field("optional", &crate::serialize::TsFalse(self));`
`1305`	`1306`	`state.end();`
`1306`	`1307`	`}`
`1307`	`1308`	`}`
Original file line number	Diff line number	Diff line change
`@@ -757,6 +757,7 @@ function deserializeBindingProperty(pos) {`
`757`	`757`	`key: deserializePropertyKey(pos + 8),`
`758`	`758`	`value: deserializeBindingPattern(pos + 24),`
`759`	`759`	`kind: 'init',`
	`760`	`+ optional: false,`
`760`	`761`	`};`
`761`	`762`	`}`
`762`	`763`
Original file line number	Diff line number	Diff line change
`@@ -534,6 +534,7 @@ export interface BindingProperty extends Span {`
`534`	`534`	`key: PropertyKey;`
`535`	`535`	`value: BindingPattern;`
`536`	`536`	`kind: 'init';`
	`537`	`+ optional?: false;`
`537`	`538`	`}`
`538`	`539`
`539`	`540`	`export interface ArrayPattern extends Span {`