TyScan

Supported Version	Language	Runtime	Website
0.2.1+ (default to 0.3.1)	TypeScript	Node.js 12.16.1	https://github.com/sider/tyscan

Getting Started

To start using TyScan in Sider, declare it as a dependency in your package.json.

$ npm install tyscan --save-dev

linter:
  tyscan:
    config: "lint_yml/tyscan.yml"
    tsconfig: "some/tsconfig.json"
    paths:
      - frontend

You can use the following options to make analysis fitter for your project.

Name	Type	Default	Description
`root_dir`	`string`	-	A root directory.
`npm_install`	`boolean`, `string`	-	A behavior of npm installation.
`config`	`string`	`tyscan.yml`	Set configuration file for TyScan.
`tsconfig`	`string`	`tsconfig.json`	Set your TypeScript project file.
`paths`	`string[]`	-	Specify paths to analyze.

This option allows you to specify the file or directory where your TyScan ruleset is located.

linter:
  tyscan:
    config: rules.yml # TyScan will use `rules.yml` instead of `tyscan.yml` as the ruleset.

This option allows you to set the TypeScript project file.

This option allows you to specify the file paths to analyze with TyScan.