typespec-hono 0.10.0 → 0.11.0

package/dist/src/app.d.ts

@@ -1,5 +1,14 @@
 import { type SecurityRequirement } from "./security.js";
 import { type EmittedRoute, type EmittedService } from "typespec-http-zod";
+/**
+ * The header every emitted file carries.
+ *
+ * **`DO NOT EDIT` says what not to do and not what to do instead.** Only the project knows the
+ * command that regenerates, so `regenerate-hint` supplies it and the generic line stands otherwise.
+ * The library honours the same option for the files it writes; a hint reaching three files out of
+ * five would be worse than none, because the two it missed are the two a reader opens first.
+ */
+export declare function generatedBanner(hint: string | undefined): string;
 /**
  * TypeSpec publishes `/widgets/{widget-id}`; Hono routes on `/widgets/:widget-id`.
  *

package/dist/src/app.js

@@ -1,9 +1,19 @@
 import { renderSecurity } from "./security.js";
 import { isRawBinaryMediaType, objectKey, } from "typespec-http-zod";
-/** The header every emitted file carries. */
-const GENERATED_BANNER = `// GENERATED by typespec-hono from the TypeSpec service definition. DO NOT EDIT.
-// Recompile the spec that produced it; edits here are overwritten on the next run.
-`;
+/**
+ * The header every emitted file carries.
+ *
+ * **`DO NOT EDIT` says what not to do and not what to do instead.** Only the project knows the
+ * command that regenerates, so `regenerate-hint` supplies it and the generic line stands otherwise.
+ * The library honours the same option for the files it writes; a hint reaching three files out of
+ * five would be worse than none, because the two it missed are the two a reader opens first.
+ */
+export function generatedBanner(hint) {
+    const second = hint === undefined
+        ? "// Recompile the spec that produced it; edits here are overwritten on the next run."
+        : `// Regenerate with: ${hint}`;
+    return `// GENERATED by typespec-hono from the TypeSpec service definition. DO NOT EDIT.\n${second}\n`;
+}
 /** A parameter name Hono can carry verbatim. Measured against Hono, not assumed. */
 const PLAIN_PATH_PARAMETER = /^[A-Za-z0-9_.~-]+$/;
 /**
@@ -755,7 +765,7 @@ securityFor) {
      */
     const usesBasePath = basePaths.length > 0;
     const needsHonoValue = subApps.size > 0 || usesBasePath;
-    return `${GENERATED_BANNER}
+    return `${generatedBanner(emitted.options.regenerateHint)}
 ${validates ? 'import { zValidator } from "@hono/zod-validator";\n' : ""}${needsHonoValue ? 'import { Hono } from "hono";\nimport type { Context, Input } from "hono";' : 'import type { Context, Hono, Input } from "hono";'}
 ${usesZod ? 'import { z } from "zod";\n' : ""}import type { AppEnv, Awaitable, Ctx, Result, RouteDeps } from ${runtimeModule};${negotiates ? `\nimport { selectContentType } from ${runtimeModule};` : ""}${guardsHead ? `\nimport { headOnly } from ${runtimeModule};` : ""}${dispatchesBody ? `\nimport { byContentType } from ${runtimeModule};` : ""}
 ${imports}

package/dist/src/emitter.js

@@ -62,10 +62,15 @@ function targetFor(emitted, verb, path) {
  * `test/adopter.test.ts` is the arm that now opens that branch.
  */
 /** The header the emitted runtime carries, matching every other generated file. */
-const GENERATED_RUNTIME_BANNER = `// GENERATED by typespec-hono. DO NOT EDIT.
-// A copy of this package's runtime, emitted so the generated code imports no package at run time.
+function generatedRuntimeBanner(hint) {
+    const second = hint === undefined
+        ? "// A copy of this package's runtime, emitted so the generated code imports no package at run time."
+        : `// Regenerate with: ${hint}`;
+    return `// GENERATED by typespec-hono. DO NOT EDIT.
+${second}
 // Point \`runtime-module\` at a module of your own to replace it.
 `;
+}
 /**
  * The generated runtime lands beside the generated code, so nothing the emitter writes imports this
  * package at run time.
@@ -93,7 +98,7 @@ export async function $onEmit(context) {
         if (emitted.options.runtimeModule === DEFAULT_RUNTIME_MODULE) {
             await emitFile(context.program, {
                 path: resolvePath(emitted.outputDir, "runtime.gen.ts"),
-                content: `${GENERATED_RUNTIME_BANNER}${readFileSync(RUNTIME_SOURCE, "utf8")}`,
+                content: `${generatedRuntimeBanner(emitted.options.regenerateHint)}${readFileSync(RUNTIME_SOURCE, "utf8")}`,
             });
         }
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespec-hono",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "TypeSpec emitter: generate a Hono server, and the Zod validators it enforces, from an HTTP service definition, agreeing with the OpenAPI document @typespec/openapi3 publishes from the same source.",
   "keywords": [
     "cloudflare-workers",
@@ -44,7 +44,7 @@
     "provenance": true
   },
   "dependencies": {
-    "typespec-http-zod": "^0.12.0"
+    "typespec-http-zod": "^0.13.0"
   },
   "devDependencies": {
     "@hono/zod-openapi": "^1.4.0",