[heft-json-schema-typings-plugin] Make formatWithPrettier configurable

- Add formatWithPrettier option to JsonSchemaTypingsGenerator constructor
- Expose formatWithPrettier in the Heft plugin options and JSON schema
- Defaults to false (skip prettier formatting)

Author: iclanton

common/changes/@rushstack/heft-json-schema-typings-plugin/x-tsdoc-tag_2026-02-18-17-00.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft-json-schema-typings-plugin",
+      "comment": "Add a `formatWithPrettier` option (defaults to `false`) to skip prettier formatting of generated typings.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft-json-schema-typings-plugin"
+}

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

@@ -9,7 +9,15 @@ import { type ITypingsGeneratorBaseOptions, TypingsGenerator } from '@rushstack/
 
 import { _addTsDocTagToExports } from './TsDocTagHelpers';
 
-interface IJsonSchemaTypingsGeneratorBaseOptions extends ITypingsGeneratorBaseOptions {}
+interface IJsonSchemaTypingsGeneratorBaseOptions extends ITypingsGeneratorBaseOptions {
+  /**
+   * If true, format generated typings with prettier.  Defaults to false.
+   *
+   * @remarks
+   * Enabling this requires the `prettier` package to be installed as a dependency.
+   */
+  formatWithPrettier?: boolean;
+}
 
 const SCHEMA_FILE_EXTENSION: '.schema.json' = '.schema.json';
 const X_TSDOC_TAG_KEY: 'x-tsdoc-tag' = 'x-tsdoc-tag';
@@ -21,8 +29,9 @@ interface IExtendedJson4Schema extends Json4Schema {
 
 export class JsonSchemaTypingsGenerator extends TypingsGenerator {
   public constructor(options: IJsonSchemaTypingsGeneratorBaseOptions) {
+    const { formatWithPrettier = false, ...otherOptions } = options;
     super({
-      ...options,
+      ...otherOptions,
       fileExtensions: [SCHEMA_FILE_EXTENSION],
       // eslint-disable-next-line @typescript-eslint/naming-convention
       parseAndGenerateTypings: async (
@@ -44,9 +53,7 @@ export class JsonSchemaTypingsGenerator extends TypingsGenerator {
           // The typings generator adds its own banner comment
           bannerComment: '',
           cwd: dirname,
-          // The generated typings are machine-produced .d.ts files that do not need
-          // prettier formatting.
-          format: false
+          format: formatWithPrettier
         });
 
         // Check for an "x-tsdoc-tag" property in the schema (e.g. "@public" or "@beta").

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

@@ -18,6 +18,7 @@ const PLUGIN_NAME: 'json-schema-typings-plugin' = 'json-schema-typings-plugin';
 export interface IJsonSchemaTypingsPluginOptions {
   srcFolder?: string;
   generatedTsFolders?: string[];
+  formatWithPrettier?: boolean;
 }
 
 export default class JsonSchemaTypingsPlugin implements IHeftTaskPlugin<IJsonSchemaTypingsPluginOptions> {
@@ -34,7 +35,7 @@ export default class JsonSchemaTypingsPlugin implements IHeftTaskPlugin<IJsonSch
       hooks: { run, runIncremental }
     } = taskSession;
     const { buildFolderPath } = heftConfiguration;
-    const { srcFolder = 'src', generatedTsFolders = ['temp/schemas-ts'] } = options;
+    const { srcFolder = 'src', generatedTsFolders = ['temp/schemas-ts'], formatWithPrettier } = options;
 
     const resolvedTsFolders: string[] = [];
     for (const generatedTsFolder of generatedTsFolders) {
@@ -47,7 +48,8 @@ export default class JsonSchemaTypingsPlugin implements IHeftTaskPlugin<IJsonSch
       srcFolder: `${buildFolderPath}/${srcFolder}`,
       generatedTsFolder,
       secondaryGeneratedTsFolders,
-      terminal
+      terminal,
+      formatWithPrettier
     });
 
     run.tapPromise(PLUGIN_NAME, async () => {

heft-plugins/heft-json-schema-typings-plugin/src/schemas/heft-json-schema-typings-plugin.schema.json

@@ -18,6 +18,11 @@
       "items": {
         "type": "string"
       }
+    },
+
+    "formatWithPrettier": {
+      "type": "boolean",
+      "description": "If true, format generated typings with prettier. Defaults to false."
     }
   }
 }