Skip to content

Installation

The package supports NodeJS compatible runtimes.

WARNING

The @kolint/check is likely to be renamed in the future.

sh
$ npm add -D @kolint/check
sh
$ pnpm add -D @kolint/check
sh
$ yarn add -D @kolint/check
sh
$ bun add -D @kolint/check

TypeScript

The linter depends on TypeScript as a peer dependency; Meaning that you can configure which version of TypeScript to use. Ensure you have it installed.

sh
$ npm add -D typescript
sh
$ pnpm add -D typescript
sh
$ yarn add -D typescript
sh
$ bun add -D typescript

Usage

After you have linked a viewmodel to a view, you can lint the file. You can choose to pass a directory or file to kolint.

TIP

See kolint --help for all flags. You can also choose to create a config file.

sh
$ npx kolint [options] [...paths]
sh
$ pnpm kolint [options] [...paths]
sh
$ yarn kolint [options] [...paths]
sh
$ bun kolint [options] [...paths]