Skip to content

fix(ast/estree): make TS-only fields optional in TS type defs #9846

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
Mar 18, 2025
Merged

fix(ast/estree): make TS-only fields optional in TS type defs #9846

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
92 changes: 46 additions & 46 deletions npm/oxc-types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export interface TaggedTemplateExpression extends Span {
type: 'TaggedTemplateExpression';
tag: Expression;
quasi: TemplateLiteral;
typeArguments: TSTypeParameterInstantiation | null;
typeArguments?: TSTypeParameterInstantiation | null;
}

export interface TemplateElement extends Span {
Expand Down Expand Up @@ -158,14 +158,14 @@ export interface CallExpression extends Span {
callee: Expression;
arguments: Array<Argument>;
optional: boolean;
typeArguments: TSTypeParameterInstantiation | null;
typeArguments?: TSTypeParameterInstantiation | null;
}

export interface NewExpression extends Span {
type: 'NewExpression';
callee: Expression;
arguments: Array<Argument>;
typeArguments: TSTypeParameterInstantiation | null;
typeArguments?: TSTypeParameterInstantiation | null;
}

export interface MetaProperty extends Span {
Expand Down Expand Up @@ -365,7 +365,7 @@ export interface VariableDeclaration extends Span {
type: 'VariableDeclaration';
declarations: Array<VariableDeclarator>;
kind: VariableDeclarationKind;
declare: boolean;
declare?: boolean;
}

export type VariableDeclarationKind = 'var' | 'let' | 'const' | 'using' | 'await using';
Expand All @@ -374,7 +374,7 @@ export interface VariableDeclarator extends Span {
type: 'VariableDeclarator';
id: BindingPattern;
init: Expression | null;
definite: boolean;
definite?: boolean;
}

export interface EmptyStatement extends Span {
Expand All @@ -384,7 +384,7 @@ export interface EmptyStatement extends Span {
export interface ExpressionStatement extends Span {
type: 'ExpressionStatement';
expression: Expression;
directive: string | null;
directive?: string | null;
}

export interface IfStatement extends Span {
Expand Down Expand Up @@ -496,8 +496,8 @@ export interface DebuggerStatement extends Span {

export type BindingPattern =
& ({
typeAnnotation: TSTypeAnnotation | null;
optional: boolean;
typeAnnotation?: TSTypeAnnotation | null;
optional?: boolean;
})
& (BindingIdentifier | ObjectPattern | ArrayPattern | AssignmentPattern);

Expand Down Expand Up @@ -542,10 +542,10 @@ export interface Function extends Span {
async: boolean;
params: ParamPattern[];
body: FunctionBody | null;
declare: boolean;
typeParameters: TSTypeParameterDeclaration | null;
thisParam: TSThisParameter | null;
returnType: TSTypeAnnotation | null;
declare?: boolean;
typeParameters?: TSTypeParameterDeclaration | null;
thisParam?: TSThisParameter | null;
returnType?: TSTypeAnnotation | null;
}

export type ParamPattern = FormalParameter | FormalParameterRest;
Expand All @@ -565,10 +565,10 @@ export interface FormalParameterRest extends Span {

export type FormalParameter =
& ({
decorators: Array<Decorator>;
accessibility: TSAccessibility | null;
readonly: boolean;
override: boolean;
decorators?: Array<Decorator>;
accessibility?: TSAccessibility | null;
readonly?: boolean;
override?: boolean;
})
& BindingPattern;

Expand All @@ -585,8 +585,8 @@ export interface ArrowFunctionExpression extends Span {
async: boolean;
params: ParamPattern[];
body: FunctionBody | Expression;
typeParameters: TSTypeParameterDeclaration | null;
returnType: TSTypeAnnotation | null;
typeParameters?: TSTypeParameterDeclaration | null;
returnType?: TSTypeAnnotation | null;
}

export interface YieldExpression extends Span {
Expand All @@ -600,12 +600,12 @@ export interface Class extends Span {
id: BindingIdentifier | null;
superClass: Expression | null;
body: ClassBody;
decorators: Array<Decorator>;
typeParameters: TSTypeParameterDeclaration | null;
superTypeArguments: TSTypeParameterInstantiation | null;
implements: Array<TSClassImplements>;
abstract: boolean;
declare: boolean;
decorators?: Array<Decorator>;
typeParameters?: TSTypeParameterDeclaration | null;
superTypeArguments?: TSTypeParameterInstantiation | null;
implements?: Array<TSClassImplements>;
abstract?: boolean;
declare?: boolean;
}

export type ClassType = 'ClassDeclaration' | 'ClassExpression';
Expand All @@ -624,10 +624,10 @@ export interface MethodDefinition extends Span {
key: PropertyKey;
kind: MethodDefinitionKind;
value: Function;
decorators: Array<Decorator>;
override: boolean;
optional: boolean;
accessibility: TSAccessibility | null;
decorators?: Array<Decorator>;
override?: boolean;
optional?: boolean;
accessibility?: TSAccessibility | null;
}

export type MethodDefinitionType = 'MethodDefinition' | 'TSAbstractMethodDefinition';
Expand All @@ -638,14 +638,14 @@ export interface PropertyDefinition extends Span {
computed: boolean;
key: PropertyKey;
value: Expression | null;
decorators: Array<Decorator>;
declare: boolean;
override: boolean;
optional: boolean;
definite: boolean;
readonly: boolean;
typeAnnotation: TSTypeAnnotation | null;
accessibility: TSAccessibility | null;
decorators?: Array<Decorator>;
declare?: boolean;
override?: boolean;
optional?: boolean;
definite?: boolean;
readonly?: boolean;
typeAnnotation?: TSTypeAnnotation | null;
accessibility?: TSAccessibility | null;
}

export type PropertyDefinitionType = 'PropertyDefinition' | 'TSAbstractPropertyDefinition';
Expand Down Expand Up @@ -678,10 +678,10 @@ export interface AccessorProperty extends Span {
value: Expression | null;
computed: boolean;
static: boolean;
decorators: Array<Decorator>;
definite: boolean;
typeAnnotation: TSTypeAnnotation | null;
accessibility: TSAccessibility | null;
decorators?: Array<Decorator>;
definite?: boolean;
typeAnnotation?: TSTypeAnnotation | null;
accessibility?: TSAccessibility | null;
}

export interface ImportExpression extends Span {
Expand All @@ -695,7 +695,7 @@ export interface ImportDeclaration extends Span {
specifiers: Array<ImportDeclarationSpecifier>;
source: StringLiteral;
attributes: Array<ImportAttribute>;
importKind: ImportOrExportKind;
importKind?: ImportOrExportKind;
}

export type ImportPhase = 'source' | 'defer';
Expand All @@ -706,7 +706,7 @@ export interface ImportSpecifier extends Span {
type: 'ImportSpecifier';
imported: ModuleExportName;
local: BindingIdentifier;
importKind: ImportOrExportKind;
importKind?: ImportOrExportKind;
}

export interface ImportDefaultSpecifier extends Span {
Expand All @@ -733,7 +733,7 @@ export interface ExportNamedDeclaration extends Span {
specifiers: Array<ExportSpecifier>;
source: StringLiteral | null;
attributes: Array<ImportAttribute>;
exportKind: ImportOrExportKind;
exportKind?: ImportOrExportKind;
}

export interface ExportDefaultDeclaration extends Span {
Expand All @@ -746,14 +746,14 @@ export interface ExportAllDeclaration extends Span {
exported: ModuleExportName | null;
source: StringLiteral;
attributes: Array<ImportAttribute>;
exportKind: ImportOrExportKind;
exportKind?: ImportOrExportKind;
}

export interface ExportSpecifier extends Span {
type: 'ExportSpecifier';
local: ModuleExportName;
exported: ModuleExportName;
exportKind: ImportOrExportKind;
exportKind?: ImportOrExportKind;
}

export type ExportDefaultDeclarationKind = Function | Class | TSInterfaceDeclaration | Expression;
Expand Down Expand Up @@ -821,7 +821,7 @@ export interface JSXOpeningElement extends Span {
attributes: Array<JSXAttributeItem>;
name: JSXElementName;
selfClosing: boolean;
typeArguments: TSTypeParameterInstantiation | null;
typeArguments?: TSTypeParameterInstantiation | null;
}

export interface JSXClosingElement extends Span {
Expand Down
9 changes: 6 additions & 3 deletions tasks/ast_tools/src/generators/typescript.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,8 @@ fn generate_ts_type_def_for_struct_field_impl<'s>(
}

let field_camel_name = get_struct_field_name(field);
fields_str.push_str(&format!("\n\t{field_camel_name}: {field_type_name};"));
let question_mark = if field.estree.is_ts { "?" } else { "" };
fields_str.push_str(&format!("\n\t{field_camel_name}{question_mark}: {field_type_name};"));
}

/// Generate Typescript type definition for an extra struct field
Expand All @@ -281,10 +282,12 @@ fn generate_ts_type_def_for_added_struct_field(
fields_str: &mut String,
schema: &Schema,
) {
let Some(ts_type) = get_ts_type_for_converter(converter_name, schema) else {
let converter = schema.meta_by_name(converter_name);
let Some(ts_type) = converter.estree.ts_type.as_deref() else {
panic!("No `ts_type` provided for ESTree converter `{converter_name}`");
};
fields_str.push_str(&format!("\n\t{field_name}: {ts_type};"));
let question_mark = if converter.estree.is_ts { "?" } else { "" };
fields_str.push_str(&format!("\n\t{field_name}{question_mark}: {ts_type};"));
}

/// Get the TS type definition for a converter.
Expand Down
Loading