JSDoc completions

internal/ast/ast.go

@@ -1060,6 +1060,32 @@ func (n *Node) QuestionDotToken() *Node {
 	panic("Unhandled case in Node.QuestionDotToken: " + n.Kind.String())
 }
 
+func (n *Node) TypeExpression() *Node {
+	switch n.Kind {
+	case KindJSDocPropertyTag, KindJSDocParameterTag:
+		return n.AsJSDocParameterOrPropertyTag().TypeExpression
+	case KindJSDocReturnTag:
+		return n.AsJSDocReturnTag().TypeExpression
+	case KindJSDocTypeTag:
+		return n.AsJSDocTypeTag().TypeExpression
+	case KindJSDocTypedefTag:
+		return n.AsJSDocTypedefTag().TypeExpression
+	case KindJSDocSatisfiesTag:
+		return n.AsJSDocSatisfiesTag().TypeExpression
+	}
+	panic("Unhandled case in Node.TypeExpression: " + n.Kind.String())
+}
+
+func (n *Node) ClassName() *Node {
+	switch n.Kind {
+	case KindJSDocAugmentsTag:
+		return n.AsJSDocAugmentsTag().ClassName
+	case KindJSDocImplementsTag:
+		return n.AsJSDocImplementsTag().ClassName
+	}
+	panic("Unhandled case in Node.ClassName: " + n.Kind.String())
+}
+
 // Determines if `n` contains `descendant` by walking up the `Parent` pointers from `descendant`. This method panics if
 // `descendant` or one of its ancestors is not parented except when that node is a `SourceFile`.
 func (n *Node) Contains(descendant *Node) bool {
@@ -2049,6 +2075,8 @@ type (
 	NamedExportsNode                = Node
 	UnionType                       = Node
 	LiteralType                     = Node
+	JSDocNode                       = Node
+	BindingPatternNode              = Node
 )
 
 type (
@@ -9535,6 +9563,10 @@ func (node *JSDocTemplateTag) Clone(f NodeFactoryCoercible) *Node {
 	return cloneNode(f.AsNodeFactory().NewJSDocTemplateTag(node.TagName, node.Constraint, node.TypeParameters, node.Comment), node.AsNode(), f.AsNodeFactory().hooks)
 }
 
+func IsJSDocTemplateTag(n *Node) bool {
+	return n.Kind == KindJSDocTemplateTag
+}
+
 // JSDocParameterOrPropertyTag
 type JSDocParameterOrPropertyTag struct {
 	JSDocTagBase
@@ -9600,6 +9632,10 @@ func (node *JSDocParameterOrPropertyTag) Clone(f NodeFactoryCoercible) *Node {
 
 func (node *JSDocParameterOrPropertyTag) Name() *EntityName { return node.name }
 
+func IsJSDocParameterTag(node *Node) bool {
+	return node.Kind == KindJSDocParameterTag
+}
+
 // JSDocReturnTag
 type JSDocReturnTag struct {
 	JSDocTagBase
@@ -9893,6 +9929,10 @@ func (node *JSDocImplementsTag) Clone(f NodeFactoryCoercible) *Node {
 	return cloneNode(f.AsNodeFactory().NewJSDocImplementsTag(node.TagName, node.ClassName, node.Comment), node.AsNode(), f.AsNodeFactory().hooks)
 }
 
+func IsJSDocImplementsTag(node *Node) bool {
+	return node.Kind == KindJSDocImplementsTag
+}
+
 // JSDocAugmentsTag
 type JSDocAugmentsTag struct {
 	JSDocTagBase

internal/checker/printer.go

@@ -369,3 +369,8 @@ func (c *Checker) formatUnionTypes(types []*Type) []*Type {
 	}
 	return result
 }
+
+func (c *Checker) TypeToTypeNode(t *Type, enclosingDeclaration *ast.Node, flags nodebuilder.Flags) *ast.TypeNode {
+	nodeBuilder := c.getNodeBuilder()
+	return nodeBuilder.TypeToTypeNode(t, enclosingDeclaration, flags, nodebuilder.InternalFlagsNone, nil)
+}

internal/format/api.go

@@ -80,7 +80,7 @@ func formatNodeLines(ctx context.Context, sourceFile *ast.SourceFile, node *ast.
 		return nil
 	}
 	tokenStart := scanner.GetTokenPosOfNode(node, sourceFile, false)
-	lineStart := getLineStartPositionForPosition(tokenStart, sourceFile)
+	lineStart := GetLineStartPositionForPosition(tokenStart, sourceFile)
 	span := core.NewTextRange(lineStart, node.End())
 	return FormatSpan(ctx, span, sourceFile, requestKind)
 }
@@ -90,7 +90,7 @@ func FormatDocument(ctx context.Context, sourceFile *ast.SourceFile) []core.Text
 }
 
 func FormatSelection(ctx context.Context, sourceFile *ast.SourceFile, start int, end int) []core.TextChange {
-	return FormatSpan(ctx, core.NewTextRange(getLineStartPositionForPosition(start, sourceFile), end), sourceFile, FormatRequestKindFormatSelection)
+	return FormatSpan(ctx, core.NewTextRange(GetLineStartPositionForPosition(start, sourceFile), end), sourceFile, FormatRequestKindFormatSelection)
 }
 
 func FormatOnOpeningCurly(ctx context.Context, sourceFile *ast.SourceFile, position int) []core.TextChange {
@@ -112,7 +112,7 @@ func FormatOnOpeningCurly(ctx context.Context, sourceFile *ast.SourceFile, posit
 	 * ```
 	 * and we wouldn't want to move the closing brace.
 	 */
-	textRange := core.NewTextRange(getLineStartPositionForPosition(scanner.GetTokenPosOfNode(outermostNode, sourceFile, false), sourceFile), position)
+	textRange := core.NewTextRange(GetLineStartPositionForPosition(scanner.GetTokenPosOfNode(outermostNode, sourceFile, false), sourceFile), position)
 	return FormatSpan(ctx, textRange, sourceFile, FormatRequestKindFormatOnOpeningCurlyBrace)
 }
 

internal/format/span.go

@@ -467,7 +467,7 @@ func (w *formatSpanWorker) processChildNodes(
 					// }: {};
 					indentationOnListStartToken = w.indentationOnLastIndentedLine
 				} else {
-					startLinePosition := getLineStartPositionForPosition(tokenInfo.token.Loc.Pos(), w.sourceFile)
+					startLinePosition := GetLineStartPositionForPosition(tokenInfo.token.Loc.Pos(), w.sourceFile)
 					indentationOnListStartToken = findFirstNonWhitespaceColumn(startLinePosition, tokenInfo.token.Loc.Pos(), w.sourceFile, w.formattingContext.Options)
 				}
 
@@ -577,7 +577,7 @@ func (w *formatSpanWorker) tryComputeIndentationForListItem(startPos int, endPos
 		}
 	} else {
 		startLine, _ := scanner.GetLineAndCharacterOfPosition(w.sourceFile, startPos)
-		startLinePosition := getLineStartPositionForPosition(startPos, w.sourceFile)
+		startLinePosition := GetLineStartPositionForPosition(startPos, w.sourceFile)
 		column := findFirstNonWhitespaceColumn(startLinePosition, startPos, w.sourceFile, w.formattingContext.Options)
 		if startLine != parentStartLine || startPos == column {
 			// Use the base indent size if it is greater than

internal/format/util.go

@@ -75,7 +75,7 @@ func getCloseTokenForOpenToken(kind ast.Kind) ast.Kind {
 	return ast.KindUnknown
 }
 
-func getLineStartPositionForPosition(position int, sourceFile *ast.SourceFile) int {
+func GetLineStartPositionForPosition(position int, sourceFile *ast.SourceFile) int {
 	lineStarts := scanner.GetLineStarts(sourceFile)
 	line, _ := scanner.GetLineAndCharacterOfPosition(sourceFile, position)
 	return int(lineStarts[line])

internal/fourslash/_scripts/failingTests.txt

@@ -65,10 +65,8 @@ TestCompletionImportModuleSpecifierEndingTsxReact
 TestCompletionImportModuleSpecifierEndingUnsupportedExtension
 TestCompletionInFunctionLikeBody_includesPrimitiveTypes
 TestCompletionInJsDoc
-TestCompletionInJsDocQualifiedNames
 TestCompletionInNamedImportLocation
 TestCompletionInUncheckedJSFile
-TestCompletionJSDocNamePath
 TestCompletionListBuilderLocations_VariableDeclarations
 TestCompletionListForDerivedType1
 TestCompletionListForTransitivelyExportedMembers04
@@ -131,9 +129,6 @@ TestCompletionsJSDocImportTagAttributesEmptyModuleSpecifier1
 TestCompletionsJSDocImportTagAttributesErrorModuleSpecifier1
 TestCompletionsJSDocImportTagEmptyModuleSpecifier1
 TestCompletionsJSDocNoCrash1
-TestCompletionsJSDocNoCrash2
-TestCompletionsJSDocNoCrash3
-TestCompletionsJsdocParamTypeBeforeName
 TestCompletionsJsdocTag
 TestCompletionsJsdocTypeTagCast
 TestCompletionsJsxAttribute2
@@ -247,7 +242,6 @@ TestJsDocFunctionSignatures12
 TestJsDocFunctionSignatures13
 TestJsDocFunctionSignatures7
 TestJsDocFunctionSignatures8
-TestJsDocFunctionTypeCompletionsNoCrash
 TestJsDocGenerics2
 TestJsDocInheritDoc
 TestJsDocPropertyDescription1
@@ -266,26 +260,15 @@ TestJsDocTagsWithHyphen
 TestJsQuickInfoGenerallyAcceptableSize
 TestJsRequireQuickInfo
 TestJsdocCallbackTag
-TestJsdocExtendsTagCompletion
-TestJsdocImplementsTagCompletion
-TestJsdocImportTagCompletion1
 TestJsdocLink2
 TestJsdocLink3
 TestJsdocLink6
 TestJsdocLink_findAllReferences1
-TestJsdocOverloadTagCompletion
-TestJsdocParameterNameCompletion
-TestJsdocPropTagCompletion
-TestJsdocPropertyTagCompletion
-TestJsdocSatisfiesTagCompletion1
-TestJsdocSatisfiesTagCompletion2
 TestJsdocTemplatePrototypeCompletions
-TestJsdocTemplateTagCompletion
 TestJsdocThrowsTagCompletion
 TestJsdocTypedefTag
 TestJsdocTypedefTag2
 TestJsdocTypedefTagNamespace
-TestJsdocTypedefTagTypeExpressionCompletion
 TestJsxFindAllReferencesOnRuntimeImportWithPaths1
 TestLetQuickInfoAndCompletionList
 TestLocalFunction

internal/fourslash/tests/basicJSDocCompletions_test.go

@@ -0,0 +1,40 @@
+package fourslash_test
+
+import (
+	"testing"
+
+	"github.com/microsoft/typescript-go/internal/fourslash"
+	. "github.com/microsoft/typescript-go/internal/fourslash/tests/util"
+	"github.com/microsoft/typescript-go/internal/lsp/lsproto"
+	"github.com/microsoft/typescript-go/internal/testutil"
+)
+
+func TestBasicJSDocCompletions(t *testing.T) {
+	t.Parallel()
+	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
+	const content = `
+/**
+ * @/*1*/
+ */
+function foo(x) {
+  return x + 1;
+}`
+	f := fourslash.NewFourslash(t, nil /*capabilities*/, content)
+	f.VerifyCompletions(t, "1", &fourslash.CompletionsExpectedList{
+		IsIncomplete: false,
+		ItemDefaults: &fourslash.CompletionsExpectedItemDefaults{
+			CommitCharacters: &DefaultCommitCharacters,
+		},
+		Items: &fourslash.CompletionsExpectedItems{
+			Includes: []fourslash.CompletionsExpectedItem{
+				&lsproto.CompletionItem{
+					Label:  "link",
+					Kind:   PtrTo(lsproto.CompletionItemKindKeyword),
+					Detail: PtrTo("link"),
+				},
+				"param",
+				"returns",
+			},
+		},
+	})
+}

internal/fourslash/tests/gen/completionInJsDocQualifiedNames_test.go

@@ -11,7 +11,7 @@ import (
 
 func TestCompletionInJsDocQualifiedNames(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @allowJs: true
 // @Filename: /node_modules/foo/index.d.ts

internal/fourslash/tests/gen/completionJSDocNamePath_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestCompletionJSDocNamePath(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @noLib: true
 /**

internal/fourslash/tests/gen/completionsJSDocNoCrash2_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestCompletionsJSDocNoCrash2(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @strict: true
 // @filename: index.ts

internal/fourslash/tests/gen/completionsJSDocNoCrash3_test.go

@@ -12,7 +12,7 @@ import (
 
 func TestCompletionsJSDocNoCrash3(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @strict: true
 // @filename: index.ts

internal/fourslash/tests/gen/completionsJsdocParamTypeBeforeName_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestCompletionsJsdocParamTypeBeforeName(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/** @param /*name1*/ {/*type*/} /*name2*/ */
 function toString(obj) {}`

internal/fourslash/tests/gen/jsDocFunctionTypeCompletionsNoCrash_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsDocFunctionTypeCompletionsNoCrash(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/**
  * @returns {function/**/(): string}

internal/fourslash/tests/gen/jsdocExtendsTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocExtendsTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/** @extends {/**/} */
 class A {}`

internal/fourslash/tests/gen/jsdocImplementsTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocImplementsTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/** @implements {/**/} */
 class A {}`

internal/fourslash/tests/gen/jsdocImportTagCompletion1_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocImportTagCompletion1(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @allowJS: true
 // @checkJs: true

internal/fourslash/tests/gen/jsdocOverloadTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocOverloadTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @allowJS: true
 // @checkJs: true

internal/fourslash/tests/gen/jsdocParameterNameCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocParameterNameCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/**
  * @param /*0*/

internal/fourslash/tests/gen/jsdocPropTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocPropTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/**
  * @typedef Foo

internal/fourslash/tests/gen/jsdocPropertyTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocPropertyTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/**
  * @typedef {Object} Foo

internal/fourslash/tests/gen/jsdocSatisfiesTagCompletion1_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocSatisfiesTagCompletion1(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @noEmit: true
 // @allowJS: true

internal/fourslash/tests/gen/jsdocSatisfiesTagCompletion2_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocSatisfiesTagCompletion2(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `// @noEmit: true
 // @allowJS: true

internal/fourslash/tests/gen/jsdocTemplateTagCompletion_test.go

@@ -10,7 +10,7 @@ import (
 
 func TestJsdocTemplateTagCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `/**
  * @template {/**/} T

internal/fourslash/tests/gen/jsdocTypedefTagTypeExpressionCompletion_test.go

@@ -12,7 +12,7 @@ import (
 
 func TestJsdocTypedefTagTypeExpressionCompletion(t *testing.T) {
 	t.Parallel()
-	t.Skip()
+
 	defer testutil.RecoverAndFail(t, "Panic on fourslash test")
 	const content = `interface I {
     age: number;