Optional
cacheOptional
check初始化即执行check。默认为 false。设置为 true 则初始化后即调用 start 方法
Optional
debug是否打印调试信息
Optional
detect是否探测子项目并在子项目中分别执行 lint。默认为 true
Optional
exclude文件排除列表,用于过滤一些不需要检查处理的文件。glob 规则,如: ['builder/**']
Optional
exit执行完成时存在 lint 异常,是否退出程序。默认为 true
Optional
extensions指定处理的文件类型。默认为: ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.cjs', '.json', '.less', '.scss', '.md']
Optional
file要检测的文件列表。主要用于指定仅检测发生变更的文件
Optional
fix是否尝试修正可自动修正的异常
Optional
ignore是否忽略白名单,仅检查全部异常情况
Optional
include文件包含列表,仅在该列表中的才报告异常。glob 规则,如: ['src\**\*.{ts,tsx,js,jsx}']
Optional
mode执行检测的方式。默认为 proc
Optional
prettierprettier config。部分配置项会被内置修正
Optional
print是否打印异常详情。默认为 true
Optional
print执行成功时是否打印详情([eslint]主要为在白名单中的异常信息,CI 中可设置为 false)。CI 中默认为 false
Optional
remove是否移除缓存文件。设置为 true 将移除缓存并生成新的。默认 false
Optional
root项目根目录,默认为当前工作目录
Optional
silent静默模式。不打印任何信息,一般用于接口调用
Optional
src要执行 lint 的源码目录,默认为 ['src']
Optional
to是否将异常文件输出至白名单列表文件中。默认为 false。注意:
Optional
use是否使用 spawn/exec 执行 prettier cli 的方式执行(全量执行时默认为 true,速度更快)
Optional
white白名单列表文件保存的路径,用于过滤允许出错的历史文件。默认为 <config.rootDir>/config/whitelist-<lintType>.json
本次 check 是否使用缓存。为 false 则进行全量文件检测,否则不检测已缓存通过的文件。默认为 true。当依赖升级、规则变更、CI 执行 MR 时建议设置为 false