@znight/cli 0.1.3 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@znight/cli",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Znight CLI: scaffold projects, generate code, run dev server and builds",
   "license": "MIT",
   "author": "Ugho STEPHAN",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.8.1",
-    "@znight/core": "0.1.3",
+    "@znight/core": "0.2.0",
     "citty": "^0.2.2",
     "picocolors": "^1.1.1"
   },
@@ -50,14 +50,14 @@
   },
   "devDependencies": {
     "vite": "8.3.5",
-    "@znight/compiler": "0.1.3",
-    "@znight/openapi": "0.1.3",
-    "@znight/schedule": "0.1.3"
+    "@znight/compiler": "0.2.0",
+    "@znight/openapi": "0.2.0",
+    "@znight/schedule": "0.2.0"
   },
   "peerDependencies": {
-    "@znight/compiler": "^0.1.3",
+    "@znight/compiler": "^0.2.0",
     "vite": "^8.0.0",
-    "@znight/openapi": "^0.1.3"
+    "@znight/openapi": "^0.2.0"
   },
   "peerDependenciesMeta": {
     "@znight/compiler": {

package/src/commands/generate.ts

@@ -1,7 +1,7 @@
 /**
- * `znight generate`: writes the DI container module (`src/.znight/container.generated.ts`) with the
- * compiler, checks that it is up to date (`--check`, for CI) or keeps it up to date (`--watch`, for
- * `tsc --watch` and editors).
+ * `znight generate`: writes the DI container module (`src/.znight/container.generated.ts`), and the
+ * files compiler extensions emit with it, with the compiler, checks that they are up to date
+ * (`--check`, for CI) or keeps them up to date (`--watch`, for `tsc --watch` and editors).
  */
 import type { Command } from '../command.ts'
 import type { CliContext } from '../context.ts'
@@ -200,6 +200,16 @@ function staleFilesOf(result: CheckResultLike): string[] {
   return [...stale].sort((a, b) => Number(b === result.outFile) - Number(a === result.outFile))
 }
 
+/**
+ * The hint of a missing generated file: the module, an extra file of the compiler extensions (an SDL
+ * schema...) or the library manifest (`dist/znight.providers.json`).
+ */
+function missingHint(path: string, outFile: string, extraFiles: ReadonlySet<string>): string {
+  if (path === outFile) return 'run "znight generate" (it is git-ignored: generate it before tsc and tests)'
+  if (extraFiles.has(path)) return 'run "znight generate" (a compiler extension generates it from the sources)'
+  return 'run "znight generate" after the build: a build cleaning dist/ (tsdown, tsc --build --clean...) deletes it'
+}
+
 async function check(cli: CliContext, compiler: CompilerApi, options: ZnightOptions): Promise<number> {
   const root = options.root ?? cli.cwd
   const started = performance.now()
@@ -211,15 +221,11 @@ async function check(cli: CliContext, compiler: CompilerApi, options: ZnightOpti
   }
   const file = displayPath(result.outFile, cli.cwd)
   const stale = staleFilesOf(result)
+  const extraFiles = new Set(result.extraFiles?.map(extra => extra.file))
   for (const path of stale) {
     const shown = displayPath(path, cli.cwd)
-    // the other generated file is the library manifest (`dist/znight.providers.json`)
-    const hint =
-      path === result.outFile
-        ? 'run "znight generate" (it is git-ignored: generate it before tsc and tests)'
-        : 'run "znight generate" after the build: a build cleaning dist/ (tsdown, tsc --build --clean...) deletes it'
     if (existsSync(path)) cli.reporter.error(`${shown} is out of date`, ['run "znight generate"'])
-    else cli.reporter.error(`${shown} is missing`, [hint])
+    else cli.reporter.error(`${shown} is missing`, [missingHint(path, result.outFile, extraFiles)])
   }
   if (stale.length > 0) return 1
   cli.reporter.success(

package/src/integrations/compiler.ts

@@ -48,6 +48,13 @@ export interface ZnightOptions {
   readonly [option: string]: unknown
 }
 
+/** A file emitted by a compiler extension next to the generated module (`CompileResult.extraFiles`, §6.2). */
+export interface ExtraFileLike {
+  /** Absolute path. */
+  readonly file: string
+  readonly content: string
+}
+
 /** What the CLI reads from a compile result (`CompileResult`, §6.2). */
 export interface CompileResultLike {
   /** Content of the generated module (with errors: a module throwing them, or empty). */
@@ -58,6 +65,8 @@ export interface CompileResultLike {
   readonly stats?: { readonly files?: number; readonly providers?: number; readonly durationMs?: number } | undefined
   /** Files the result depends on (`createCompiler()` results). */
   readonly watchFiles?: readonly string[] | undefined
+  /** Files emitted by compiler extensions (an SDL schema...), absent from compilers without them. */
+  readonly extraFiles?: readonly ExtraFileLike[] | undefined
 }
 
 /** Result of {@link CompilerApi.generate}. */
@@ -71,9 +80,9 @@ export interface CheckResultLike extends CompileResultLike {
   /** The generated files on disk are missing or differ from what would be generated. */
   readonly stale: boolean
   /**
-   * The generated files that are missing or out of date (the module, and `znight.providers.json` in
-   * library mode). Empty when `stale` is `false`; empty or absent with `stale` when the compiler
-   * does not say which file is stale.
+   * The generated files that are missing or out of date (the module, the extra files of the
+   * extensions, and `znight.providers.json` in library mode). Empty when `stale` is `false`; empty or
+   * absent with `stale` when the compiler does not say which file is stale.
    */
   readonly staleFiles?: readonly string[] | undefined
 }
@@ -240,7 +249,10 @@ export function adaptCompilerModule(module: CompilerModule): CompilerApi {
       return written(await generate(options), before)
     }
     const result = await compileOnly(options)
-    const changed = !hasErrors(result.diagnostics) && writeIfChanged(result.outFile, result.diskCode ?? result.code)
+    let changed = false
+    if (!hasErrors(result.diagnostics)) {
+      for (const output of outputsOf(result, false)) changed = writeIfChanged(output.file, output.content) || changed
+    }
     return { ...result, written: changed }
   }
 
@@ -285,17 +297,30 @@ export function adaptCompilerModule(module: CompilerModule): CompilerApi {
 }
 
 /**
- * The generated files of a compile result that differ from the disk: the module, and
- * `znight.providers.json` in library mode. None with errors (nothing would be written).
+ * The generated files of a compile result: the module, the extra files of the extensions and, with
+ * `library`, `znight.providers.json` in library mode (`generate()` of the compiler writes the module
+ * and the extra files; library mode is a compiler feature).
  */
-function staleOutputs(result: ModuleResult): string[] {
-  if (hasErrors(result.diagnostics)) return []
+function outputsOf(result: ModuleResult, library: boolean): { file: string; content: string }[] {
   const outputs: { file: string; content: string }[] = [
     { file: result.outFile, content: result.diskCode ?? result.code },
   ]
+  for (const extra of result.extraFiles ?? []) outputs.push({ file: extra.file, content: extra.content })
   const { file, content } = result.library ?? {}
-  if (typeof file === 'string' && typeof content === 'string') outputs.push({ file, content })
-  return outputs.filter(output => readText(output.file) !== output.content).map(output => output.file)
+  if (library && typeof file === 'string' && typeof content === 'string') outputs.push({ file, content })
+  return outputs
+}
+
+/**
+ * The generated files of a compile result that differ from the disk: the module, the extra files of
+ * the extensions and `znight.providers.json` in library mode. None with errors (nothing would be
+ * written).
+ */
+function staleOutputs(result: ModuleResult): string[] {
+  if (hasErrors(result.diagnostics)) return []
+  return outputsOf(result, true)
+    .filter(output => readText(output.file) !== output.content)
+    .map(output => output.file)
 }
 
 /** Default `outFile` of the compiler (§6.2). */