fix: use `--build` for type-checking to be exhaustive and less-fragile #274

haoqunjiang · 2023-05-12T08:16:56Z

Fixes #267
Closes #181

Thanks @segevfiner for noticing this new feature!

~~Currently there's still a small annoyance that vue-tsc would output an extra error message when there're type errors in .vue files vuejs/language-tools#2622 But it works well if there's no error.~~

~~I've already submitted a PR to address it vuejs/language-tools#3176~~

@segevfiner

Fixes #267 Thanks @segevfiner for noticing this new feature! Currently there's still a small annoyance that `vue-tsc` would output an extra error message when there're type errors in `.vue` files vuejs/language-tools#2622 But it works well if there's no error. I've already submitted a PR to address it vuejs/language-tools#3176

segevfiner · 2023-05-12T09:41:13Z

Actually, they might have changed things so that it does run but doesn't type check packages with noEmit at a later releas...

Be sure we actually get errors with this. I have requested microsoft/TypeScript#53979 for them to make this work.

haoqunjiang · 2023-05-12T11:34:14Z

What do you mean by "might have changed things"?

I tested this project https://github.com/sodatea/no-emit-test with both 5.0.4 and 5.1.0-dev.20230512, both reporting the same correct number of errors - though in subsequent calls the error location is lost for ./src/App.vue.
That can be fixed by removing *.tsbuildinfo each time before type-checking?

Fixes #267 It's because I moved the `compilerOptions` from `tsconfig.json` to `tsconfig.app.json` in the 2023-05-05 (v3.6.2) release, but forgot to change the `type-check` script. This isn't comprehensive because it doesn't check all the sub-projects, but at least it's the same scope as previous versions. Ideally I hope #274 can work reliably. But now I'm not sure. So let's first fix this bug.

haoqunjiang · 2023-05-12T12:24:05Z

That can be fixed by removing *.tsbuildinfo each time before type-checking?

vue-tsc --build --force seems to work quite reliably.

segevfiner · 2023-05-12T17:44:08Z

I tried configuring this myself once before but got no errors, but maybe I did something wrong or it was a different issue.

segevfiner · 2023-05-12T21:09:46Z

It might have been the --force thing

haoqunjiang · 2023-11-27T08:06:34Z

@cexbrayat This change could help catch the issue in #386
But I'm unsure if it's worth bringing the extra complexity to average users. The extraneous .tsbuildinfo files could be a surprise. And --force is a must, which is hard to explain…

cexbrayat

I gave it a try, and I think it works well 👍

One note though: all the errors are logged twice. But I'm not sure if this is really an issue.

cexbrayat

Looks like typescript-jsx-nightwatch is failing when running pnpm test locally. There is probably a noEmit to add in another file

cexbrayat

👍

bmulholland · 2023-12-05T11:27:17Z

FYI: I think this setting is incompatible with any JS in the project.

I have some legacy JS files in my app, so I have allowJS: true. If I try running type checking, I get "js emit is not supported." And if I add --noEmit again, "Compiler option '--noEmit' may not be used with '--build'"

- 'vue-tsc' uses '--build' because we are using 'references' in tsconfig.json. - 'vue-tsc' doesn't use '--noEmit' because it is incompatible with '--build'. Instead we set 'noEmit' to 'true' in the referenced tsconfig.json files. - 'vue-tsc' uses '--force' to make check-only builds more reliable (see vuejs/create-vue#274).

* Add package.json * Add 'node_modules' to .gitignore * Add 'typescript' to dev dependencies * Configure TypeScript for Vue * Configure TypeScript for Vite * Set 'composite' in tsconfig.*.json According to the documentation, the 'composite' option should be set to 'true' for referenced projects. * Add Vite's client-side types to tsconfig.dom.json * Add 'vite' to dev dependencies * Add favicon.ico mock * Add index.html * Add vite.config.ts * Fix tsconfig.dom.json * Add Vite scripts * Use a relative import for main.ts in index.html - The main.ts reference is fundamentally different from the favicon.ico reference, Vite resolves references like this similarly to how JavaScript imports are resolved. - '@/main.ts' in index.html that uses 'resolve.alias' works properly for the production build but doesn't work for the development server. * Add 'vue-tsc' to dev dependencies * Add 'vue' to dependencies * Add '@vitejs/plugin-vue' to dev dependencies * Add App.vue, main.ts * Add '@types/node' to dev dependencies Fixes TypeScript's "Cannot find type definition file for 'node'". * Fix 'compilerOptions.paths' in tsconfig.dom.json Fixes TypeScript's "Non-relative paths are not allowed when 'baseUrl' is not set. Did you forget a leading './'?" * Set 'noEmit' in referenced tsconfig.json files This makes it possible to perform check-only builds of a project that uses 'references' in tsconfig.json. The '--noEmit' flag cannot be used here because it is incompatible with '--build'. Check-only builds are especially important for 'vue-tsc' as it doesn't support emitting files. * Add '*.tsbuildinfo' to .gitignore * Add 'lint' script to package.json - 'vue-tsc' uses '--build' because we are using 'references' in tsconfig.json. - 'vue-tsc' doesn't use '--noEmit' because it is incompatible with '--build'. Instead we set 'noEmit' to 'true' in the referenced tsconfig.json files. - 'vue-tsc' uses '--force' to make check-only builds more reliable (see vuejs/create-vue#274). * Add 'eslint', 'eslint-plugin-vue', 'typescript-eslint' to dev dependencies * Allow JavaScript to be checked in tsconfig.node.json * Add eslint.config.js * Add ESLint configuration recommended by 'typescript-eslint' * Add '@types/eslint__js' to dev dependencies * Stop using 'types' in tsconfig.json files Because unfortunately, they don't work as expected. * Enhance ESLint with type information - '...tseslint.configs.recommendedTypeChecked' enables enhanced linting with type information. - 'languageOptions.parserOptions.EXPERIMENTAL_useProjectService: true' allows 'typescript-eslint' to compute type information for a TypeScript project that uses 'references' in the tsconfig.json file (see typescript-eslint/typescript-eslint#2094). * Add 'vue-eslint-parser' to dev dependencies * Clean up eslint.config.js * Include local type definitions in the project * Declare 'eslint-plugin-vue' module * Clean up eslint.config.js * Add '@eslint/eslintrc' to dev dependencies * Add '@types/eslint__eslintrc' to dev dependencies * Configure ESLint for Vue - 'eslint-plugin-vue' doesn't support flat configuration yet, therefore we rely on '@eslint/eslintrc' to use Vue's recommended configuration. * Remove 'eslint-plugin-vue' module declaration It is no longer directly imported in the project, so types are not needed. * Ignore a ESLint error regarding 'App.vue' being 'any' * Add 'eslint-config-prettier' to dev dependencies * Add 'prettier' to dev dependencies * Add '@types/eslint-config-prettier' to dev dependencies * Remove 'lint' from scripts * Add 'check', 'format' to scripts * Add Prettier's ESLint config * Remove custom types from tsconfig.*.json * Clean up tsconfig.node.json * Remove 'types' field from tsconfig.json files * Factor out tsconfig.base.json * Add env.dom.d.ts * Add 'tailwindcss', 'postcss', 'autoprefixer' to dev dependencies * Initialize PostCSS and Tailwind * Configure HTML template files for Tailwind * Format * Add types to postcss.config.js * Add the Tailwind directives to style.css * Add style.css import to main.ts * Add Tailwind CSS Prettier plugin * Add 'dist' to .gitignore * Enable reporting of unused disable directives in ESLint * Add vue-router to dependencies * Add router * Add pinia to dependencies * Add Pinia * Ignore dist in eslint * Add @eslint/js to dev dependencies * Suppress the createApp eslint error * Remove the counter store

haoqunjiang mentioned this pull request May 12, 2023

Npm script type-check is not working #267

Closed

haoqunjiang mentioned this pull request May 12, 2023

fix: specify the sub-project to type-check #275

Merged

haoqunjiang added 2 commits May 12, 2023 20:36

fix: add --force to make it work consistently

9eaeb65

Merge branch 'main' into fix-type-check

47cfc83

haoqunjiang mentioned this pull request Jul 25, 2023

Vite fresh install: TypeScript error for vitest.config.ts #317

Closed

Merge branch 'main' into fix-type-check

fc344d5

haoqunjiang requested a review from cexbrayat November 27, 2023 08:04

cexbrayat approved these changes Nov 29, 2023

View reviewed changes

cexbrayat requested changes Nov 29, 2023

View reviewed changes

haoqunjiang added 4 commits November 30, 2023 15:32

fix: add missing noEmit: true in nightwatch tsconfigs

57cc076

fix: add missing vite-plugin-nightwatch dependency

0a82127

chore: merge branch 'main' into fix-type-check

9b2e124

chore: update lockfile

f75fd98

cexbrayat approved these changes Nov 30, 2023

View reviewed changes

haoqunjiang merged commit 9b27fdf into main Dec 4, 2023
202 checks passed

haoqunjiang changed the title ~~fix: use --build for type-checking to be exaustive and less-fragile~~ fix: use --build for type-checking to be exhaustive and less-fragile Dec 4, 2023

haoqunjiang deleted the fix-type-check branch December 4, 2023 05:32

haoqunjiang mentioned this pull request Dec 4, 2023

Document tsconfig.*.json #265

Open

unshame mentioned this pull request Jan 31, 2024

type-check reports errors twice #437

Open

sapphi-red mentioned this pull request Feb 20, 2024

feat(create-vite): use "solution" tsconfig so that vite.config.ts is type checked vitejs/vite#15913

Merged

4 tasks

nighca mentioned this pull request Mar 1, 2024

CI: Run vite build only after type-check has passed goplus/builder#136

Merged

KentaHizume mentioned this pull request Apr 10, 2024

(AzureADB2C)TypeScript5に更新する AlesInfiny/maris#1028

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: use `--build` for type-checking to be exhaustive and less-fragile #274

fix: use `--build` for type-checking to be exhaustive and less-fragile #274

haoqunjiang commented May 12, 2023 •

edited

Loading

segevfiner commented May 12, 2023

haoqunjiang commented May 12, 2023

haoqunjiang commented May 12, 2023

segevfiner commented May 12, 2023

segevfiner commented May 12, 2023

haoqunjiang commented Nov 27, 2023 •

edited

Loading

cexbrayat left a comment

cexbrayat left a comment

cexbrayat left a comment

bmulholland commented Dec 5, 2023 •

edited

Loading

fix: use --build for type-checking to be exhaustive and less-fragile #274

fix: use --build for type-checking to be exhaustive and less-fragile #274

Conversation

haoqunjiang commented May 12, 2023 • edited Loading

segevfiner commented May 12, 2023

haoqunjiang commented May 12, 2023

haoqunjiang commented May 12, 2023

segevfiner commented May 12, 2023

segevfiner commented May 12, 2023

haoqunjiang commented Nov 27, 2023 • edited Loading

cexbrayat left a comment

Choose a reason for hiding this comment

cexbrayat left a comment

Choose a reason for hiding this comment

cexbrayat left a comment

Choose a reason for hiding this comment

bmulholland commented Dec 5, 2023 • edited Loading

fix: use `--build` for type-checking to be exhaustive and less-fragile #274

fix: use `--build` for type-checking to be exhaustive and less-fragile #274

haoqunjiang commented May 12, 2023 •

edited

Loading

haoqunjiang commented Nov 27, 2023 •

edited

Loading

bmulholland commented Dec 5, 2023 •

edited

Loading