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配置文件。但是，它們可以是空的。