A CLI to type check Marko projects
npm install @marko/type-checkA CLI for running type checks on .marko, .ts, and .js files.
```
npm install --save-dev @marko/type-check
Use the marko-type-check or mtc command followed by options to run type checks on your project files:
`terminal
marko-type-check [options]
Options
| Option | Alias | Description | Default Value |
| ---------------- | ----- | ---------------------------------------------------------------------- | ---------------------------------- |
| --project | -p | Path to the tsconfig or jsconfig file | ./tsconfig.json or ./jsconfig.json |
| --display | -d | Set the display type for error output. Choices: codeframe or condensed | codeframe |
| --help | -h | Display the help text | |
| --version | -v | Display the CLI version, Marko version, and TypeScript version | |
Examples
$3
`
marko-type-check
`$3
`
mtc -p ./jsconfig.json -d condensed
`FAQ
$3
tsc cli in build mode. Meaning .js and .d.ts files will be output (depending on your project config). Beyond that .marko files _with their types stripped_ and an associated .d.marko file will be output that serve a similar purpose to the .js and .d.ts files.$3
A
.d.marko files is similar to a .d.ts file. All script content in the file will be processed as if the Marko script-lang was typescript and the Marko-VSCode plugin and this CLI will both prefer loading a .d.marko over an adjacent .marko file. The .d.marko files output by this tool will strip out any runtime code such that only type information is in the .d.marko output.$3
Yes this replaces
tsc since in order to provide proper type checking for .marko files the .ts and .js` files must be processed as well.Contributions are welcome! Please read our Contributing Guidelines for more information on how to contribute.
This project is licensed under the MIT License.