Skip to content

Add precedence and printing for JSDoc types #782

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
merged 1 commit into from
Apr 9, 2025
Merged

Add precedence and printing for JSDoc types #782

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
11 changes: 11 additions & 0 deletions internal/ast/precedence.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,12 @@ const (
//
TypePrecedenceConditional TypePrecedence = iota

// JSDoc precedence (optional and variadic types)
//
// JSDocType:
// `...`? Type `=`?
TypePrecedenceJSDoc

// Function precedence
//
// Type[Extends]:
Expand Down Expand Up @@ -651,6 +657,8 @@ func GetTypeNodePrecedence(n *TypeNode) TypePrecedence {
switch n.Kind {
case KindConditionalType:
return TypePrecedenceConditional
case KindJSDocOptionalType, KindJSDocVariadicType:
Copy link

Copilot AI Apr 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The precedence grouping for JSDoc types appears inconsistent: some types use TypePrecedenceJSDoc while others fall into a different group. Review if all JSDoc types should share the same precedence level or if the differences are intentional and add clarifying comments.

Suggested change
case KindJSDocOptionalType, KindJSDocVariadicType:
case KindJSDocOptionalType, KindJSDocVariadicType,
KindJSDocAllType, KindJSDocNullableType, KindJSDocNonNullableType:
// All JSDoc-related types are grouped under TypePrecedenceJSDoc for consistency.

Copilot uses AI. Check for mistakes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only Optional and Variadic are special-cased in parsing. The others are parsed just like any, unknown, etc. This is intentional.

return TypePrecedenceJSDoc
case KindFunctionType, KindConstructorType:
return TypePrecedenceFunction
case KindUnionType:
Expand Down Expand Up @@ -684,6 +692,9 @@ func GetTypeNodePrecedence(n *TypeNode) TypePrecedence {
KindObjectKeyword,
KindIntrinsicKeyword,
KindVoidKeyword,
KindJSDocAllType,
KindJSDocNullableType,
KindJSDocNonNullableType,
KindLiteralType,
KindTypePredicate,
KindTypeReference,
Expand Down
49 changes: 42 additions & 7 deletions internal/printer/printer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2258,13 +2258,16 @@ func (p *Printer) emitTypeNode(node *ast.TypeNode, precedence ast.TypePrecedence
// !!! Should this actually be considered a type?
p.emitExpressionWithTypeArguments(node.AsExpressionWithTypeArguments())

case ast.KindJSDocAllType,
ast.KindJSDocNullableType,
ast.KindJSDocNonNullableType,
ast.KindJSDocOptionalType,
ast.KindJSDocVariadicType:
// TODO
panic("not implemented")
case ast.KindJSDocAllType:
p.emitJSDocAllType(node)
case ast.KindJSDocNonNullableType:
p.emitJSDocNonNullableType(node.AsJSDocNonNullableType())
case ast.KindJSDocNullableType:
p.emitJSDocNullableType(node.AsJSDocNullableType())
case ast.KindJSDocOptionalType:
p.emitJSDocOptionalType(node.AsJSDocOptionalType())
case ast.KindJSDocVariadicType:
p.emitJSDocVariadicType(node.AsJSDocVariadicType())

default:
panic(fmt.Sprintf("unhandled TypeNode: %v", node.Kind))
Expand Down Expand Up @@ -2317,6 +2320,38 @@ func (p *Printer) emitBindingElementNode(node *ast.BindingElementNode) {
p.emitBindingElement(node.AsBindingElement())
}

func (p *Printer) emitJSDocAllType(node *ast.Node) {
p.emitKeywordNode(node)
}

func (p *Printer) emitJSDocNonNullableType(node *ast.JSDocNonNullableType) {
state := p.enterNode(node.AsNode())
p.writePunctuation("!")
p.emitTypeNode(node.Type, ast.TypePrecedenceNonArray)
p.exitNode(node.AsNode(), state)
}

func (p *Printer) emitJSDocNullableType(node *ast.JSDocNullableType) {
state := p.enterNode(node.AsNode())
p.writePunctuation("?")
p.emitTypeNode(node.Type, ast.TypePrecedenceNonArray)
p.exitNode(node.AsNode(), state)
}

func (p *Printer) emitJSDocOptionalType(node *ast.JSDocOptionalType) {
state := p.enterNode(node.AsNode())
p.emitTypeNode(node.Type, ast.TypePrecedenceJSDoc)
p.writePunctuation("=")
p.exitNode(node.AsNode(), state)
}

func (p *Printer) emitJSDocVariadicType(node *ast.JSDocVariadicType) {
state := p.enterNode(node.AsNode())
p.writePunctuation("...")
p.emitTypeNode(node.Type, ast.TypePrecedenceJSDoc)
p.exitNode(node.AsNode(), state)
}

//
// Expressions
//
Expand Down