TsCheckConfig | @lzwme/fed-lint-helper

Hierarchy

CommConfig
- TsCheckConfig

Index

Properties

Optional cache

cache?: boolean

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

Optional cacheLocation

cacheLocation?: string

缓存文件保存的目录路径。默认为： <config.rootDir>/node_modules/.cache/flh/

Optional checkOnInit

checkOnInit?: boolean

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

Optional debug

debug?: boolean

是否打印调试信息

Optional exclude

exclude?: string | string[]

文件排除列表， glob 规则。用于过滤一些不需要检测的文件

Optional exitOnError

exitOnError?: boolean

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

Optional mode

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

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

var: proc fork 子进程执行。默认
var: thread 创建 work_threads 子线程执行。eslint 不要选此选项
var: current 在当前进程中执行

Optional printDetail

printDetail?: boolean

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

Optional removeCache

removeCache?: boolean

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

Optional rootDir

rootDir?: string

Optional silent

silent?: boolean

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

Optional src

src?: string[]

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

Optional toWhiteList

toWhiteList?: boolean

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

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

Optional tsCodeCheck

tsCodeCheck?: number[]

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

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

Optional tsCodeIgnore

tsCodeIgnore?: number[]

要忽略的 ignoreDiagnostics code 列表

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

Optional tsConfigFileName

tsConfigFileName?: string

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

Optional tsFiles

tsFiles?: string[]

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

Optional whiteListFilePath

whiteListFilePath?: string

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