Repository navigation
Rename the format plugin crates: forge-format-api and FormatSpec - #896
Merged
Merged
Conversation
github-merge-queue
Bot
removed this pull request from the merge queue due to a conflict with the base branch
Nov 4, 2026
schmitch
force-pushed
the
claude/rename-format-spec
branch
3 times, most recently
from
November 4, 2026 07:01
2b9b05b to
4f7d2c6
Compare
schmitch
enabled auto-merge
November 4, 2026 07:02
Formats are crates linked into the server, not plugins, so the names say
so:
- `crates/plugin-api` (`forge-plugin-api`) is `crates/format-api`
(`forge-format-api`), and its trait `FormatPlugin` is `FormatSpec`.
- `crates/plugin` (`forge-plugin`) is gone: its adapter, `PluginFormat`,
is `forge_core::format::SpecFormat`, and its descriptor checks are
`forge_core::format::descriptor`. forge-core already depended on the
contract crate, and its tests no longer need a dev-dependency cycle.
- The server's `plugins` module is `formats`, its registry's
`plugin(s)`/`with_plugin(s)`/`images_plugin` are `spec(s)`,
`with_spec(s)`, `images_spec`, and `tests/plugin_contract.rs` is
`tests/format_contract.rs`.
- Comments, docs and AGENTS.md say "format" or "format crate". The
internal-error text and one log line follow ("format failed", the field
`format`).
Kept: the telemetry surfaces `plugin_npm`, `plugin_raw` and
`plugin_other`, which dashboards and alerts select on, and the file name
of docs/format-plugins.md (now titled "Format crates"), which CHANGELOG.md
links to.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012e6DJXVot5LKkJJWpxY1bT
schmitch
force-pushed
the
claude/rename-format-spec
branch
from
November 4, 2026 07:28
4f7d2c6 to
455ed56
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No issue asks for this. It follows #884: formats are crates linked into the server, not plugins, so the names now say so.
Renamed
crates/plugin-api(forge-plugin-api)crates/format-api(forge-format-api)FormatPluginFormatSpeccrates/plugin(forge-plugin)forge-coreforge_plugin::PluginFormat,UploadFormatforge_core::format::SpecFormat,UploadFormatforge_plugin::descriptor::checkforge_core::format::descriptor::checkplugins(plugins.rs)formats(formats.rs)plugin(),plugins(),with_plugin(s),images_plugin()spec(),specs(),with_spec(s),images_spec()tests/plugin_contract.rstests/format_contract.rsFolding the adapter into
forge-coreis safe: core already depended on the contract crate. Core's tests also no longer need the dev-dependency cycle throughforge-plugin.AGENTS.md's rule "no
crates/format-<id>" now says thatcrates/format-apiis the contract, not a format.docs/format-plugins.mdalso drops its last "Contract 0.4.0".Changes visible outside the code
format failedinstead offormat plugin failed. That text is not part of any client protocol, and no test asserts it.formatinstead ofplugin.Kept on purpose
plugin_npm,plugin_rawandplugin_other, withplugin_surfaceandSurface::Plugin*.docs/deployment.mddocuments these metric values, and dashboards and alerts select on them; the doc comment now says why they keep the name.docs/format-plugins.md, now titled "Format crates".CHANGELOG.mdlinks to it and to its#files-formatsand#images-formatsanchors, and changes never editCHANGELOG.md.nuget-plugin-forge(NuGet's credential provider), the config test of the removed[plugins]section, Vite's and Verdaccio's plugins, and the CSP's "no plugins".Checks
Rebased on
mainat 388fb93, after #881, #895, #897 and #890:the names those added (
summary_caps,FilePackage, the streamed index building) are renamed too;Remove unused code and dependencies #890's dependency removals are kept.
cargo fmt --all --checkpasses.cargo clippy --workspace --all-targets -- -D warningspasses; it builds every integration test too.Unit tests pass with
--locked:forge-format-api, the five format crates andforge-telemetry: 317 passed;forge-core --lib: 373 passed;forge-server --lib: 291 passed;format_contract::the_probe_is_a_valid_format: passed.Web:
tsc --noEmitpasses, and Vitest passes (625 tests).cargo xtask docs --checkandcargo xtask changelog --checkpass.Not run locally: the server and core integration tests, which need Postgres and S3. CI runs them, and they were green on the previous head.
🤖 Generated with Claude Code
https://claude.ai/code/session_012e6DJXVot5LKkJJWpxY1bT