codehawk cli下载codehawk cli源代码下载

codehawk cli

其他类别

v10.1.0

下载

Codehawk CLI

Codehawk是JavaScript项目的静态分析工具。它旨在作为警告系统，以确定需要开发人员特别关注的代码的复杂领域。

更新Q2 2023：FTA（快速输入分析仪）现已可用！

FTA是Codehawk CLI项目的直接替代品。在Rust中进行了低水平的静态分析，它更加健壮和更快。

建议在Codehawk CLI上使用FTA。 FTA处于主动开发状态，而Codehawk CLI处于维护模式。

在这里升级到fta。

范围

支持JavaScript（包括打字稿和流）项目进行分析。 CLI工具支持UNIX和Windows Filesystems（Windows兼容码有合理数量）。

它可以通过遍历目录并发现所有受支持的Filetypes，在每个文件上运行静态分析例程，然后执行项目范围内的分析，例如相互依赖性计数和测试覆盖范围映射，从而起作用。

CLI以node.js进程运行。 node.js> = 14是必需的，但建议使用> = 16。节点V12及以下不支持。

用法

使用Codehawk-CLI的最简单方法是将其用于项目中的目录：

npm install --save-dev codehawk-cli或yarn add --dev codehawk-cli
例如codehawk.json

{
    "skipDirectories" : [ " /node_modules " , " coverage " ]
}

将新脚本添加到package.json ，例如： "codehawk": "codehawk src"
运行npm run codehawk并获取输出到STDOUT

另请参见使用Next.js的示例。

示例输出

Codehawk Static Analysis Results
Top 14 files

| File                                               | # of Lines | Times Used/Depended On | Maintainability (higher is better) |
| -------------------------------------------------- | ---------- | ---------------------- | ---------------------------------- |
| /test/codehawk.test.js                             | 149        | 1                      | 45.3 (Needs improvement)           |
| /src/util.ts                                       | 143        | 4                      | 47.26 (Needs improvement)          |
| /src/codehawk.ts                                   | 122        | 2                      | 47.94 (Needs improvement)          |
| /src/options.ts                                    | 72         | 2                      | 52.64 (Could be better)            |
| /src/analyze.ts                                    | 67         | 3                      | 54.04 (Could be better)            |
| /src/cli-util.ts                                   | 63         | 2                      | 54.68 (Could be better)            |
| /src/traverseProject.ts                            | 51         | 2                      | 56.91 (Could be better)            |
| /src/reporters/escomplex.ts                        | 43         | 2                      | 57.44 (Could be better)            |
| /src/badge.ts                                      | 45         | 2                      | 58.09 (Could be better)            |
| /test/options.test.js                              | 47         | 1                      | 58.55 (Could be better)            |
| /src/dependencies.ts                               | 40         | 2                      | 58.7 (Could be better)             |
| /src/coverage.ts                                   | 21         | 2                      | 60.75 OK                           |
| /src/index.ts                                      | 20         | 1                      | 60.97 OK                           |

选项

要自定义分析，请使用以下选项，该选项放置在root目录中的codehawk.json文件中。

选项	描述	默认
`badgesDirectory`	目录将在其中创建两个维护徽章（启用时）	`['/generated']`
`enableFlow`	启用流量支持	`false`
`extensions`	应分析的文件扩展名。默认值始终使用，但是您可以添加更多扩展名。您可以使用`exclude[...]`选项来排除特定文件。	`['.js', '.jsx', '.ts', '.tsx']`
`excludeFilenames`	文件名匹配应排除在静态分析之外（但仍在数据中显示）。默认值始终使用，但是您可以添加更多匹配项以排除在外。请注意，匹配是准确的。排除列表在扩展名列表之后进行考虑。	`['.d.ts', '.min.js', '.bundle.js']`
`excludeDirectories`	目录匹配应排除在静态分析之外（但仍在数据中显示）。相对于根。例如`['/fixtures', '/test']`	`['/dist', '/bin', '/build']`
`excludeExact`	确切的文件匹配应排除在静态分析之外（但仍在数据中显示）。相对于根。例如`['/src/foo/bar.ts']`	`[]`
`skipDirectories`	应完全排除的目录，即根本不可见。默认值将始终跳过。	`['/node_modules', '/flow-typed', '/coverage']`
`minimumThreshold`	最低可接受性得分。如果文件违反了此分数，则CLI将使用代码1退出（用于确保CI中的最低可维护性水平）。建议将其设置为至少30。	`10`
`cliOutputLimit`	在CLI输出中列出的文件数（从最差的分数到最佳分数）。	`25`

高级用法

分析整个目录：

 const { analyzeProject } = require ( 'codehawk-cli' )

const output = analyzeProject ( '/path/to/project' ) // returns a Results object

// Get summary maintainability scores
const {
    average ,
    median ,
    worst ,
} = output . summary

分析单个代码：

 const { calculateComplexity } = require ( 'codehawk-cli' )

const STATIC_SAMPLE = `
    import lodash from 'lodash';

    const chunkIntoFives = (myArr) => {
        return _.chunk(myArr, 5);
    }

    export default chunkIntoFives;
`

const metrics = calculateComplexity ( STATIC_SAMPLE )

console . log ( metrics ) // Inspect the full metrics

徽章

默认情况下，CodeHawk-CLI通过主CLI接口来调用时生成2个徽章（以generated/*.svg ）：

平均值：所有目标源代码的平均维护能力得分
最糟糕的：目标源代码中最差的情况得分

更高的分数更好（更简单，更可维护的代码）。

为避免生成徽章，请使用--no-badge选项。

复杂度指标

Codehawk收集了各种复杂性指标，包括：

代码行：物理（模块或函数中的行数）和逻辑（命令语句的计数）。一个粗略的措施。
参数数：从函数签名进行静态分析，因此没有对依赖参数对象的函数进行会计。较低更好。
循环复杂性：由Thomas J. McCabe在1976年定义，这是程序流控制图中循环数量的数量。有效地通过一块代码的不同路径的数量。较低更好。
循环复杂性密度：提议作为对循环复杂性的修改，该循环复杂性在1991年在1991年通过Geoffrey K. Gill和Chris F. Kemerer进行了修改，该指标只是将其重新表达为代码逻辑线的百分比。较低更好。
Halstead指标：由Maurice Halstead于1977年定义，这些指标是根据每个函数中运算符和操作数的数量计算得出的。较低更好。
可维护性指数：由Paul Aman＆Jack Hagemeister在1991年定义，这是一个对数量表，从负小度到171，是根据代码的逻辑线，Cyclomatix的复杂性和Halstead努力计算得出的。更高是更好的。

警告

不打算生产。该项目应被视为缓慢而实验性的，但旨在阅读您的生产代码！
- 将不会在大型项目上快速运行，因此将其应用于工作流程或管道时，请谨慎和常识。
- 递归遍历目录树，因此，如果一个人在node_modules或c驱动器目录（无意使用）中激活该过程，则您可能会遇到问题。
自以为是：计算总体文件“分数”的公式是任意的，并且基于原始的未发表研究。用户可以自由以不同的方式解释数字并产生自己的分数。
内部质量需要改善：目前，测试是基本的，在对Codehawk本身进行更改之前/之后的状态进行比较可能很尴尬
目前需要codehawk.json配置文件。但是，它们可以是空的。