Skip to content

Conversation

Simlor
Copy link
Contributor

@Simlor Simlor commented Sep 15, 2025

Minor documentation update noting that in Nuxt 4, the default stores folder has been moved to the app directory.

Summary by CodeRabbit

  • Documentation
    • Clarified Auto imports note for Nuxt 4: stores are located in the app/stores directory (not project root).
    • Helps users find and auto-import stores correctly when migrating or setting up Nuxt 4 projects.
    • Documentation-only update; no behavioral or API changes.

Copy link

coderabbitai bot commented Sep 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation change in packages/docs/ssr/nuxt.md: the Auto imports section now specifies that for Nuxt 4 the stores folder is under app/stores (instead of the project root). No behavioral or public API changes.

Changes

Cohort / File(s) Summary
Docs: Nuxt SSR (Auto imports note)
packages/docs/ssr/nuxt.md
Added Nuxt 4-specific note that the stores folder is located at app/stores rather than the project root; no other content or behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A nibble of docs beneath the stars,
I hop through lines and tidy pars.
"From root to app," I cheer and prance,
A clearer path for every glance.
Puffed whiskers, happy—docs enhanced. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Added note about new location for "stores" folder in Nuxt 4." directly and concisely describes the primary change in the PR—a documentation update noting the Nuxt 4 stores folder relocation—and is specific enough for teammates scanning the history. It is focused, relevant to the modified file, and avoids vague phrasing.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6e1bca and f5a20ad.

📒 Files selected for processing (1)
  • packages/docs/ssr/nuxt.md (1 hunks)

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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 and usage tips.

Copy link

netlify bot commented Sep 15, 2025

Deploy Preview for pinia-official ready!

Name Link
🔨 Latest commit f5a20ad
🔍 Latest deploy log https://app.netlify.com/projects/pinia-official/deploys/68c8034641d1b90008994418
😎 Deploy Preview https://deploy-preview-3047--pinia-official.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/docs/ssr/nuxt.md (1)

93-93: Clarify Nuxt 4 stores placement & fix wording (packages/docs/ssr/nuxt.md: line 93)

Nuxt 4 does not mandate moving a stores folder — Pinia auto‑imports from a default ./stores at the project root and supports configuring pinia.storesDirs (e.g. ./app/stores/**). Replace the “moved” implication and fix “lookup” → “look up”.

-It also automatically imports **all stores** defined within your `stores` folder (note that in Nuxt 4, this folder has been moved from the project root directory to the `app` directory). It doesn't lookup for nested stores though. You can customize this behavior by setting the `storesDirs` option:
+It also automatically imports **all stores** defined within your `stores` folder. In Nuxt 4, the default `srcDir` is `app/` and `~/` (`@/`) resolves there; if you place your stores under `app/stores`, configure `pinia.storesDirs` accordingly. It doesn't look up nested stores. You can customize this behavior by setting the `storesDirs` option:

Recommended example update:

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@pinia/nuxt'],
  pinia: {
    // Support both root-level and app/ placement
    storesDirs: ['./stores/**', './app/stores/**'],
  },
})
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 57bec95 and f6e1bca.

📒 Files selected for processing (1)
  • packages/docs/ssr/nuxt.md (1 hunks)

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

Thanks!

@posva posva merged commit eece5c1 into vuejs:v3 Sep 15, 2025
3 of 5 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.

2 participants