Skip to content

fix(server): stop telling generated projects to link the framework via yalc - #119

Merged
DKoenig9 merged 1 commit into
mainfrom
fix/server-readme-link-section
Sep 23, 2026
Merged

DKoenig9 merged 1 commit into
mainfrom
fix/server-readme-link-section

Conversation

@DKoenig9

Copy link
Copy Markdown
Contributor

Why

lt server create writes the project's README.md from src/templates/nest-server-starter/README.md.ejs. Its "Test & debug the NestServer package" section still described yalc and npm run watch. nest-server-starter dropped that way long ago. Today it uses pnpm run link:nest-server / unlink:nest-server, and their implementation is currently being ported to Node.

In vendor mode (lt server create --framework-mode vendor) the same section was not merely stale but meaningless. There is no @lenne.tech/nest-server package to link, because the core is in src/core/.

lt fullstack init does not render this template and keeps the starter's own README.

What changed

  • npm mode: clone, then pnpm run link:nest-server, then pnpm run unlink:nest-server. The README names the scripts but says nothing about how they work, so the Node port cannot make it stale again.
  • vendor mode: a "Working on the framework core" section. It points at src/core/VENDOR.md, says project code belongs outside src/core/, and names /lt-dev:backend:update-nest-server-core and /lt-dev:backend:contribute-nest-server-core.
  • setupServer passes vendor: frameworkMode === 'vendor' into the template.

Test

__tests__/server-readme-template.test.ts renders both modes and checks that setupServer passes the mode into the template. Mutations:

Mutation Result
vendor prop not passed 1 red
vendor branch never taken 1 red
old yalc text restored 2 red

npm test: 79 suites, 1215 tests. Lint and tsc are clean.

Not covered here: the lt-dev plugin's contributing-to-lt-framework skill describes a third way (pnpm link --global). That lives in the plugin repo and has been reported there.

🤖 Generated with Claude Code

…a yalc

`lt server create` writes README.md from `nest-server-starter/README.md.ejs`.
Its "Test & debug the NestServer package" section still described yalc and
`npm run watch`, a way nest-server-starter dropped long ago. In vendor mode
the section was meaningless, not merely stale: there is no
`@lenne.tech/nest-server` package to link, the core lives in `src/core/`.

- npm mode names only the starter's `link:nest-server` / `unlink:nest-server`
  scripts. Their names are stable, their implementation is being ported to
  Node, so the README says nothing about how they work.
- vendor mode points at `src/core/VENDOR.md`, the modification policy and the
  update / contribute commands instead.
- `setupServer` passes `vendor` into the template. `lt fullstack init` does
  not render this template and is unaffected.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@DKoenig9
DKoenig9 marked this pull request as ready for review September 23, 2026 09:37
@DKoenig9
DKoenig9 merged commit 89713a3 into main Sep 23, 2026
2 checks passed
@DKoenig9
DKoenig9 deleted the fix/server-readme-link-section branch September 23, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant