Skip to content

fix: generate unique component id #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2025
Merged

fix: generate unique component id #538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/plugin-vue/src/utils/descriptorCache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export function createDescriptor(

// ensure the path is normalized in a way that is consistent inside
// project (relative to root) and on different systems.
const normalizedPath = normalizePath(path.relative(root, filename))
const normalizedPath = normalizePath(filename)

const componentIdGenerator = features?.componentIdGenerator
if (componentIdGenerator === 'filepath') {
Expand All @@ -49,7 +49,7 @@ export function createDescriptor(
descriptor.id = getHash(normalizedPath + source)
} else if (typeof componentIdGenerator === 'function') {
descriptor.id = componentIdGenerator(
normalizedPath,
normalizePath(path.relative(root, filename)),
Copy link
Member Author

Choose a reason for hiding this comment

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

Here perserve the relative path to avoid break change, if the user using it, it should be make sure the unique compoenent id.

The relate test is playground/vue-custom-id/__tests__/vue-custom-id.spec.ts. it using component id to generate attr <h1 data-v-components-foo="">Foo</h1>'.
Copy link

Choose a reason for hiding this comment

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

This change is breaking my tests, now...

The documentation clearly states that componentIdGenerator='filepath', which I presume is the default, "hash the file path (relative to the project root)" should use the relative path.

Yet the change clearly uses the relative path only in the componentIdGenerator='function' case.

The component ids generated on my machine are thus no longer matching the component ids generated in my CI.
source,
isProduction,
getHash,
Expand Down