Skip to content

feat: add more info in templates - #1774

Merged
danielroe merged 9 commits into
nuxt:templatesfrom
maximepvrt:update-template
Jul 18, 2026
Merged

feat: add more info in templates#1774
danielroe merged 9 commits into
nuxt:templatesfrom
maximepvrt:update-template

Conversation

@maximepvrt

Copy link
Copy Markdown
Contributor

🔗 Linked issue

nuxt/nuxt.new#492

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

@maximepvrt
maximepvrt requested a review from danielroe as a code owner February 8, 2026 17:40
@coderabbitai

coderabbitai Bot commented Feb 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 16 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0562b986-bd2c-4d8c-a65a-5ec47b0526cc

📥 Commits

Reviewing files that changed from the base of the PR and between 2d5ef43 and 5d950b0.

📒 Files selected for processing (1)
  • scripts/validate-templates.mjs
📝 Walkthrough

Walkthrough

Multiple template JSON manifests now include explicit repo and branch source metadata, with several also marked deprecated. A new JSON Schema defines valid manifest structure and field validation, and a validator runs in CI for template branch pushes and pull requests. Content, minimal, module, and UI templates receive updated descriptions, labels, images, URLs, defaults, or source branches. No runtime code changes were made.

Estimated code review effort: 3 (Moderate) | ~25 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is related to template manifest updates, but "add more info" is too vague to convey the specific change. Mention the main change more specifically, e.g. adding schema, repo/branch, label, image, and deprecation metadata to templates.
Description check ❓ Inconclusive The description is mostly boilerplate and a linked issue, but it does not actually describe the implemented template metadata changes. Summarize the actual changes in the PR body, such as the added metadata fields, new schema, and template validation workflow.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@danielroe danielroe changed the title Update templates for nuxt.new #492 feat: add more info in templates Apr 27, 2026

@danielroe danielroe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Comment thread templates/layer.json
@@ -1,7 +1,10 @@
{
"name": "layer",
"deprecated": true,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is layer deprecated? 🤔

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the idea was to generate a new API shared by both nuxt.new and the CLI, I have harmonized the deprecated status with this hidden attribute: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/utils/starter-templates.ts#L4

Comment thread templates/ui-vue.json
@@ -1,7 +1,10 @@
{
"name": "ui-vue",
"deprecated": true,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This starter is still working!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the idea was to generate a new API shared by both nuxt.new and the CLI, I have harmonized the deprecated status with this hidden attribute: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/utils/starter-templates.ts#L4

@maximepvrt
maximepvrt requested a review from danielroe May 18, 2026 09:35
@maximepvrt

Copy link
Copy Markdown
Contributor Author

@HugoRCD @benjamincanac @danielroe 👀

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@template.schema.json`:
- Line 7: Make the source metadata contract explicit: in template.schema.json:7
require repo and branch alongside name and tar, and in
template.schema.json:50-57 add validation or CI checking that these fields match
the tarball coordinates. In templates/v5-nightly.json:2-7 add repo
"nuxt/starter" and branch "v5-nightly" to match nuxt/starter:v5-nightly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5eb154c1-9828-4d73-b549-f15dda252032

📥 Commits

Reviewing files that changed from the base of the PR and between b287d45 and 50e7362.

📒 Files selected for processing (26)
  • template.schema.json
  • templates/community/sidebase.json
  • templates/content.json
  • templates/doc-driven.json
  • templates/hub.json
  • templates/layer.json
  • templates/minimal.json
  • templates/module-devtools.json
  • templates/module.json
  • templates/ui-vue.json
  • templates/ui-vue/chat.json
  • templates/ui-vue/dashboard.json
  • templates/ui.json
  • templates/ui/changelog.json
  • templates/ui/chat.json
  • templates/ui/dashboard.json
  • templates/ui/docs.json
  • templates/ui/editor.json
  • templates/ui/landing.json
  • templates/ui/portfolio.json
  • templates/ui/saas.json
  • templates/v2-bridge.json
  • templates/v3.json
  • templates/v4-compat.json
  • templates/v4.json
  • templates/v5-nightly.json
🚧 Files skipped from review as they are similar to previous changes (18)
  • templates/ui/editor.json
  • templates/layer.json
  • templates/ui/dashboard.json
  • templates/v2-bridge.json
  • templates/ui-vue/chat.json
  • templates/v4.json
  • templates/ui/landing.json
  • templates/hub.json
  • templates/module-devtools.json
  • templates/ui-vue/dashboard.json
  • templates/ui/portfolio.json
  • templates/v4-compat.json
  • templates/ui-vue.json
  • templates/doc-driven.json
  • templates/ui/changelog.json
  • templates/v3.json
  • templates/ui/saas.json
  • templates/minimal.json

Comment thread template.schema.json Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@scripts/validate-templates.mjs`:
- Around line 20-45: Update the validation flow in
scripts/validate-templates.mjs to reject a null or non-object parsed template
before iterating its keys, reporting it through fail instead of crashing. Also
enforce each schema.properties entry’s declared type, including top-level
schema.type, and call fail with a clear key/value type error when a value such
as string "false" violates the schema; preserve the existing required-key and
pattern checks for valid objects.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b9425612-3a64-4c43-a435-4716014be738

📥 Commits

Reviewing files that changed from the base of the PR and between 50e7362 and 2d5ef43.

📒 Files selected for processing (5)
  • .github/workflows/validate-templates.yml
  • scripts/validate-templates.mjs
  • template.schema.json
  • templates/community/sidebase.json
  • templates/v5-nightly.json
🚧 Files skipped from review as they are similar to previous changes (2)
  • template.schema.json
  • templates/community/sidebase.json

Comment thread scripts/validate-templates.mjs
@danielroe
danielroe merged commit c593554 into nuxt:templates Jul 18, 2026
4 checks passed
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.

3 participants