Fixes duplicate typechecking and error reporting when running type-check with vitest or cypress component tests enabled. This should also speed up typechecking.

Adds usage of project references to vitest and cypress component test tsconfigs. Adds declaration emit to the tsconfig.app.json. Only includes test files in unit testing tsconfigs.

Fixes#437

Runningpnpm run type-check intypescript-vitest after:

Runningpnpm run type-check intypescript-vitest before (2 duplicate errors):

Note: due to the fact that typescript stops checking if a project reference has errors, the errors in test files appear only after errors in the app are fixed (when runningvue-tsc, it doesn't affect how IDEs display errors).There's an upcoming typescript feature that will fix this, but I don't think it's a big deal even without the fix. Definitely better than having errors reported twice.

Thanks to@codethief for the idea.

E2E tests

I didn't touch tsconfigs for e2e tests. They most likely can be setup the same way as unit tests, I don't see why they need to be in a separate folder. There are more changes that need to be made to achieve this though, that should be done in a separate PR.

The nightwatch config is the weirdest case - there is just a copy of tsconfig.app.json in it that overwrites the original one. I tried to set it up to work the same way as cypress-ct does, but looks like the vue plugin doesn't have any types, so it was giving me errors. I deleted that instead of copying the new content of tsconfig.app.json into it.

unshame added2 commits

August 5, 2024 01:59

feat(typescript): use project references in vitest and cypress tsconfigs

7fe89ec

feat(typescript): delete duplicate tsconfig

86939b8

unshame commented

Aug 4, 2024

View reviewed changes

template/tsconfig/vitest/tsconfig.vitest.json Outdated

		@@ -1,11 +1,18 @@
		{
		"extends": "./tsconfig.app.json",

Copy link

Author

unshameAug 4, 2024

Choose a reason for hiding this comment

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

I kept this extending the app config, but maybe it's better to make it extend @vue/tsconfig/tsconfig.dom.json directly? That's how I've set it up in my project, makes it easier to manage.

Copy link

codethiefAug 5, 2024

Choose a reason for hiding this comment

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

Yeah, I'd argue it's better to keep production and test configs separate (and rather have them extend a common base config), so that people won't e.g. add types totsconfig.app.json that don't belong in test files.

unshame commented

Aug 4, 2024

View reviewed changes

template/tsconfig/cypress-ct/tsconfig.cypress-ct.json

		"cypress/support/component.*",
		"cypress/support/commands.ts"
		],
		"exclude": [],
		"compilerOptions": {
		"composite": true,
		"outDir": "./node_modules/.tmp/cypress-ct",

Copy link

Author

unshameAug 4, 2024

Choose a reason for hiding this comment

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

It's not strictly necessary to have the declarations output for anything but the tsconfig.app.json right now, but I think it makes sense to make them all work the same way.

Copy link

codethiefAug 5, 2024•
edited
Loading

Choose a reason for hiding this comment

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

Agreed. Besides, whether or not declarations will be output will change slightly in TypeScript 5.6, seemicrosoft/TypeScript#32651 (comment)

cexbrayat requested a review fromhaoqunjiang

August 5, 2024 07:49

Copy link

Member

cexbrayat commentedAug 5, 2024

Let's hear from@sodatea what he thinks about this setup

codethief reviewed

Aug 5, 2024

View reviewed changes

template/tsconfig/vitest/tsconfig.vitest.json Outdated

		"exclude": [],
		"compilerOptions": {
		"composite": true,
		"outDir": "./node_modules/.tmp/vitest",
		"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.vitest.tsbuildinfo",

Copy link

codethiefAug 5, 2024•
edited
Loading

Choose a reason for hiding this comment

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

tsBuildInfoFile can be removed since now that we set outDir, its default value will be<outDir>/<config name>.tsbuildInfo, comparehttps://www.typescriptlang.org/tsconfig/#tsBuildInfoFile

Same thing goes fortsBuildInfoFile in the other tsconfigs.

Copy link

codethief commentedAug 5, 2024

Thanks so much for picking this up,@unshame ! :)

feat(typescript): remove redundant tsBuildInfoFile, don't inherit tsc…

9658716

…onfig.app.json

Copy link

codethief commentedAug 21, 2024•
edited
Loading

@unshame Since our conversation in#437, I have run intovuejs/language-tools#3526 with increasing frequency. Right now it blocks me from introducing project references in the frontend project at my day job. I'd therefore be hesitant to merge this PR before the upstream issue gets fixed. :\

Copy link

Author

unshame commentedAug 21, 2024•
edited
Loading

Interesting.

I do see the error in vscode:

Webstorm on the other hand has no issues with it and it's using the same version of vue language server.

I also don't have issues with vue-tsc, it reports the errors correctly and doesn't infer the type of the component as any:

So looks like a vscode extension bug?

Copy link

codethief commentedAug 21, 2024

@unshame Interesting. My coworker has been reporting issues at least in IntelliJ, though. Would you mind re-posting your comment invuejs/language-tools#3526 together with the exact versions of vue-tsc, VSCode extension, WebStorm, WebStorm Vue extension etc.?

Copy link

Contributor

messenjer commentedAug 21, 2024

They just released a new version of volar and vue-tsc (2.4.0) :https://github.com/volarjs/volar.js/releases/tag/v2.4.0

Copy link

codethief commentedAug 21, 2024•
edited
Loading

@messenjer vue-tsc is still at 2.0.29, seehttps://www.npmjs.com/package/vue-tsc . I don't know which Volar version vue-tsc 2.0.29 uses¹ but it was released ~a month ago. (¹ There are no release notes and no git tag for 2.0.29 onhttps://github.com/vuejs/language-tools yet.)

Meanwhile, @vuejs/language-tools masterupdated to Volar 2.4.0 only 2 days ago. So we'll have to wait for a new vue-tsc version that uses Volar 2.4.0.

In any case, let's please continue this discussion invuejs/language-tools#3526.

codethief mentioned this pull request

Aug 30, 2024

VSCode complains about *.vue imports across project boundaries when using project referencesvuejs/language-tools#4750

Open

Copy link

codethief commentedSep 16, 2024•
edited
Loading

Since my last comments a lot has happened:One ticket has been closed,another (new) ticket is still open. Personally, I decided the remaining issue is no longer a blocker, since it only affects IDE support in minor ways and type checking is not affected. So in our project I went ahead and implemented project references throughout and until now I haven't received any major complaints from my coworkers.

For create-vue the considerations might be different, though, I don't know.

codethief mentioned this pull request

Nov 11, 2024

type-check reports errors twice#437

Open

haoqunjiang added a commit to haoqunjiang/create-vue that referenced this pull request

Dec 12, 2024

fix: removecomposite: true from tsconfigs

cb384ce

We are only using `references` in a solution-style tsconfig.According to discussions atmicrosoft/TypeScript#60465,such usage doesn't require `composite: true` to be set in sub-configs.Removing this field loosens the constraints on these configs that allfiles to be explicitly listed in `files` or `includes`.After this change, type errors in source code would only be reportedtwice if they're also imported by unit test specs, in constrast toalways be reported twice prior to the change.I know this is not ideal yet, but it's still an improvement, and mighthelp catch some edge cases such asvuejs#437 (comment)In the long run, we should still keep an eye onvuejs#549(pendingvuejs/language-tools#4750).Cross-referencing might be a more intuitive configuration, and should bethe desirable configuration if we opt into Vitest Browser Mode.

haoqunjiang added a commit to haoqunjiang/create-vue that referenced this pull request

Dec 12, 2024

fix: removecomposite: true from tsconfigs

3b7a7fc

We are only using `references` in a solution-style tsconfig.According to discussions atmicrosoft/TypeScript#60465,such usage doesn't require `composite: true` to be set in sub-configs.Removing this field loosens the constraints on these configs that allfiles to be explicitly listed in `files` or `includes`.After this change, type errors in source code would only be reportedtwice if they're also imported by unit test specs, in contrast toalways be reported twice prior to the change.I know this is not ideal yet, but it's still an improvement, and mighthelp catch some edge cases such asvuejs#437 (comment)In the long run, we should still keep an eye onvuejs#549(pendingvuejs/language-tools#4750).Cross-referencing might be a more intuitive configuration, and should bethe desirable configuration if we opt into Vitest Browser Mode.

haoqunjiang mentioned this pull request

Dec 12, 2024

fix: removecomposite: true from tsconfigs#635

Merged

Labels

None yet

4 participants

Movatterモバイル変換

Feat project references#549

Are you sure you want to change the base?

Feat project references#549

Uh oh!

Conversation

unshame commentedAug 4, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Description

E2E tests

Uh oh!

unshameAug 4, 2024

Choose a reason for hiding this comment

Uh oh!

codethiefAug 5, 2024

Choose a reason for hiding this comment

Uh oh!

unshameAug 4, 2024

Choose a reason for hiding this comment

Uh oh!

codethiefAug 5, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cexbrayat commentedAug 5, 2024

Uh oh!

codethiefAug 5, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codethief commentedAug 5, 2024

Uh oh!

codethief commentedAug 21, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

unshame commentedAug 21, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

codethief commentedAug 21, 2024

Uh oh!

messenjer commentedAug 21, 2024

Uh oh!

codethief commentedAug 21, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

codethief commentedSep 16, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

Uh oh!

unshame commentedAug 4, 2024•
edited
Loading

codethiefAug 5, 2024•
edited
Loading

codethiefAug 5, 2024•
edited
Loading

codethief commentedAug 21, 2024•
edited
Loading

unshame commentedAug 21, 2024•
edited
Loading

codethief commentedAug 21, 2024•
edited
Loading

codethief commentedSep 16, 2024•
edited
Loading