@tdk-landscape/tdk-cli-core 1.3.111 → 1.3.113

package/CHANGELOG.md

@@ -4,6 +4,7 @@ Notable changes to the `tdk` CLI. Versions match [npm](https://www.npmjs.com/pac
 
 ## Unreleased
 
+- `tdk eject` no longer claims files it does not create or prints a command that cannot work. It still writes only `EJECTED.md` (no file is copied, moved or generated; the Tiltfile and engine stay in git-ignored `.tdk/.tdk-out/`, and the per-service Compose files, golden-layer Dockerfile and Traefik file only exist after Tilt has run). `EJECTED.md` no longer lists them under "Keep" and says the Tiltfile still reads `.tdk/project.json` and the `service.json` files. `Next: tilt up` (which finds no Tiltfile at the project root) is replaced by `tilt up -f .tdk/.tdk-out/Tiltfile -- --focus=<stack>`, the form `tdk up` runs. A project that already has an `EJECTED.md` keeps its old text (the file is never overwritten) and is now told so. `--dry-run` headings read `Generated files, left where they are (git-ignored):` and `Files written:`. A command that exports plain Compose files and Dockerfiles does not exist. Fixes #610.
 - `tdk config regenerate` now restores a root `.tiltignore` that TDK wrote (it carries the `SYSTEM-GENERATED BY TDK CLI` header) and that was edited by hand, and prints `Restored: .tiltignore → project root (hand edits discarded)`. Before, it only copied the file when none existed, so `tdk config verify` kept failing with `Out of sync: .tiltignore (run 'tdk config regenerate')` after the advice was followed. A root `.tiltignore` without the header is still never overwritten, and plain `tdk project --yes` still does not overwrite an existing one. Docs: `docs/adopt-tdk.md` now quotes the current `tdk doctor` unknown-field wording.
 - `tdk doctor` now checks the project's own resource configs for duplicates. Two resources with the same `appName` fail (`Duplicate resource names`, naming both `service.json` paths): the name becomes the Compose service and Traefik router, so they collide, and before nothing reported it. Two backend, mcp or routed bring-your-own resources on the same `port` give a warning, not a failure (`Duplicate resource ports`): service ports are not published on the host and each service has its own container, so the pair can run, but it is usually a copied `service.json`. Frontends, workers, libraries and a missing `port` are ignored. Fixes #76.
 - `tdk doctor` no longer fails with `N resources without a package.json` for a bring-your-own resource. A bring-your-own resource (`--image`, `--dockerfile` or `buildContext`) is a plain container: its image is pulled or built from its own Dockerfile, never from the generated Dockerfile that copies a `package.json`, so the check was a false positive that made `tdk doctor` (and CI recipes that gate on it) exit non-zero right after wrapping an existing service. Backend, frontend, worker, migrator, mcp, library and sdk resources without a `package.json` still fail; Python, Go and Rust backends were already exempt. The other doctor checks were run on a project with only bring-your-own resources and report nothing. Fixes #599.

package/README.md

@@ -15,7 +15,7 @@ English | [简体中文](README-zh_cn.md) | [繁體中文](README-zh_tw.md) | [
 
 TDK CLI starts your services on your laptop. It is not a deploy and not a Compose file: define each service in `service.json`, then run `tdk up`. No Kubernetes is needed on the machine.
 
-Stability: 1.x local dev. Generated files are a contract; verify with `tdk config verify`. Core CLI is MIT and needs no key. Premium is optional.
+Stability: 1.x local dev. Write `service.json`; TDK generates the local runtime files. See [what TDK writes](docs/generated-files.md) and how to check for drift. Core CLI is MIT and needs no key. Premium is optional.
 
 Docker runs the containers. Tilt watches services and live-updates containers while you code. TDK CLI writes the configuration Tilt uses. Production deployment stays with Helm, Argo CD, or Kustomize.
 
@@ -39,6 +39,24 @@ curl http://api.shop.localhost/api/orders-api/health
 
 *Scaffolding a backend and frontend, then listing the stack.*
 
+### What TDK writes for a frontend
+
+You maintain `service.json`; TDK generates the local runtime files. A frontend such as `services/store/storefront-web` has files like these after generation:
+
+```text
+services/store/storefront-web/
+├── service.json                         # your service definition
+└── .autogenerated/                     # TDK writes these files
+    ├── nginx.autogenerated.conf        # serves the build and routes API requests
+    ├── Dockerfile.app.autogenerated     # local app image
+    ├── .env.frontend.autogenerated      # local frontend environment
+    ├── vite.config.frontend.autogenerated.ts
+    ├── tsconfig.autogenerated.json
+    └── api-client.ts                    # generated API client
+```
+
+You do not need to write the nginx config, Dockerfile, or a `docker-compose.yml` for this local stack. `tdk up` uses Docker and Tilt to start it. The [generated-files guide](docs/generated-files.md) lists the other outputs and explains how regeneration and drift checks work.
+
 ![Top 9 places to use TDK CLI: scaffold a service, start a stack, hot reload, port management, auto-discovery, boot order, proxy routing, include infra, and config verify](docs/assets/tdk-cli-top-9-uses.jpg)
 
 If Helm, Compose, or your existing Tilt setup already gives you a working local environment, keep using it. TDK CLI is for engineers managing several services who want a clear local service contract and one command to start the stack.
@@ -79,6 +97,7 @@ curl -fsSL https://tdk-landscape.github.io/install.sh | sh
 - [Pilot scorecard](docs/pilot-scorecard.md)
 - [Bring-your-own resources](docs/byo.md)
 - [Configuration and editor schemas](docs/configuration.md)
+- [Generated service files and drift checks](docs/generated-files.md)
 - [Runnable one-backend example](examples/one-backend/README.md)
 - [Runnable Python backend example](examples/one-backend-python/README.md)
 - [Full multi-service example](examples/tdk-example/README.md)

package/cli/dist/commands/eject.js

@@ -5,25 +5,44 @@ import { Command } from "commander";
 import { confirmOrCancel } from "../utils/command-helpers.js";
 import { runCommand } from "../utils/errors.js";
 import { findProjectRoot } from "../utils/paths.js";
+// Same location `tdk up` hands to Tilt (see getTiltfilePath in utils/tilt.ts), relative to the project root.
+export const TILTFILE_RELATIVE_PATH = ".tdk/.tdk-out/Tiltfile";
+export const TILT_UP_COMMAND = `tilt up -f ${TILTFILE_RELATIVE_PATH} -- --focus=<stack>`;
 export const EJECTED_CONTENT = `# Ejected from TDK
 
-These files were generated by TDK. You can keep using Docker and Tilt without the tdk CLI.
+\`tdk eject\` wrote this file and nothing else. It did not copy, move or generate anything, and it did
+not remove TDK. What exists is what TDK had already generated, and that is still TDK-owned output.
 
-Keep:
-- Tiltfile
-- Dockerfiles
-- compose files TDK wrote
-- Traefik / proxy config TDK wrote
+## Where the generated files are
 
-Optional to delete later:
-- .tdk/
-- service.json files (only if you no longer want tdk up)
+- \`.tdk/.tdk-out/\` holds the Tiltfile and the engine it loads (\`tdk-cli-ext/\`). It is git-ignored.
+  \`tdk config regenerate\` rewrites the master files in it.
+- The per-service Compose files (\`services/<stack>/<name>/.autogenerated/\`), the golden-layer
+  Dockerfile and the Traefik file (\`.tdk/.tdk-out/\`) are written by Tilt when it runs, not by
+  \`tdk eject\`. Until Tilt has run they do not exist. They are git-ignored too.
+- Your own Dockerfiles, \`service.json\` files and source code are untouched.
 
-To go back: install TDK and run \`tdk config regenerate\`.
+## Running the stack without the tdk CLI
+
+There is no Tiltfile at the project root, so a plain \`tilt up\` does not find one. TDK runs:
+
+    ${TILT_UP_COMMAND}
+
+from the project root (\`<stack>\` is a stack name under \`services/\`; without \`--focus\` the Tiltfile
+falls back to its default phase). The Tiltfile still reads \`.tdk/project.json\` and the
+\`service.json\` files, so those must stay. \`tdk up\` also does steps before Tilt starts (it chooses
+host ports and exports them to Tilt); running Tilt by hand skips them.
+
+## Cleaning up
+
+Optional to delete later: this file, and \`.tdk/\` plus the \`service.json\` files if you stop using TDK.
+Deleting them also removes what the Tiltfile needs.
+
+To go back to TDK: install it and run \`tdk config regenerate\`.
 `;
 export const ejectCommand = new Command("eject")
-    .description("Take ownership of the generated Tilt and Docker files")
-    .option("--dry-run", "List generated files without changing the project", false)
+    .description("Write EJECTED.md describing the generated Tilt files (copies and generates nothing; they stay in .tdk/.tdk-out/)")
+    .option("--dry-run", "List the generated files and what would be written, without changing the project", false)
     .option("--yes", "Skip the confirmation prompt", false)
     .action(async (options) => {
     await runCommand(async () => {
@@ -48,15 +67,19 @@ export const ejectCommand = new Command("eject")
             throw new Error("Generated Tilt files are missing. Run `tdk project --yes` before ejecting.");
         }
         const rootTiltfile = join(projectRoot, "Tiltfile");
-        if (existsSync(rootTiltfile))
-            files.push("Tiltfile");
+        const userTiltfile = existsSync(rootTiltfile) ? ["Tiltfile"] : [];
         const ejectedPath = join(projectRoot, "EJECTED.md");
         const willCreate = existsSync(ejectedPath) ? [] : ["EJECTED.md"];
         if (options.dryRun) {
-            console.log("Files kept:");
+            console.log("Generated files, left where they are (git-ignored):");
             for (const path of files)
                 console.log(`  ${path}`);
-            console.log("Files created:");
+            if (userTiltfile.length > 0) {
+                console.log("Root Tiltfile, left where it is (not generated, not git-ignored):");
+                for (const path of userTiltfile)
+                    console.log(`  ${path}`);
+            }
+            console.log("Files written:");
             for (const path of willCreate)
                 console.log(`  ${path}`);
             if (willCreate.length === 0)
@@ -64,13 +87,19 @@ export const ejectCommand = new Command("eject")
             return;
         }
         if (!options.yes &&
-            !(await confirmOrCancel("Take ownership of the generated Tilt and Docker files?"))) {
+            !(await confirmOrCancel("Write EJECTED.md? (Generated files stay in .tdk/.tdk-out/; nothing is copied or moved.)"))) {
             return;
         }
-        if (!existsSync(ejectedPath))
+        if (existsSync(ejectedPath)) {
+            console.log(chalk.green("EJECTED.md already exists and was left unchanged. Nothing was copied, moved or generated."));
+        }
+        else {
             writeFileSync(ejectedPath, EJECTED_CONTENT, { flag: "wx" });
-        console.log(chalk.green("Ejected. Tilt and Docker files are yours."));
-        console.log("Next: tilt up");
+            console.log(chalk.green("Wrote EJECTED.md. Nothing was copied, moved or generated."));
+        }
+        console.log("Generated files stay in .tdk/.tdk-out/ (git-ignored) and still need TDK inputs.");
+        console.log(`Run from the project root: ${TILT_UP_COMMAND}`);
+        console.log("Replace <stack> with a stack name under services/, or omit --focus to use the Tiltfile's default phase.");
         console.log("Read EJECTED.md");
     });
 });

package/cli/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tdk-cli-internal",
   "private": true,
-  "version": "1.3.111",
+  "version": "1.3.113",
   "description": "TDK CLI — start services on your laptop.",
   "keywords": [
     "tdk",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tdk-landscape/tdk-cli-core",
-  "version": "1.3.111",
+  "version": "1.3.113",
   "description": "TDK CLI — start services on your laptop.",
   "homepage": "https://tdk-landscape.github.io/tdk-website",
   "repository": {