Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›JavaScript and Flavors

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • February 2021
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

TyScan

Supported VersionLanguageWebsite
0.2.1+ (default: 0.3.2)TypeScripthttps://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.

NameTypeDefault
root_dirstring-
npm_installboolean, string-
configstringtyscan.yml
tsconfigstringtsconfig.json
pathsstring[]-

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.

← JSHintCoffeeLint →
  • Getting Started
  • Configuration
    • config
    • tsconfig
    • paths
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.