@typespec/prettier-plugin-typespec 0.49.0-dev.2 → 0.49.0-dev.3

package/dist/index.js

@@ -58,39 +58,40 @@ var SyntaxKind;
     SyntaxKind[SyntaxKind["DocText"] = 48] = "DocText";
     SyntaxKind[SyntaxKind["DocParamTag"] = 49] = "DocParamTag";
     SyntaxKind[SyntaxKind["DocReturnsTag"] = 50] = "DocReturnsTag";
-    SyntaxKind[SyntaxKind["DocTemplateTag"] = 51] = "DocTemplateTag";
-    SyntaxKind[SyntaxKind["DocUnknownTag"] = 52] = "DocUnknownTag";
-    SyntaxKind[SyntaxKind["Projection"] = 53] = "Projection";
-    SyntaxKind[SyntaxKind["ProjectionParameterDeclaration"] = 54] = "ProjectionParameterDeclaration";
-    SyntaxKind[SyntaxKind["ProjectionModelSelector"] = 55] = "ProjectionModelSelector";
-    SyntaxKind[SyntaxKind["ProjectionModelPropertySelector"] = 56] = "ProjectionModelPropertySelector";
-    SyntaxKind[SyntaxKind["ProjectionOperationSelector"] = 57] = "ProjectionOperationSelector";
-    SyntaxKind[SyntaxKind["ProjectionUnionSelector"] = 58] = "ProjectionUnionSelector";
-    SyntaxKind[SyntaxKind["ProjectionUnionVariantSelector"] = 59] = "ProjectionUnionVariantSelector";
-    SyntaxKind[SyntaxKind["ProjectionInterfaceSelector"] = 60] = "ProjectionInterfaceSelector";
-    SyntaxKind[SyntaxKind["ProjectionEnumSelector"] = 61] = "ProjectionEnumSelector";
-    SyntaxKind[SyntaxKind["ProjectionEnumMemberSelector"] = 62] = "ProjectionEnumMemberSelector";
-    SyntaxKind[SyntaxKind["ProjectionExpressionStatement"] = 63] = "ProjectionExpressionStatement";
-    SyntaxKind[SyntaxKind["ProjectionIfExpression"] = 64] = "ProjectionIfExpression";
-    SyntaxKind[SyntaxKind["ProjectionBlockExpression"] = 65] = "ProjectionBlockExpression";
-    SyntaxKind[SyntaxKind["ProjectionMemberExpression"] = 66] = "ProjectionMemberExpression";
-    SyntaxKind[SyntaxKind["ProjectionLogicalExpression"] = 67] = "ProjectionLogicalExpression";
-    SyntaxKind[SyntaxKind["ProjectionEqualityExpression"] = 68] = "ProjectionEqualityExpression";
-    SyntaxKind[SyntaxKind["ProjectionUnaryExpression"] = 69] = "ProjectionUnaryExpression";
-    SyntaxKind[SyntaxKind["ProjectionRelationalExpression"] = 70] = "ProjectionRelationalExpression";
-    SyntaxKind[SyntaxKind["ProjectionArithmeticExpression"] = 71] = "ProjectionArithmeticExpression";
-    SyntaxKind[SyntaxKind["ProjectionCallExpression"] = 72] = "ProjectionCallExpression";
-    SyntaxKind[SyntaxKind["ProjectionLambdaExpression"] = 73] = "ProjectionLambdaExpression";
-    SyntaxKind[SyntaxKind["ProjectionLambdaParameterDeclaration"] = 74] = "ProjectionLambdaParameterDeclaration";
-    SyntaxKind[SyntaxKind["ProjectionModelExpression"] = 75] = "ProjectionModelExpression";
-    SyntaxKind[SyntaxKind["ProjectionModelProperty"] = 76] = "ProjectionModelProperty";
-    SyntaxKind[SyntaxKind["ProjectionModelSpreadProperty"] = 77] = "ProjectionModelSpreadProperty";
-    SyntaxKind[SyntaxKind["ProjectionSpreadProperty"] = 78] = "ProjectionSpreadProperty";
-    SyntaxKind[SyntaxKind["ProjectionTupleExpression"] = 79] = "ProjectionTupleExpression";
-    SyntaxKind[SyntaxKind["ProjectionStatement"] = 80] = "ProjectionStatement";
-    SyntaxKind[SyntaxKind["ProjectionDecoratorReferenceExpression"] = 81] = "ProjectionDecoratorReferenceExpression";
-    SyntaxKind[SyntaxKind["Return"] = 82] = "Return";
-    SyntaxKind[SyntaxKind["JsNamespaceDeclaration"] = 83] = "JsNamespaceDeclaration";
+    SyntaxKind[SyntaxKind["DocErrorsTag"] = 51] = "DocErrorsTag";
+    SyntaxKind[SyntaxKind["DocTemplateTag"] = 52] = "DocTemplateTag";
+    SyntaxKind[SyntaxKind["DocUnknownTag"] = 53] = "DocUnknownTag";
+    SyntaxKind[SyntaxKind["Projection"] = 54] = "Projection";
+    SyntaxKind[SyntaxKind["ProjectionParameterDeclaration"] = 55] = "ProjectionParameterDeclaration";
+    SyntaxKind[SyntaxKind["ProjectionModelSelector"] = 56] = "ProjectionModelSelector";
+    SyntaxKind[SyntaxKind["ProjectionModelPropertySelector"] = 57] = "ProjectionModelPropertySelector";
+    SyntaxKind[SyntaxKind["ProjectionOperationSelector"] = 58] = "ProjectionOperationSelector";
+    SyntaxKind[SyntaxKind["ProjectionUnionSelector"] = 59] = "ProjectionUnionSelector";
+    SyntaxKind[SyntaxKind["ProjectionUnionVariantSelector"] = 60] = "ProjectionUnionVariantSelector";
+    SyntaxKind[SyntaxKind["ProjectionInterfaceSelector"] = 61] = "ProjectionInterfaceSelector";
+    SyntaxKind[SyntaxKind["ProjectionEnumSelector"] = 62] = "ProjectionEnumSelector";
+    SyntaxKind[SyntaxKind["ProjectionEnumMemberSelector"] = 63] = "ProjectionEnumMemberSelector";
+    SyntaxKind[SyntaxKind["ProjectionExpressionStatement"] = 64] = "ProjectionExpressionStatement";
+    SyntaxKind[SyntaxKind["ProjectionIfExpression"] = 65] = "ProjectionIfExpression";
+    SyntaxKind[SyntaxKind["ProjectionBlockExpression"] = 66] = "ProjectionBlockExpression";
+    SyntaxKind[SyntaxKind["ProjectionMemberExpression"] = 67] = "ProjectionMemberExpression";
+    SyntaxKind[SyntaxKind["ProjectionLogicalExpression"] = 68] = "ProjectionLogicalExpression";
+    SyntaxKind[SyntaxKind["ProjectionEqualityExpression"] = 69] = "ProjectionEqualityExpression";
+    SyntaxKind[SyntaxKind["ProjectionUnaryExpression"] = 70] = "ProjectionUnaryExpression";
+    SyntaxKind[SyntaxKind["ProjectionRelationalExpression"] = 71] = "ProjectionRelationalExpression";
+    SyntaxKind[SyntaxKind["ProjectionArithmeticExpression"] = 72] = "ProjectionArithmeticExpression";
+    SyntaxKind[SyntaxKind["ProjectionCallExpression"] = 73] = "ProjectionCallExpression";
+    SyntaxKind[SyntaxKind["ProjectionLambdaExpression"] = 74] = "ProjectionLambdaExpression";
+    SyntaxKind[SyntaxKind["ProjectionLambdaParameterDeclaration"] = 75] = "ProjectionLambdaParameterDeclaration";
+    SyntaxKind[SyntaxKind["ProjectionModelExpression"] = 76] = "ProjectionModelExpression";
+    SyntaxKind[SyntaxKind["ProjectionModelProperty"] = 77] = "ProjectionModelProperty";
+    SyntaxKind[SyntaxKind["ProjectionModelSpreadProperty"] = 78] = "ProjectionModelSpreadProperty";
+    SyntaxKind[SyntaxKind["ProjectionSpreadProperty"] = 79] = "ProjectionSpreadProperty";
+    SyntaxKind[SyntaxKind["ProjectionTupleExpression"] = 80] = "ProjectionTupleExpression";
+    SyntaxKind[SyntaxKind["ProjectionStatement"] = 81] = "ProjectionStatement";
+    SyntaxKind[SyntaxKind["ProjectionDecoratorReferenceExpression"] = 82] = "ProjectionDecoratorReferenceExpression";
+    SyntaxKind[SyntaxKind["Return"] = 83] = "Return";
+    SyntaxKind[SyntaxKind["JsNamespaceDeclaration"] = 84] = "JsNamespaceDeclaration";
 })(SyntaxKind || (SyntaxKind = {}));
 var IdentifierKind;
 (function (IdentifierKind) {
@@ -972,6 +973,15 @@ const diagnostics = {
             default: paramMessage `Rule "${"ruleName"}" has been enabled and disabled in the same ruleset.`,
         },
     },
+    /**
+     * Formatter
+     */
+    "format-failed": {
+        severity: "error",
+        messages: {
+            default: paramMessage `File '${"file"}' failed to format. ${"details"}`,
+        },
+    },
     /**
      * Decorator
      */
@@ -3743,6 +3753,8 @@ function createScanner(source, diagnosticHandler) {
                     if (atConflictMarker())
                         return scanConflictMarker();
                     return next(Token.DocText);
+                case 45 /* CharCode.Minus */:
+                    return next(Token.Hyphen);
             }
             if (isAsciiIdentifierStart(ch)) {
                 return scanIdentifier();
@@ -4625,6 +4637,7 @@ path, options, print) {
         case SyntaxKind.DocParamTag:
         case SyntaxKind.DocTemplateTag:
         case SyntaxKind.DocReturnsTag:
+        case SyntaxKind.DocErrorsTag:
         case SyntaxKind.DocUnknownTag:
             // https://github.com/microsoft/typespec/issues/1319 Tracks pretty-printing doc comments.
             compilerAssert(false, "Currently, doc comments are only handled as regular comments and we do not opt in to parsing them so we shouldn't reach here.");
@@ -7457,6 +7470,11 @@ function createParser(code, options = {}) {
             },
         ];
     }
+    /**
+     * Parses a documentation tag.
+     *
+     * @see <a href="https://microsoft.github.io/typespec/language-basics/documentation#tsdoc-doc-comments">TypeSpec documentation docs</a>
+     */
     function parseDocTag() {
         const pos = tokenPos();
         parseExpected(Token.At);
@@ -7469,12 +7487,19 @@ function createParser(code, options = {}) {
             case "return":
             case "returns":
                 return parseDocSimpleTag(pos, tagName, SyntaxKind.DocReturnsTag);
+            case "errors":
+                return parseDocSimpleTag(pos, tagName, SyntaxKind.DocErrorsTag);
             default:
                 return parseDocSimpleTag(pos, tagName, SyntaxKind.DocUnknownTag);
         }
     }
+    /**
+     * Handles param-like documentation comment tags.
+     * For example, `@param` and `@template`.
+     */
     function parseDocParamLikeTag(pos, tagName, kind, messageId) {
         const name = parseDocIdentifier(messageId);
+        parseOptionalHyphenDocParamLikeTag();
         const content = parseDocContent();
         return {
             kind,
@@ -7484,6 +7509,24 @@ function createParser(code, options = {}) {
             ...finishNode(pos),
         };
     }
+    /**
+     * Handles the optional hyphen in param-like documentation comment tags.
+     *
+     * TypeSpec recommends no hyphen, but supports a hyphen to match TSDoc.
+     * (Original design discussion recorded in [2390].)
+     *
+     * [2390]: https://github.com/microsoft/typespec/issues/2390
+     */
+    function parseOptionalHyphenDocParamLikeTag() {
+        while (parseOptional(Token.Whitespace))
+            ; // Skip whitespace
+        if (parseOptional(Token.Hyphen)) {
+            // The doc content started with a hyphen, so skip subsequent whitespace
+            // (The if statement already advanced past the hyphen itself.)
+            while (parseOptional(Token.Whitespace))
+                ;
+        }
+    }
     function parseDocSimpleTag(pos, tagName, kind) {
         const content = parseDocContent();
         return {
@@ -8049,6 +8092,7 @@ function visitChildren(node, cb) {
         case SyntaxKind.DocTemplateTag:
             return (visitNode(cb, node.tagName) || visitNode(cb, node.paramName) || visitEach(cb, node.content));
         case SyntaxKind.DocReturnsTag:
+        case SyntaxKind.DocErrorsTag:
         case SyntaxKind.DocUnknownTag:
             return visitNode(cb, node.tagName) || visitEach(cb, node.content);
         // no children for the rest of these.