Wrap the generated patternProperties comments in code quotes to fix TSDoc issues.

Author: iclanton

common/changes/@rushstack/heft-json-schema-typings-plugin/use-json-schema-plugin_2026-02-22-04-05.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-json-schema-typings-plugin",
+      "comment": "Fix TSDoc parse warnings caused by `@` characters in generated type definitions. The `json-schema-to-typescript` library emits JSDoc comments containing raw JSON Schema pattern values (e.g. `\"^@[^\\s]*$\"`), which TSDoc interprets as tag indicators. These values are now wrapped in backtick code spans to prevent the warnings.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-json-schema-typings-plugin"
+}

heft-plugins/heft-json-schema-typings-plugin/src/JsonSchemaTypingsGenerator.ts

@@ -60,6 +60,15 @@ export class JsonSchemaTypingsGenerator extends TypingsGenerator {
           format: formatWithPrettier
         });
 
+        // The json-schema-to-typescript library generates JSDoc comments containing
+        // inline values that may include "@" characters, such as:
+        //   via the `patternProperty` "^@[^\s]*$".
+        // TSDoc interprets "@" as a tag indicator, causing parse warnings.
+        // Wrap double-quoted values in backtick code spans to prevent this issue.
+        // Use " +" for the leading whitespace so this matches at any JSDoc indentation
+        // level (e.g. top-level " * ..." or nested "     * ...").
+        typings = typings.replace(/^( +\* .+`(?:patternProperty|definition)`) "([^"]+)"/gm, '$1 `"$2"`');
+
         // Check for an "x-tsdoc-release-tag" property in the schema (e.g. "@public" or "@beta").
         // If present, inject the tag into JSDoc comments for all exported declarations.
         if (tsdocReleaseTag) {