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

package/dist/cli.cjs

@@ -794,6 +794,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;
@@ -1324,7 +1327,7 @@ function createFormSpecTSDocConfig(extensionTagNames = []) {
       })
     );
   }
-  for (const tagName of ["displayName", "description", "format", "placeholder"]) {
+  for (const tagName of ["displayName", "format", "placeholder"]) {
     config.addTagDefinition(
       new import_tsdoc.TSDocTagDefinition({
         tagName: "@" + tagName,
@@ -1402,12 +1405,12 @@ function supportsConstraintCapability(type, checker, capability) {
   if (capability === void 0) {
     return true;
   }
-  if ((0, import_analysis.hasTypeSemanticCapability)(type, checker, capability)) {
+  if ((0, import_internal.hasTypeSemanticCapability)(type, checker, capability)) {
     return true;
   }
   if (capability === "string-like") {
     const itemType = getArrayElementType(type, checker);
-    return itemType !== null && (0, import_analysis.hasTypeSemanticCapability)(itemType, checker, capability);
+    return itemType !== null && (0, import_internal.hasTypeSemanticCapability)(itemType, checker, capability);
   }
   return false;
 }
@@ -1505,11 +1508,11 @@ function buildCompilerBackedConstraintDiagnostics(node, sourceFile, tagName, par
   if (checker === void 0 || subjectType === void 0) {
     return [];
   }
-  const placement = (0, import_analysis.resolveDeclarationPlacement)(node);
+  const placement = (0, import_internal.resolveDeclarationPlacement)(node);
   if (placement === null) {
     return [];
   }
-  const definition = (0, import_analysis.getTagDefinition)(tagName, options?.extensionRegistry?.extensions);
+  const definition = (0, import_internal.getTagDefinition)(tagName, options?.extensionRegistry?.extensions);
   if (definition === null) {
     return [];
   }
@@ -1543,7 +1546,7 @@ function buildCompilerBackedConstraintDiagnostics(node, sourceFile, tagName, par
         )
       ];
     }
-    const resolution = (0, import_analysis.resolvePathTargetType)(subjectType, checker, target.path.segments);
+    const resolution = (0, import_internal.resolvePathTargetType)(subjectType, checker, target.path.segments);
     if (resolution.kind === "missing-property") {
       return [
         makeDiagnostic(
@@ -1600,7 +1603,7 @@ function buildCompilerBackedConstraintDiagnostics(node, sourceFile, tagName, par
   const subjectTypeText = checker.typeToString(subjectType, node, SYNTHETIC_TYPE_FORMAT_FLAGS);
   const hostType = options?.hostType ?? subjectType;
   const hostTypeText = checker.typeToString(hostType, node, SYNTHETIC_TYPE_FORMAT_FLAGS);
-  const result = (0, import_analysis.checkSyntheticTagApplication)({
+  const result = (0, import_internal.checkSyntheticTagApplication)({
     tagName,
     placement,
     hostType: hostTypeText,
@@ -1681,10 +1684,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();
@@ -1706,7 +1707,7 @@ function parseTSDocTags(node, file = "", options) {
         import_tsdoc.TextRange.fromStringRange(sourceText, range.pos, range.end)
       );
       const docComment = parserContext.docComment;
-      const parsedComment = (0, import_analysis.parseCommentBlock)(
+      const parsedComment = (0, import_internal.parseCommentBlock)(
         commentText,
         sharedCommentSyntaxOptions(options, range.pos)
       );
@@ -1729,7 +1730,7 @@ function parseTSDocTags(node, file = "", options) {
       for (const block of docComment.customBlocks) {
         const tagName = (0, import_core3.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);
@@ -1748,10 +1749,6 @@ function parseTSDocTags(node, file = "", options) {
                 provenance: provenance2
               });
               break;
-            case "description":
-              description = text2;
-              descriptionProvenance = provenance2;
-              break;
             case "placeholder":
               if (placeholder === void 0) {
                 placeholder = text2;
@@ -1779,7 +1776,7 @@ function parseTSDocTags(node, file = "", options) {
           diagnostics.push(...compilerDiagnostics);
           continue;
         }
-        const constraintNode = (0, import_analysis.parseConstraintTagValue)(
+        const constraintNode = (0, import_internal.parseConstraintTagValue)(
           tagName,
           text,
           provenance,
@@ -1798,18 +1795,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")
+          });
         }
       }
     }
@@ -1822,14 +1827,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",
@@ -1849,7 +1846,7 @@ function parseTSDocTags(node, file = "", options) {
       if (text === "") continue;
       const provenance = provenanceForParsedTag(rawTextTag.tag, sourceFile, file);
       if (rawTextTag.tag.normalizedTagName === "defaultValue") {
-        const defaultValueNode = (0, import_analysis.parseDefaultValueTagValue)(text, provenance);
+        const defaultValueNode = (0, import_internal.parseDefaultValueTagValue)(text, provenance);
         annotations.push(defaultValueNode);
         continue;
       }
@@ -1866,7 +1863,7 @@ function parseTSDocTags(node, file = "", options) {
         diagnostics.push(...compilerDiagnostics);
         continue;
       }
-      const constraintNode = (0, import_analysis.parseConstraintTagValue)(
+      const constraintNode = (0, import_internal.parseConstraintTagValue)(
         rawTextTag.tag.normalizedTagName,
         text,
         provenance,
@@ -1883,7 +1880,7 @@ function parseTSDocTags(node, file = "", options) {
       if (text === "") continue;
       const provenance = fallback.provenance;
       if (tagName === "defaultValue") {
-        const defaultValueNode = (0, import_analysis.parseDefaultValueTagValue)(text, provenance);
+        const defaultValueNode = (0, import_internal.parseDefaultValueTagValue)(text, provenance);
         annotations.push(defaultValueNode);
         continue;
       }
@@ -1900,7 +1897,7 @@ function parseTSDocTags(node, file = "", options) {
         diagnostics.push(...compilerDiagnostics);
         continue;
       }
-      const constraintNode = (0, import_analysis.parseConstraintTagValue)(
+      const constraintNode = (0, import_internal.parseConstraintTagValue)(
         tagName,
         text,
         provenance,
@@ -1926,7 +1923,7 @@ function extractDisplayNameMetadata(node) {
       if (range.kind !== ts.SyntaxKind.MultiLineCommentTrivia) continue;
       const commentText = sourceText.substring(range.pos, range.end);
       if (!commentText.startsWith("/**")) continue;
-      const parsed = (0, import_analysis.parseCommentBlock)(commentText);
+      const parsed = (0, import_internal.parseCommentBlock)(commentText);
       for (const tag of parsed.tags) {
         if (tag.normalizedTagName !== "displayName") {
           continue;
@@ -1979,7 +1976,7 @@ function getSharedPayloadText(tag, commentText, commentOffset) {
   if (tag.payloadSpan === null) {
     return "";
   }
-  return (0, import_analysis.sliceCommentSpan)(commentText, tag.payloadSpan, {
+  return (0, import_internal.sliceCommentSpan)(commentText, tag.payloadSpan, {
     offset: commentOffset
   }).trim();
 }
@@ -2005,7 +2002,7 @@ function collectRawTextFallbacks(node, file) {
   return fallbacks;
 }
 function isMemberTargetDisplayName(text) {
-  return (0, import_analysis.parseTagSyntax)("displayName", text).target !== null;
+  return (0, import_internal.parseTagSyntax)("displayName", text).target !== null;
 }
 function provenanceForComment(range, sourceFile, file, tagName) {
   const { line, character } = sourceFile.getLineAndCharacterOfPosition(range.pos);
@@ -2047,12 +2044,12 @@ function getTagCommentText(tag) {
   }
   return ts.getTextOfJSDocComment(tag.comment);
 }
-var ts, import_analysis, import_tsdoc, import_core3, TAGS_REQUIRING_RAW_TEXT, SYNTHETIC_TYPE_FORMAT_FLAGS, parserCache, parseResultCache;
+var ts, import_internal, import_tsdoc, import_core3, TAGS_REQUIRING_RAW_TEXT, SYNTHETIC_TYPE_FORMAT_FLAGS, parserCache, parseResultCache;
 var init_tsdoc_parser = __esm({
   "src/analyzer/tsdoc-parser.ts"() {
     "use strict";
     ts = __toESM(require("typescript"), 1);
-    import_analysis = require("@formspec/analysis");
+    import_internal = require("@formspec/analysis/internal");
     import_tsdoc = require("@microsoft/tsdoc");
     import_core3 = require("@formspec/core");
     TAGS_REQUIRING_RAW_TEXT = /* @__PURE__ */ new Set(["pattern", "enumOptions", "defaultValue"]);
@@ -3324,7 +3321,7 @@ var init_program = __esm({
 
 // src/validate/constraint-validator.ts
 function validateFieldNode(ctx, field) {
-  const analysis = (0, import_analysis2.analyzeConstraintTargets)(
+  const analysis = (0, import_internal2.analyzeConstraintTargets)(
     field.name,
     field.type,
     field.constraints,
@@ -3342,7 +3339,7 @@ function validateFieldNode(ctx, field) {
 }
 function validateObjectProperty(ctx, parentName, property) {
   const qualifiedName = `${parentName}.${property.name}`;
-  const analysis = (0, import_analysis2.analyzeConstraintTargets)(
+  const analysis = (0, import_internal2.analyzeConstraintTargets)(
     qualifiedName,
     property.type,
     property.constraints,
@@ -3393,11 +3390,11 @@ function validateIR(ir, options) {
     valid: ctx.diagnostics.every((diagnostic) => diagnostic.severity !== "error")
   };
 }
-var import_analysis2;
+var import_internal2;
 var init_constraint_validator = __esm({
   "src/validate/constraint-validator.ts"() {
     "use strict";
-    import_analysis2 = require("@formspec/analysis");
+    import_internal2 = require("@formspec/analysis/internal");
   }
 });