Skip to content

The package lives at packages/framework: the project is The Framework, the package is one thing it contains (#1665) - #1670

Merged
suleimansh merged 1 commit into
mainfrom
rename-packages-framework
Aug 23, 2026
Merged

The package lives at packages/framework: the project is The Framework, the package is one thing it contains (#1665)#1670
suleimansh merged 1 commit into
mainfrom
rename-packages-framework

Conversation

@suleimansh

Copy link
Copy Markdown
Contributor

🤖 automated

Closes #1665 — Rom's ask on Discord: "Project === The Framework. Contains framework (dashboard) + things like sdd.md. So packages/framework."

What this is

A directory move, in one commit so git log --follow stays intact (checked: daemon.ts still shows its 88 commits through the move): git mv packages/the-framework packages/framework. Every SPEC.md moves beside its file. 1112 files touched, 16 lines actually changed.

The npm name was already framework, so the published package does not change. What keeps its name: the CLI binary the-framework, the .the-framework/ runtime directory, the-framework.yml, the repo URL github.com/framework/the-framework, the root package.json "name": "the-framework" (the monorepo is the project), and the website package packages/the-framework.ai.

The path references rewritten

The issue's list, plus two it missed:

  • root package.json — the build/preview/dev/typecheck/clean/test scripts
  • .gitignorepackages/framework/src/prompts.generated.ts and its comment
  • packages/framework/package.jsonhomepage, repository.directory
  • pnpm-lock.yaml — the workspace importer key, rewritten by pnpm install (that is the whole lockfile diff)
  • src/daemon.test.ts:585,597 — the nesting example (cosmetic)
  • not in the issue: packages/chrome-extension/check.mjs:19 resolves jsdom from ../the-framework../framework (its check suite still passes)
  • not in the issue: the two SPEC lines that name the directory, below

The workflows (ci.yml, framework-agent.yml) never name the path — nothing to change there.

SPEC.md changes

Two prose lines, both in the directory listings at the top of the tree. No business logic changes; FEATURES-SPEC.md untouched (not a feature).

SPEC.md (root — "what does this software do" + how the top-level subsystems relate)

-- `packages/the-framework` — the product itself, published as the npm package `framework`: …
+- `packages/framework` — the product itself, published as the npm package `framework`: …

packages/SPEC.md (the packages directory listing)

-- `the-framework/` — the product: the `framework` npm package (CLI, daemon, agent lifecycle, dashboard).
+- `framework/` — the product: the `framework` npm package (CLI, daemon, agent lifecycle, dashboard).

Verified

Locally, the exact CI sequence at the new path: pnpm install (offline, lockfile key only) → pnpm buildpnpm typecheck (both packages) → pnpm test — 1581 daemon tests + 803 dashboard tests, all green.

After merge

Every clone: git pull moves the directory; a running daemon keeps serving from the moved inode but should be restarted from packages/framework after the next pnpm build. Stale dist-test under the old path, if any, is just a leftover to rm -rf.

…, the package is one thing it contains (#1665)

A directory move, nothing else: `git mv packages/the-framework packages/framework`, every
SPEC.md moving beside its file. The npm name was already `framework`; the CLI (`the-framework`),
the `.the-framework/` runtime directory, `the-framework.yml`, the repo URL and the website package
`packages/the-framework.ai` keep their names.

Path references rewritten: the root package.json scripts, .gitignore (prompts.generated.ts),
the package's homepage + repository.directory, the pnpm-lock importer key (via pnpm install),
the nesting example in daemon.test.ts, the chrome extension's jsdom resolve path in check.mjs,
and the two SPEC lines naming the directory (root SPEC.md, packages/SPEC.md).

Closes #1665
@suleimansh
suleimansh merged commit 57611ca into main Aug 23, 2026
2 checks passed
@suleimansh
suleimansh deleted the rename-packages-framework branch August 23, 2026 18:50
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.

Rename packages/the-framework to packages/framework

1 participant