TyScan
Supported Version | Language | Website |
---|---|---|
0.2.1+ (default: 0.3.2) | TypeScript | https://github.com/sider/tyscan |
TyScan is a static analysis tool for TypeScript to easily make your custom rules via your YAML file.
Getting Started
To start using TyScan, enable it in your repository settings
and put a tyscan.yml
file in your repository.
If you want to try it locally, we recommend installing it via npm:
$ npm install tyscan --save-dev
Configuration
Here is a configuration example via sider.yml
:
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 |
---|---|---|
root_dir | string | - |
npm_install | boolean , string | - |
config | string | tyscan.yml |
tsconfig | string | tsconfig.json |
paths | string[] | - |
config
This option allows you to specify a file or directory where your TyScan ruleset is located.
linter:
tyscan:
config: rules.yml # TyScan uses `rules.yml` instead of `tyscan.yml` as the ruleset.
tsconfig
This option allows you to set your TypeScript project file.
paths
This option allows you to specify files or directories to analyze.