Merge branch 'main' of https://github.com/microsoft/typescript-go into feat/completion-snippets

Author: a-tarasyuk

internal/ls/hover.go

@@ -190,7 +190,7 @@ func (l *LanguageService) getDocumentationFromDeclaration(c *checker.Checker, sy
 					}
 					comments := tag.Comments()
 					if tag.Kind == ast.KindJSDocUnknownTag && tag.TagName().Text() == "example" {
-						commentText := strings.TrimRight(getCommentText(comments), " \t\r\n")
+						commentText := scanner.GetTextOfJSDocComment(tag.CommentList())
 						if strings.HasPrefix(commentText, "<caption>") {
 							if captionEnd := strings.Index(commentText, "</caption>"); captionEnd > 0 {
 								b.WriteString(" — ")
@@ -242,19 +242,6 @@ func (l *LanguageService) getDocumentationFromDeclaration(c *checker.Checker, sy
 	return b.String()
 }
 
-func getCommentText(comments []*ast.Node) string {
-	var b strings.Builder
-	for _, comment := range comments {
-		switch comment.Kind {
-		case ast.KindJSDocText:
-			b.WriteString(comment.Text())
-		case ast.KindJSDocLink, ast.KindJSDocLinkCode, ast.KindJSDocLinkPlain:
-			b.WriteString(scanner.GetTextOfNode(comment))
-		}
-	}
-	return b.String()
-}
-
 func formatQuickInfo(quickInfo string) string {
 	var b strings.Builder
 	b.Grow(32)

internal/scanner/utilities.go

@@ -2,6 +2,7 @@ package scanner
 
 import (
 	"strings"
+	"unicode"
 	"unicode/utf8"
 
 	"github.com/microsoft/typescript-go/internal/ast"
@@ -81,6 +82,22 @@ func GetTextOfNode(node *ast.Node) string {
 	return GetSourceTextOfNodeFromSourceFile(ast.GetSourceFileOfNode(node), node, false /*includeTrivia*/)
 }
 
+func GetTextOfJSDocComment(comment *ast.NodeList) string {
+	if comment == nil {
+		return ""
+	}
+	var b strings.Builder
+	for _, n := range comment.Nodes {
+		switch n.Kind {
+		case ast.KindJSDocText:
+			b.WriteString(n.Text())
+		case ast.KindJSDocLink, ast.KindJSDocLinkCode, ast.KindJSDocLinkPlain:
+			b.WriteString(GetTextOfNode(n))
+		}
+	}
+	return strings.TrimRightFunc(b.String(), unicode.IsSpace)
+}
+
 func DeclarationNameToString(name *ast.Node) string {
 	if name == nil || name.Pos() == name.End() {
 		return "(Missing)"

internal/transformers/declarations/transform.go

@@ -864,14 +864,16 @@ func (tx *DeclarationTransformer) transformPropertySignatureDeclaration(input *a
 	if ast.IsPrivateIdentifier(input.Name()) {
 		return nil
 	}
-	return tx.Factory().UpdatePropertySignatureDeclaration(
+	result := tx.Factory().UpdatePropertySignatureDeclaration(
 		input,
 		tx.ensureModifiers(input.AsNode()),
 		input.Name(),
 		input.PostfixToken,
 		tx.ensureType(input.AsNode(), false),
 		tx.ensureNoInitializer(input.AsNode()), // TODO: possible strada bug (fixed here) - const property signatures never initialized
 	)
+	tx.preservePartialJsDoc(result, input.AsNode())
+	return result
 }
 
 func (tx *DeclarationTransformer) transformPropertyDeclaration(input *ast.PropertyDeclaration) *ast.Node {
@@ -1226,6 +1228,22 @@ func (tx *DeclarationTransformer) preserveJsDoc(updated *ast.Node, original *ast
 	tx.EmitContext().AssignCommentRange(updated, original)
 }
 
+func (tx *DeclarationTransformer) preservePartialJsDoc(updated *ast.Node, original *ast.Node) {
+	if original.Flags&ast.NodeFlagsReparsed == 0 {
+		return
+	}
+	jsdoc := core.FirstOrNil(original.EagerJSDoc(ast.GetSourceFileOfNode(original)))
+	if jsdoc == nil {
+		return
+	}
+	description := scanner.GetTextOfJSDocComment(jsdoc.AsJSDoc().Comment)
+	if description == "" {
+		return
+	}
+	comment := "*\n * " + strings.ReplaceAll(description, "\n", "\n * ") + "\n "
+	tx.EmitContext().AddSyntheticLeadingComment(updated, ast.KindMultiLineCommentTrivia, comment, true /*hasTrailingNewLine*/)
+}
+
 func (tx *DeclarationTransformer) removeAllComments(node *ast.Node) {
 	tx.EmitContext().AddEmitFlags(node, printer.EFNoComments)
 	// !!! TODO: Also remove synthetic trailing/leading comments added by transforms

testdata/baselines/reference/submodule/conformance/jsDeclarationsClassStatic(target=es2015).js

@@ -63,6 +63,9 @@ declare const Strings: {
 export = Handler;
 export { Strings };
 export type HandlerOptions = {
+    /**
+     * Should be able to export a type alias at the same time.
+     */
     name: string;
 };
 /**

testdata/baselines/reference/submodule/conformance/jsDeclarationsImportAliasExposedWithinNamespace.js

@@ -65,7 +65,13 @@ export declare namespace myTypes {
 }
 export declare namespace myTypes {
     export type typeB = {
+        /**
+         * - Prop 1.
+         */
         prop1: myTypes.typeA;
+        /**
+         * - Prop 2.
+         */
         prop2: string;
     };
 }

testdata/baselines/reference/submodule/conformance/jsDeclarationsImportAliasExposedWithinNamespaceCjs.js

@@ -65,7 +65,13 @@ export declare namespace myTypes {
 }
 export declare namespace myTypes {
     export type typeB = {
+        /**
+         * - Prop 1.
+         */
         prop1: myTypes.typeA;
+        /**
+         * - Prop 2.
+         */
         prop2: string;
     };
 }

testdata/baselines/reference/submodule/conformance/jsDeclarationsTypedefDescriptionsPreserved.js

@@ -44,11 +44,23 @@
  * @property {string} baz - Sylvester McMonkey McBean
  */
 type FooOptions = {
+    /**
+     * - Marvin K Mooney
+     */
     bar: boolean;
+    /**
+     * - Sylvester McMonkey McBean
+     */
     baz: string;
 };
 type BarOptions = {
+    /**
+     * - Marvin K Mooney
+     */
     bar: boolean;
+    /**
+     * - Sylvester McMonkey McBean
+     */
     baz: string;
 };
 /**

testdata/baselines/reference/submodule/conformance/linkTagEmit1.js

@@ -56,7 +56,13 @@ var see3 = true;
  */
 type N = number;
 type D1 = {
+    /**
+     * Just link to {@link NS.R} this time
+     */
     e: 1;
+    /**
+     * Wyatt Earp loved {@link N integers} I bet.
+     */
     m: 1;
 };
 type Z = number;

testdata/baselines/reference/submoduleAccepted/conformance/jsDeclarationsClassStatic(target=es2015).js.diff

@@ -18,9 +18,6 @@
 -    let b: string;
 -}
 -type HandlerOptions = {
--    /**
--     * Should be able to export a type alias at the same time.
--     */
 +    var statische: () => void;
 +}
 +declare const Strings: {
@@ -30,6 +27,9 @@
 +export = Handler;
 +export { Strings };
 +export type HandlerOptions = {
+     /**
+      * Should be able to export a type alias at the same time.
+      */
      name: string;
  };
 +/**

testdata/baselines/reference/submoduleAccepted/conformance/jsDeclarationsImportAliasExposedWithinNamespace.js.diff

@@ -7,9 +7,6 @@
 -export namespace myTypes {
 -    type typeA = string | RegExp | Array<string | RegExp>;
 -    type typeB = {
--        /**
--         * - Prop 1.
--         */
 +/**
 + * @namespace myTypes
 + * @global
@@ -21,10 +18,11 @@
 +}
 +export declare namespace myTypes {
 +    export type typeB = {
-         prop1: myTypes.typeA;
--        /**
--         * - Prop 2.
--         */
+         /**
+          * - Prop 1.
+          */
+@@= skipped -12, +20 lines =@@
+          */
          prop2: string;
      };
 -    type typeC = myTypes.typeB | Function;
@@ -62,7 +60,7 @@
  }
  /** @typedef {boolean|myTypes.typeC} testFnTypes.input */
  /**
-@@= skipped -33, +44 lines =@@
+@@= skipped -21, +30 lines =@@
   * @param {testFnTypes.input} input - Input.
   * @returns {number|null} Result.
   */