codelinter同时支持使用命令行执行代码检查与修复,可将codelinter工具集成到门禁或持续集成环境中。
执行命令前,需要先配置环境变量。
codelinter命令行格式为:
codelinter [options] [dir]
options:可选配置,请参考codelinter命令行配置。
dir:待检查的工程根目录;为可选参数,如不指定,默认为当前上下文目录。
指令 | 说明 |
|---|---|
--config/-c <configPath> | 指定执行codelinter检查的规则配置文件,<configPath>指定执行检查的规则配置文件位置。 |
--fix | 设置codelinter检查同时执行QuickFix。 |
--format/-f <outputFormat> | 设置检查结果的输出格式。<outputFormat>:必须参数,指定输出格式,支持值:default(文本,默认)、json、xml、html。 |
--output/-o <reportFile> | 指定检查结果保存位置,且命令行窗口不展示检查结果。<reportFile>指定存放代码检查结果的文件路径,支持使用相对/绝对路径。不使用--output指令时,检查结果默认会保存在命令行工具的result文件夹下。 |
--version/-v | 查看codelinter版本。 |
--product/-p <productName> | 当项目中存在多个product时,使用-p指定当前生效的product。 <productName> 为生效的product名称。 |
--help/-h | 查询codelinter命令行帮助。 |
codelinter // 进行codelinter检查

codelinter -c filepath // 指定执行检查的规则配置文件位置

codelinter -c filepath --fix // 对工程中的告警进行修复

codelinter dir [filepath] [dir1] // 指定执行检查的工程目录或文件路径。支持同时配置多个文件/文件夹路径。 filepath为待检查的文件所在位置,dir、dir1指定待检查的工程目录

codelinter -c filepath dir // filepath为指定的规则配置文件所在位置,dir指定执行检查的工程根目录

codelinter -c filepath dir --fix // 对指定工程中的告警进行修复。支持配置同时多个工程路径

codelinter [dir] -f json //[dir]为待检查的工程根目录

codelinter [dir] -f json -o filepath2 // [dir]为待检查的工程根目录,filepath2为指定存放代码检查结果的文件路径
