feat: Improve headers of generated schemas

rjmunro · rjmunro · commit 0a9f81d41942 · 2025-11-17T11:18:25.000Z
* Show path to source file
* Show actual yarn command to run to update
diff --git a/packages/timeline-state-resolver-tools/bin/schema-types.mjs b/packages/timeline-state-resolver-tools/bin/schema-types.mjs
@@ -47,7 +47,9 @@ if (!searchPath || !outputPath) {
 }
 
 const BANNER =
-	'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript.\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and re-run the "tsr-schema-types" tool to regenerate this file.\n */\n'
+	'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript.\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and run "yarn generate-schema-types" regenerate this file.\n */\n'
+const BANNER_WITH_SOURCE =
+	'/* eslint-disable */\n/**\n * This file was automatically generated by json-schema-to-typescript from [source].\n * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,\n * and run "yarn generate-schema-types" regenerate this file.\n */\n'
 
 let hadError = false
 
@@ -450,7 +452,7 @@ export interface DeviceOptions${dirId} extends DeviceOptionsBase<${dirId}Options
 	// Output to tsr types package
 	const outputFilePath = path.join(resolvedOutputPath, dir + '.ts')
 	if (output) {
-		output = BANNER + output
+		output = BANNER_WITH_SOURCE.replace('[source]', 'src/$schemas/generated/' + dir) + output
 
 		await fs.writeFile(outputFilePath, output)
 
diff --git a/packages/timeline-state-resolver-types/src/generated/abstract.ts b/packages/timeline-state-resolver-types/src/generated/abstract.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/abstract.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/action-schema.ts b/packages/timeline-state-resolver-types/src/generated/action-schema.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface TSRActionSchema {
diff --git a/packages/timeline-state-resolver-types/src/generated/atem.ts b/packages/timeline-state-resolver-types/src/generated/atem.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/atem.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/casparCG.ts b/packages/timeline-state-resolver-types/src/generated/casparCG.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/casparCG.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/common-options.ts b/packages/timeline-state-resolver-types/src/generated/common-options.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface DeviceCommonOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/device-options.ts b/packages/timeline-state-resolver-types/src/generated/device-options.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 import type { DeviceOptionsBase } from '../device'
diff --git a/packages/timeline-state-resolver-types/src/generated/generic-ptz-actions.ts b/packages/timeline-state-resolver-types/src/generated/generic-ptz-actions.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 
diff --git a/packages/timeline-state-resolver-types/src/generated/httpSend.ts b/packages/timeline-state-resolver-types/src/generated/httpSend.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/httpSend.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/httpWatcher.ts b/packages/timeline-state-resolver-types/src/generated/httpWatcher.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/httpWatcher.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface HttpWatcherOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/hyperdeck.ts b/packages/timeline-state-resolver-types/src/generated/hyperdeck.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/hyperdeck.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/index.ts b/packages/timeline-state-resolver-types/src/generated/index.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export * from './action-schema'
diff --git a/packages/timeline-state-resolver-types/src/generated/lawo.ts b/packages/timeline-state-resolver-types/src/generated/lawo.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/lawo.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface LawoOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/multiOsc.ts b/packages/timeline-state-resolver-types/src/generated/multiOsc.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/multiOsc.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface MultiOscOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/obs.ts b/packages/timeline-state-resolver-types/src/generated/obs.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/obs.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface ObsOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/osc.ts b/packages/timeline-state-resolver-types/src/generated/osc.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/osc.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface OscOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/panasonicPTZ.ts b/packages/timeline-state-resolver-types/src/generated/panasonicPTZ.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/panasonicPTZ.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 import type { SetPanTiltSpeedPayload, GetPanTiltPositionResult, SetZoomSpeedPayload, GetZoomPositionResult, StorePresetPayload, RecallPresetPayload, ResetPresetPayload, SetFocusSpeedPayload, SetFocusModePayload, GetFocusPositionResult, GetFocusModeResult } from './generic-ptz-actions'
diff --git a/packages/timeline-state-resolver-types/src/generated/pharos.ts b/packages/timeline-state-resolver-types/src/generated/pharos.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/pharos.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface PharosOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/quantel.ts b/packages/timeline-state-resolver-types/src/generated/quantel.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/quantel.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/shotoku.ts b/packages/timeline-state-resolver-types/src/generated/shotoku.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/shotoku.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface ShotokuOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/singularLive.ts b/packages/timeline-state-resolver-types/src/generated/singularLive.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/singularLive.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface SingularLiveOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/sisyfos.ts b/packages/timeline-state-resolver-types/src/generated/sisyfos.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/sisyfos.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/sofieChef.ts b/packages/timeline-state-resolver-types/src/generated/sofieChef.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/sofieChef.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/tcpSend.ts b/packages/timeline-state-resolver-types/src/generated/tcpSend.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/tcpSend.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/telemetrics.ts b/packages/timeline-state-resolver-types/src/generated/telemetrics.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/telemetrics.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface TelemetricsOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/tricaster.ts b/packages/timeline-state-resolver-types/src/generated/tricaster.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/tricaster.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 export interface TricasterOptions {
diff --git a/packages/timeline-state-resolver-types/src/generated/viscaOverIP.ts b/packages/timeline-state-resolver-types/src/generated/viscaOverIP.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/viscaOverIP.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 import type { SetPanTiltSpeedPayload, GetPanTiltPositionResult, SetZoomSpeedPayload, GetZoomPositionResult, StorePresetPayload, RecallPresetPayload, ResetPresetPayload, SetFocusSpeedPayload, SetFocusModePayload, GetFocusPositionResult, GetFocusModeResult } from './generic-ptz-actions'
diff --git a/packages/timeline-state-resolver-types/src/generated/vizMSE.ts b/packages/timeline-state-resolver-types/src/generated/vizMSE.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/vizMSE.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/vmix.ts b/packages/timeline-state-resolver-types/src/generated/vmix.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/vmix.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver-types/src/generated/websocketClient.ts b/packages/timeline-state-resolver-types/src/generated/websocketClient.ts
@@ -1,8 +1,8 @@
 /* eslint-disable */
 /**
- * This file was automatically generated by json-schema-to-typescript.
+ * This file was automatically generated by json-schema-to-typescript from src/$schemas/generated/websocketClient.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 import type { ActionExecutionResult } from "../actions"
 
diff --git a/packages/timeline-state-resolver/src/manifest.ts b/packages/timeline-state-resolver/src/manifest.ts
@@ -2,7 +2,7 @@
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and re-run the "tsr-schema-types" tool to regenerate this file.
+ * and run "yarn generate-schema-types" regenerate this file.
  */
 
 import { DeviceType } from 'timeline-state-resolver-types'
