Skip to content

Commit 90a413e

Browse files
committed
unplugin typechecking docs
1 parent 77a8d5c commit 90a413e

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

source/unplugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,11 +232,11 @@ interface PluginOptions {
232232

233233
- `emitDeclaration`: Whether to generate `.d.ts` type definition files from the Civet source, which is useful for building libraries. (Requires installing `typescript`.) Default: `false`.
234234
- `declarationExtension`: Output filename extension for `.d.ts` files. Default: `".civet.d.ts"`.
235-
- `typecheck`: Whether to run type checking on the generated code. (Requires installing `typescript`.) Default: `false`.
235+
- `typecheck`: Whether to run type checking on the project. (Requires installing `typescript`.) Default: `false`.
236236
- Specifying `true` aborts the build (with an error code) on TypeScript errors.
237237
- Alternatively, you can specify a string with any combination of `error`, `warning`, `suggestion`, or `message` to specify which diagnostics abort the build. For example, `"none"` ignores all diagnostics, `"error+warning"` aborts on errors and warnings, and `"all"` aborts on all diagnostics.
238+
- `typecheck` works in mixed projects too: it will check `.ts` and `.civet` files, according to your `tsconfig.json`'s `include`/`exclude` patterns.
238239
- `implicitExtension`: Whether to allow importing `filename.civet` via `import "filename"`. Default: `true`.
239-
- *Note*: Incompatible with `typecheck: true` (TypeScript needs an explicit `.civet` extension)
240240
- `outputExtension`: JavaScript or TypeScript extension to append to `.civet` for internal purposes. Default: `".jsx"`, or `".tsx"` if `ts` is `"preserve"`.
241241
- `ts`: Mode for transpiling TypeScript features into JavaScript. Default: `"civet"`. Options:
242242
- `"civet"`: Use Civet's JS mode. (Not all TS features supported.)

0 commit comments

Comments
 (0)