用途
当任务需要生成报告文件、接入 CI 流程,或需要机器可读的分析结果时,可使用 polyscan 命令行工具。它能在一次运行中分析 JavaScript、TypeScript、Go、Rust 和 C++,每个文件的语言由其扩展名自动识别。
安装与运行
无需安装即可运行:
npx polyscan@latest analyze <path>
也可以永久安装:
npm install -g polyscan
下文示例使用裸命令 polyscan 以便阅读;当本地未安装 polyscan 时,需加上前缀 npx polyscan@latest。
主要能力:analyze 命令
analyze 是唯一的核心命令,示例:
polyscan analyze . # HTML 报告(polyscan-report.html)并打开浏览器
polyscan analyze --no-open . # 生成 HTML 报告但不打开浏览器
polyscan analyze --format json src/ # JSON 结果输出到 stdout
polyscan analyze --format text src/ # 人类可读的文本输出到 stdout
polyscan analyze --select complexity,clone . # 只运行指定分析
polyscan analyze --no-open -o report.html . # 自定义报告路径
polyscan analyze --min-complexity 10 . # 只列出复杂度达到或超过 10 的函数
关键参数
- --format html|json|text(-f):输出格式;json 和 text 会写入 stdout,而不是生成 HTML 报告。
- --select(-s):可选 complexity、deadcode、clone、cbo、lcom、deps(默认全部运行);deps 适用于 Go 与 JavaScript/TypeScript;cbo 适用于 Go、Rust 与 JavaScript/TypeScript;lcom 适用于 Go 与 Rust;deadcode 仅适用于 JavaScript/TypeScript。
- --no-open:不自动在浏览器中打开 HTML 报告(用于脚本)。
- -o <path>:HTML 报告路径(默认:当前目录下的 polyscan-report.html)。
- --min-complexity <n>:在列表中隐藏低于该复杂度的函数(评分仍覆盖全部代码)。
- --exclude <patterns>:将文件与目录排除在所有分析之外;不含斜杠的 glob 匹配路径中任意位置的文件名或目录(如 fixtures),含斜杠的 glob 匹配相对于被分析目录的路径,可用 ** 表示任意层级(如 src/generated/**)。
- --include-tests:分析测试文件与测试代码,默认被排除(_test.go、.test.、.spec.*、tests/、Rust 的 #[cfg(test)] 与 tests/、C++ 的 _test. 与 test/)。
使用 --format json 时,机器可读结果输出到 stdout,健康分摘要输出到 stderr,因此 stdout 保持可解析。
语言覆盖范围
复杂度与克隆检测覆盖所有支持的语言。依赖分析覆盖 Go 与 JavaScript/TypeScript。类耦合(CBO)覆盖 Go、Rust 与 JavaScript/TypeScript,类内聚(LCOM4)覆盖 Go 与 Rust。死代码仅存在于 JavaScript/TypeScript。健康分基于实际运行的维度计算:某语言不具备的维度会被略过,而不会按“干净”计分。
CI 用法
没有单独的门禁命令;应基于 JSON 输出做门禁:
polyscan analyze --format json src/ > report.json
jq -e '.summary.health_score >= 80' report.json
配置
JavaScript/TypeScript 分析会在被分析项目存在时读取 jscan.config.json(或 .jscanrc.json)——这是从已并入 polyscan 的 jscan 沿用的复杂度阈值与排除模式。其他语言目前暂无配置文件。
报告结果
在使用时可总结健康分与等级,列出每个未达标类别背后的具体函数/文件,并给出修复建议。对于 CI 配置,建议采用上述 JSON 门禁,并定期运行 polyscan analyze 生成 HTML 报告用于深入审查。
限制
资料未提供其他语言(除 JavaScript/TypeScript 外)的配置文件支持;死代码分析仅限 JavaScript/TypeScript;部分分析维度(如 deps、cbo、lcom)有语言适用范围限制,具体见上文。关于计费、价格、平台兼容性等事实,资料未提供。