refactor: remove obsolete `shortPath` property #33384

KazariEX · 2025-10-03T11:30:37Z

🔗 Linked issue

📚 Description

It seems that this property has become obsolete.

bolt-new-by-stackblitz · 2025-10-03T11:30:42Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-10-03T11:33:31Z

Walkthrough

The changes remove the shortPath property from the Component interface and from runtime construction/usage. scanComponents no longer accepts a srcDir parameter and no longer computes or returns shortPath. The AddComponentOptions type was loosened to no longer exclude shortPath, while normalizeComponent no longer sets a shortPath value. Multiple tests and callers (including the Nuxt module) were updated to drop shortPath usage and to call scanComponents with the new single-argument signature.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly summarises the primary change by indicating removal of the obsolete shortPath property and follows a clear conventional commit style without unnecessary details. It accurately reflects the core refactor performed across code and tests. Consequently, it meets the criteria for a descriptive and concise pull request title.
Description Check	✅ Passed	Although brief, the description directly relates to the removal of the obsolete shortPath property and provides the rationale for the change. It is on-topic and references the property under modification without being generic or off-topic. Therefore, it satisfies the lenient relevance criteria for a pull request description.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 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 20d61be and c36db2e.

📒 Files selected for processing (4)

packages/nuxt/src/components/module.ts (1 hunks)
packages/nuxt/src/components/scan.ts (1 hunks)
packages/nuxt/test/scan-components.test.ts (1 hunks)
packages/schema/src/types/components.ts (0 hunks)

💤 Files with no reviewable changes (1)

packages/schema/src/types/components.ts

🚧 Files skipped from review as they are similar to previous changes (2)

packages/nuxt/src/components/scan.ts
packages/nuxt/src/components/module.ts

🧰 Additional context used

📓 Path-based instructions (2)

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

packages/nuxt/test/scan-components.test.ts

**/*.{test,spec}.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Write unit tests for core functionality using vitest

Files:

packages/nuxt/test/scan-components.test.ts

🧬 Code graph analysis (1)

packages/nuxt/test/scan-components.test.ts (1)

packages/nuxt/src/components/scan.ts (1)

scanComponents (22-169)

🔇 Additional comments (1)

packages/nuxt/test/scan-components.test.ts (1)

233-233: LGTM! Test correctly updated to match new API.

The function call has been properly updated to use the new single-argument scanComponents(dirs) signature, which aligns with the removal of the obsolete shortPath property. The expected components (lines 86-230) correctly omit shortPath, and the deep equality assertion at line 240 implicitly verifies its absence from the scanned results.

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.}

pkg-pr-new · 2025-10-03T11:35:03Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@33384

nuxt

npm i https://pkg.pr.new/nuxt@33384

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@33384

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@33384

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@33384

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@33384

commit: c36db2e

codspeed-hq · 2025-10-03T11:45:12Z

CodSpeed Performance Report

Merging #33384 will not alter performance

_{Comparing KazariEX:refactor/remove-short-path (c36db2e) with main (94e6fbb)¹}

Summary

✅ 10 untouched

No successful run was found on main (7f48766) during the generation of this report, so 94e6fbb was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

…-path

danielroe · 2025-10-07T19:30:51Z

packages/kit/src/components.ts

    prefetch: false,
    preload: false,


these are also unused (currently)

It seems also be used by webpack builder.

you are quite right

danielroe · 2025-10-07T19:31:14Z

packages/kit/src/components.ts

  // Apply defaults
  const component: Component = {
    export: opts.export || 'default',
    chunkName: 'components/' + kebabCase(opts.name),


this is only used by webpack builder - support could likely be added in vite

This reverts commit df559ad.

refactor: remove obsolete shortPath property

20d61be

KazariEX requested a review from danielroe as a code owner October 3, 2025 11:30

github-actions bot added 4.x refactor labels Oct 3, 2025

Merge remote-tracking branch 'origin/main' into refactor/remove-short…

c36db2e

…-path

danielroe reviewed Oct 7, 2025

View reviewed changes

danielroe merged commit df559ad into nuxt:main Oct 7, 2025
51 checks passed

KazariEX deleted the refactor/remove-short-path branch October 7, 2025 19:57

github-actions bot mentioned this pull request Oct 7, 2025

v4.2.0 #33425

Merged

danielroe added a commit that referenced this pull request Oct 9, 2025

fix(nuxt): add back shortPath property (#33384)

2958d14

This reverts commit df559ad.

github-actions bot mentioned this pull request Oct 23, 2025

v5.0.0 #33548

Closed

danielroe pushed a commit that referenced this pull request Oct 25, 2025

refactor: remove obsolete shortPath property (#33384)

f473e64

danielroe added a commit that referenced this pull request Oct 25, 2025

fix(nuxt): add back shortPath property (#33384)

7543fad

This reverts commit df559ad.

github-actions bot mentioned this pull request Oct 25, 2025

v3.20.0 #33566

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

refactor: remove obsolete `shortPath` property #33384

refactor: remove obsolete `shortPath` property #33384

Uh oh!

KazariEX commented Oct 3, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Oct 3, 2025

Uh oh!

coderabbitai bot commented Oct 3, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 3, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Oct 3, 2025 •

edited

Loading

Uh oh!

danielroe Oct 7, 2025

Uh oh!

KazariEX Oct 7, 2025 •

edited

Loading

Uh oh!

danielroe Oct 7, 2025

Uh oh!

danielroe Oct 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

refactor: remove obsolete shortPath property #33384

refactor: remove obsolete shortPath property #33384

Uh oh!

Conversation

KazariEX commented Oct 3, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Oct 3, 2025

Uh oh!

coderabbitai bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

pkg-pr-new bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #33384 will not alter performance

Summary

Footnotes

Uh oh!

danielroe Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

KazariEX Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

danielroe Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

danielroe Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

refactor: remove obsolete `shortPath` property #33384

refactor: remove obsolete `shortPath` property #33384

coderabbitai bot commented Oct 3, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 3, 2025 •

edited

Loading

codspeed-hq bot commented Oct 3, 2025 •

edited

Loading

KazariEX Oct 7, 2025 •

edited

Loading