Skip to content

feat(nextly): warn at boot when a plugin ships without a description - #762

Merged
mobeenabdullah merged 2 commits into
mainfrom
feat/plugin-description-check
Aug 13, 2026
Merged

mobeenabdullah merged 2 commits into
mainfrom
feat/plugin-description-check

Conversation

@mobeenabdullah

Copy link
Copy Markdown
Collaborator

T-21. A plugin with no admin.description is one the admin can only ever show by its package specifier — @nextlyhq/plugin-page-builder where another plugin shows "Build pages visually from blocks". The reader is left inferring the purpose from a name chosen for npm rather than for them.

Two corrections to the task note first

The tracker said this check "belongs beside the other plugin doctor diagnostics in packages/nextly". There is no doctor. nextly plugins has list and info and nothing else, and no diagnostics command exists anywhere in the repo. So the check needed a home rather than a neighbour.

It also said the plan "fills in the two first-party plugins that ship without a description". All three already have one — page-builder, form-builder and seo. So this PR fixes no plugin; its entire value is stopping the omission recurring, which is exactly what the note said was missing.

Where the check lives, and why not the alternatives

A boot warning, emitted beside the line that already names the registered plugins — because that line is the symptom: it is where a nameless plugin first shows up as a bare package specifier.

  • Not an error. The omission is the plugin author's, it breaks nothing at runtime, and an operator cannot fix a third-party package from their own config. Failing their boot over someone else's missing string is punishment, not a control.
  • Not type-level required. That is the real "cannot ship without one" boundary, and it is a breaking change for every existing third-party plugin. Worth doing deliberately rather than as a side effect of this task — flagging it rather than taking it.
  • Not a CLI-only report. nextly plugins list is opt-in; the omission should surface to the person who will see its consequence, which is whoever boots the app.

Shape

pluginsMissingDescription(plugins) is pure and returns names, so the same question asked from a boot warning, a future CLI report or a test cannot become three answers. warnUndescribedPlugins(plugins, logger) takes the logger rather than reaching for one.

That second function exists for a specific reason. Wiring that lives only as a call site inside a several-hundred-line registration function can be deleted without any test noticing — I hit exactly that on #747, where removing a guard's call left every test on the guard itself green. Passing the logger puts the message under test.

Tests

Nine cases. The ones that matter:

  • empty string and whitespace count as missing — a present-but-useless value satisfies both !== undefined and an optional chain, so a test covering only "absent" passes on an implementation that admits "";
  • the warning names the undescribed plugins and not the described one — without that last assertion, a message listing every plugin would pass;
  • silence when every plugin declares one, since a warning on every boot of a correct install trains an operator to ignore the one that matters.

Break-verified: warning on every plugin instead of the undescribed ones fails two tests.

Note

packages/nextly/src/plugins/schema/caching.test.ts fails 2 tests here and on origin/main alike — pre-existing, unrelated call path.

Without one the admin can only show the package specifier wherever it lists that
plugin, so a reader sees a name chosen for npm rather than for them. Warned
rather than thrown: the omission is the plugin author's, it breaks nothing at
runtime, and an operator cannot fix a third-party package from their config.
Boot wiring inside a several-hundred-line registration function can be deleted
without any test noticing. Taking the logger rather than reaching for one puts
the message under test, which is the part worth pinning.
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@mobeenabdullah, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 11 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: a7c92b8f-41db-4fff-8d8f-d02d244011c6

📥 Commits

Reviewing files that changed from the base of the PR and between e344e47 and 99e92b0.

⛔ Files ignored due to path filters (1)
  • .changeset/plugin-description-check.md is excluded by !.changeset/**
📒 Files selected for processing (3)
  • packages/nextly/src/di/register.ts
  • packages/nextly/src/plugins/describe-check.test.ts
  • packages/nextly/src/plugins/describe-check.ts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mobeenabdullah

Copy link
Copy Markdown
Collaborator Author

@codex please review this PR

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Bravo.

Reviewed commit: 99e92b090b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@mobeenabdullah
mobeenabdullah merged commit e24638c into main Aug 13, 2026
9 checks passed
@github-actions github-actions Bot added scope: core nextly type: docs Documentation only labels Aug 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope: core nextly type: docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant