feat: add buildMode flag to ts checker configruration. resolve #65 (#66)

* feat: Add support for buld mode
fix #65

* fix: forget to return final args

* doc: update docs and types

* fix: fix type errors

* style: code style issues

* docs: refine README

Co-authored-by: Alexandr Dubinin <[email protected]>
Co-authored-by: fi3ework <[email protected]>

Author: Akiyamka

README.md

@@ -141,10 +141,11 @@ export default {
 
 ### config.typescript
 
-| field        | Type     | Default value                                         | Description                      |
-| :----------- | -------- | ----------------------------------------------------- | -------------------------------- |
-| root         | `string` | [Vite config](https://vitejs.dev/config/#root) `root` | Root path to find tsconfig file  |
-| tsconfigPath | `string` | `"tsconfig.json"`                                     | Relative tsconfig path to `root` |
+| field        | Type      | Default value                                         | Description                                                                                                                                                                                                                     |
+| :----------- | --------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| root         | `string`  | [Vite config](https://vitejs.dev/config/#root) `root` | Root path to find tsconfig file                                                                                                                                                                                                 |
+| tsconfigPath | `string`  | `"tsconfig.json"`                                     | Relative tsconfig path to `root`                                                                                                                                                                                                |
+| buildMode    | `boolean` | `false`                                               | Add [`--build`](https://www.typescriptlang.org/docs/handbook/project-references.html) to `tsc` flag, note that `noEmit` does NOT work if `buildMode` is `true` ([#36917](https://github.com/microsoft/TypeScript/issues/36917)) |
 
 ### config.vls
 

packages/vite-plugin-checker/src/checkers/typescript/main.ts

@@ -123,12 +123,21 @@ export class TscChecker extends Checker<'typescript'> {
       absFilePath: __filename,
       build: {
         buildBin: (config) => {
-          if (typeof config.typescript === 'object' && config.typescript.tsconfigPath) {
-            const tsconfig = config.typescript.root
-              ? path.join(config.typescript.root, config.typescript.tsconfigPath)
-              : config.typescript.tsconfigPath
-            return ['tsc', ['--noEmit', '-p', tsconfig]]
+          if (typeof config.typescript === 'object') {
+            const { root, tsconfigPath, buildMode } = config.typescript
+
+            // Compiler option '--noEmit' may not be used with '--build'
+            let args = [buildMode ? '-b' : '--noEmit']
+
+            // Custom config path
+            if (tsconfigPath) {
+              const fullConfigPath = root ? path.join(root, tsconfigPath) : tsconfigPath
+              args = args.concat(['-p', fullConfigPath])
+            }
+
+            return ['tsc', args]
           }
+
           return ['tsc', ['--noEmit']]
         },
       },

packages/vite-plugin-checker/src/types.ts

@@ -11,6 +11,8 @@ export type TscConfig =
       tsconfigPath: string
       /** root path of cwd */
       root: string
+      /** root path of cwd */
+      buildMode: boolean
     }>
 
 /** vue-tsc checker configuration */