Interface TsCheckConfig

interface TsCheckConfig {
    cache?: boolean;
    checkOnInit?: boolean;
    debug?: boolean;
    detectSubPackages?: boolean;
    exclude?: string[];
    exitOnError?: boolean;
    extensions?: string[];
    fileList?: string[];
    fix?: boolean;
    ignoreWhiteList?: boolean;
    include?: string[];
    mode?: "proc" | "thread" | "current";
    printDetail?: boolean;
    printDetialOnSuccessed?: boolean;
    removeCache?: boolean;
    rootDir?: string;
    silent?: boolean;
    src?: string[];
    toWhiteList?: boolean;
    tsCodeCheck?: number[];
    tsCodeIgnore?: number[];
    tsConfigFileName?: string;
    whiteListFilePath?: string;
}

Hierarchy (View Summary)

Properties

cache? checkOnInit? debug? detectSubPackages? exclude? exitOnError? extensions? fileList? fix? ignoreWhiteList? include? mode? printDetail? printDetialOnSuccessed? removeCache? rootDir? silent? src? toWhiteList? tsCodeCheck? tsCodeIgnore? tsConfigFileName? whiteListFilePath?

Properties

Optionalcache

cache?: boolean

本次 check 是否使用缓存。为 false 则进行全量文件检测，否则不检测已缓存通过的文件。默认为 true。当依赖升级、规则变更、CI 执行 MR 时建议设置为 false

OptionalcheckOnInit

checkOnInit?: boolean

初始化即执行check。默认为 false。设置为 true 则初始化后即调用 start 方法

Optionaldebug

debug?: boolean

是否打印调试信息

OptionaldetectSubPackages

detectSubPackages?: boolean

是否探测子项目并在子项目中分别执行 lint。默认为 true

Optionalexclude

exclude?: string[]

文件排除列表，用于过滤一些不需要检查处理的文件。glob 规则，如： ['builder/**']

OptionalexitOnError

exitOnError?: boolean

执行完成时存在 lint 异常，是否退出程序。默认为 true

Optionalextensions

extensions?: string[]

文件后缀。用于文件过滤等

OptionalfileList

fileList?: string[]

ts 文件列表。当设置并存在内容时，只对该列表中的文件进行检测。主要用于 git hook 获取 commit 文件列表的场景

Optionalfix

fix?: boolean

是否尝试修正可自动修正的异常

OptionalignoreWhiteList

ignoreWhiteList?: boolean

是否忽略白名单，仅检查全部异常情况

Optionalinclude

include?: string[]

文件包含列表，仅在该列表中的才报告异常。glob 规则，如： ['src\**\*.{ts,tsx,js,jsx}']

Optionalmode

mode?: "proc" | "thread" | "current"

执行检测的方式。默认为 proc

Var

proc fork 子进程执行。默认

Var

thread 创建 work_threads 子线程执行。eslint 不要选此选项

Var

current 在当前进程中执行

OptionalprintDetail

printDetail?: boolean

是否打印异常详情。默认为 true

OptionalprintDetialOnSuccessed

printDetialOnSuccessed?: boolean

执行成功时是否打印详情（[eslint]主要为在白名单中的异常信息，CI 中可设置为 false）。CI 中默认为 false

OptionalremoveCache

removeCache?: boolean

是否移除缓存文件。设置为 true 将移除缓存并生成新的。默认 false

OptionalrootDir

rootDir?: string

项目根目录，默认为当前工作目录

Optionalsilent

silent?: boolean

静默模式。不打印任何信息，一般用于接口调用

Optionalsrc

src?: string[]

项目源码目录，支持配置多个子项目(存在独立的 tsconfig.json)路径，默认为 ['src']

OptionaltoWhiteList

toWhiteList?: boolean

是否将异常文件输出至白名单列表文件中。默认为 false。注意：

  • 追加模式，如需全新生成，应先删除白名单文件。
  • 初始化、规则变更、版本升级导致新增异常，但又不能立即修复的情况下，可设置为 true 执行一次

OptionaltsCodeCheck

tsCodeCheck?: number[]

要检测的 ignoreDiagnostics code 列表。如设置，则仅检查包含于此列表中的异常

See

https://www.tslang.cn/docs/handbook/error.html

OptionaltsCodeIgnore

tsCodeIgnore?: number[]

要忽略的 ignoreDiagnostics code 列表

See

https://www.tslang.cn/docs/handbook/error.html

OptionaltsConfigFileName

tsConfigFileName?: string

tsconfig 配置文件的文件名。默认为 tsconfig.json

OptionalwhiteListFilePath

whiteListFilePath?: string

白名单列表文件保存的路径，用于过滤允许出错的历史文件。默认为 <config.rootDir>/config/whitelist-<lintType>.json

Settings

Member Visibility

On This Page

Properties