@formspec/build 0.1.0-alpha.20 → 0.1.0-alpha.22

package/dist/internals.js

@@ -410,7 +410,7 @@ import {
   sliceCommentSpan,
   parseCommentBlock,
   parseTagSyntax
-} from "@formspec/analysis";
+} from "@formspec/analysis/internal";
 import {
   TSDocParser,
   TSDocConfiguration,
@@ -437,7 +437,7 @@ function createFormSpecTSDocConfig(extensionTagNames = []) {
       })
     );
   }
-  for (const tagName of ["displayName", "description", "format", "placeholder"]) {
+  for (const tagName of ["displayName", "format", "placeholder"]) {
     config.addTagDefinition(
       new TSDocTagDefinition({
         tagName: "@" + tagName,
@@ -797,10 +797,8 @@ function parseTSDocTags(node, file = "", options) {
   const annotations = [];
   const diagnostics = [];
   let displayName;
-  let description;
   let placeholder;
   let displayNameProvenance;
-  let descriptionProvenance;
   let placeholderProvenance;
   const rawTextTags = [];
   const sourceFile = node.getSourceFile();
@@ -845,7 +843,7 @@ function parseTSDocTags(node, file = "", options) {
       for (const block of docComment.customBlocks) {
         const tagName = normalizeConstraintTagName(block.blockTag.tagName.substring(1));
         const parsedTag = nextParsedTag(tagName);
-        if (tagName === "displayName" || tagName === "description" || tagName === "format" || tagName === "placeholder") {
+        if (tagName === "displayName" || tagName === "format" || tagName === "placeholder") {
           const text2 = getBestBlockPayloadText(parsedTag, commentText, range.pos, block);
           if (text2 === "") continue;
           const provenance2 = parsedTag !== null ? provenanceForParsedTag(parsedTag, sourceFile, file) : provenanceForComment(range, sourceFile, file, tagName);
@@ -864,10 +862,6 @@ function parseTSDocTags(node, file = "", options) {
                 provenance: provenance2
               });
               break;
-            case "description":
-              description = text2;
-              descriptionProvenance = provenance2;
-              break;
             case "placeholder":
               if (placeholder === void 0) {
                 placeholder = text2;
@@ -914,18 +908,26 @@ function parseTSDocTags(node, file = "", options) {
           provenance: provenanceForComment(range, sourceFile, file, "deprecated")
         });
       }
-      if (description === void 0 && docComment.remarksBlock !== void 0) {
-        const remarks = extractBlockText(docComment.remarksBlock).trim();
-        if (remarks !== "") {
-          description = remarks;
-          descriptionProvenance = provenanceForComment(range, sourceFile, file, "remarks");
-        }
-      }
-      if (description === void 0) {
+      {
         const summary = extractPlainText(docComment.summarySection).trim();
         if (summary !== "") {
-          description = summary;
-          descriptionProvenance = provenanceForComment(range, sourceFile, file, "summary");
+          annotations.push({
+            kind: "annotation",
+            annotationKind: "description",
+            value: summary,
+            provenance: provenanceForComment(range, sourceFile, file, "summary")
+          });
+        }
+      }
+      if (docComment.remarksBlock !== void 0) {
+        const remarksText = extractBlockText(docComment.remarksBlock).trim();
+        if (remarksText !== "") {
+          annotations.push({
+            kind: "annotation",
+            annotationKind: "remarks",
+            value: remarksText,
+            provenance: provenanceForComment(range, sourceFile, file, "remarks")
+          });
         }
       }
     }
@@ -938,14 +940,6 @@ function parseTSDocTags(node, file = "", options) {
       provenance: displayNameProvenance
     });
   }
-  if (description !== void 0 && descriptionProvenance !== void 0) {
-    annotations.push({
-      kind: "annotation",
-      annotationKind: "description",
-      value: description,
-      provenance: descriptionProvenance
-    });
-  }
   if (placeholder !== void 0 && placeholderProvenance !== void 0) {
     annotations.push({
       kind: "annotation",
@@ -2731,6 +2725,9 @@ function applyAnnotations(schema, annotations, ctx) {
       case "description":
         schema.description = annotation.value;
         break;
+      case "remarks":
+        schema[`${ctx.vendorPrefix}-remarks`] = annotation.value;
+        break;
       case "defaultValue":
         schema.default = annotation.value;
         break;
@@ -3034,7 +3031,7 @@ function generateUiSchemaFromIR(ir) {
 // src/validate/constraint-validator.ts
 import {
   analyzeConstraintTargets
-} from "@formspec/analysis";
+} from "@formspec/analysis/internal";
 function validateFieldNode(ctx, field) {
   const analysis = analyzeConstraintTargets(
     field.name,