Skip to content
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.

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

fix: fixed an error in the vue component editor #10293

Merged
merged 3 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/integrations/vue/src/editor.cts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ export function toTSX(code: string, className: string): string {
const { scriptSetup } = parsedResult.descriptor;

if (scriptSetup) {
const definePropsType = scriptSetup.content.match(/defineProps<([\s\S]+?)>\s?\(\)/);
const codeWithoutComments = scriptSetup.content.replace(/\/\/.*|\/\*[\s\S]*?\*\//g, '');
const definePropsType = codeWithoutComments.match(/defineProps<([\s\S]+?)>\s?\(\)/);
const propsGeneric = scriptSetup.attrs.generic;
const propsGenericType = propsGeneric ? `<${propsGeneric}>` : '';

Expand All @@ -40,20 +41,19 @@ export function toTSX(code: string, className: string): string {
// TODO. Find a way to support generics when using defineProps without passing explicit types.
// Right now something like this `defineProps({ prop: { type: Array as PropType<T[]> } })`
// won't be correctly typed in Astro.
const defineProps = scriptSetup.content.match(/defineProps\([\s\S]+\)/);

const defineProps = codeWithoutComments.match(/defineProps\([\s\S]+?\)/);
if (defineProps) {
result = `
import { defineProps } from '@vue/runtime-core';
import { defineProps } from 'vue';
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason @vue/runtime-core is changed to vue. We should also remove the indent changes

Copy link
Member

Choose a reason for hiding this comment

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

Would love to know this as well, I remember purposely using @vue/runtime-core instead of vue. IIRC it's not quite the same function. (though now I do wonder if this worked on pnpm since it's not a direct dep?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In my case with pnpm, I found that @vue/runtime-core might not be installed, In order to ensure the correct import of defineProps, I changed it to vue because it will be installed.

Copy link
Contributor Author

@phk422 phk422 Mar 5, 2024

Choose a reason for hiding this comment

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

Would love to know this as well, I remember purposely using @vue/runtime-core instead of vue. IIRC it's not quite the same function. (though now I do wonder if this worked on pnpm since it's not a direct dep?)

I tested it with npm and pnpm, just as you thought, it's not directly dependent on pnpm.


${regularScriptBlockContent}
${regularScriptBlockContent}

const Props = ${defineProps[0]}
const Props = ${defineProps[0]}

export default function ${className}__AstroComponent_${propsGenericType}(_props: typeof Props): any {
<div></div>
}
`;
export default function ${className}__AstroComponent_${propsGenericType}(_props: typeof Props): any {
<div></div>
}
`;
}
}
}
Expand Down
45 changes: 45 additions & 0 deletions packages/integrations/vue/test/toTsx.test.cts
phk422 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { toTSX } from '../src/editor.cts';
import { describe, it } from 'node:test';
import { strictEqual } from 'node:assert'
phk422 marked this conversation as resolved.
Show resolved Hide resolved

describe('toTSX function', () => {
it('should correctly transform Vue code to TSX with comments', () => {
const vueCode = `
<template>
<div>{{ msg }}</div>
</template>

<script setup>
// This is a comment in script setup
// defineProps(['msg']);
// console.log('foo)
</script>
`;

const className = 'MyComponent';
const result = toTSX(vueCode, className);

// Replace the expectations below with the expected result based on your logic
strictEqual(result, `export default function ${className}__AstroComponent_(_props: Record<string, any>): any {}`)
});
it('should correctly transform Vue code to TSX', () => {
const vueCode = `
<template>
<div @click="handleClick">{{ msg }}</div>
</template>

<script setup>
const props defineProps({
msg: String
});
const handleClick = () => {
console.log('foo');
}
</script>
`;

const className = 'MyComponent';
const result = toTSX(vueCode, className);
strictEqual(result.replace(/\s/g, ''), `import{defineProps}from'vue';constProps=defineProps({msg:String})exportdefaultfunction${className}__AstroComponent_(_props:typeofProps):any{<div></div>}`)
});
});
Loading