プロジェクトの比較とレポートの生成
CLOC は、異なるプロジェクトを比較し、様々な形式でレポートを生成する機能を提供します。これらの機能は、時間の経過に伴う変更を追跡したり、異なるコードベースを比較したりする際に特に有用です。
2 つのディレクトリの比較
Flask と比較するための簡単なプロジェクトを作成しましょう。
- プロジェクトディレクトリに移動します。
cd ~/project
- 簡単な Python プロジェクト用の新しいディレクトリを作成します。
mkdir sample_project
cd sample_project
- いくつかのコードを含む Python ファイルを作成します。
echo 'def hello_world():
"""
A simple function that prints Hello World
"""
print("Hello, World!")
if __name__ == "__main__":
hello_world()' > main.py
echo 'class Calculator:
"""A simple calculator class"""
def add(self, a, b):
"""Add two numbers"""
return a + b
def subtract(self, a, b):
"""Subtract b from a"""
return a - b' > calculator.py
- ここで、CLOC の diff 機能を使ってこのサンプルプロジェクトと Flask プロジェクトを比較しましょう。
cd ~/project
cloc --diff flask sample_project
出力には、2 つのプロジェクト間のコードメトリクスの差異が表示されます。
2 text files.
2 unique files.
0 files ignored.
github.com/AlDanial/cloc v 1.90 T=0.01 s (195.2 files/s, 1756.8 lines/s)
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
Python 2 3 4 11
-------------------------------------------------------------------------------
SUM: 2 3 4 11
-------------------------------------------------------------------------------
Diff by file type:
-------------------------------------------------------------------------------
Language files blank comment code
-------------------------------------------------------------------------------
Python 39 3058 2084 7001
Markdown 5 175 0 314
YAML 2 10 3 84
make 1 21 30 46
TOML 1 6 0 19
-------------------------------------------------------------------------------
SUM: 48 3270 2117 7464
-------------------------------------------------------------------------------
異なる形式でのレポート生成
CLOC は、CSV や XML などの様々な形式でレポートを生成することができます。Flask プロジェクトの CSV レポートを作成しましょう。
- Flask プロジェクトのディレクトリに移動します。
cd ~/project/flask
- CSV レポートを生成します。
cloc --csv --out=flask_stats.csv .
- 生成されたレポートの内容を表示します。
cat flask_stats.csv
CSV 形式の CLOC 分析結果が表示されるはずです。
files,language,blank,comment,code,"github.com/AlDanial/cloc v 1.90 T=0.09 s (571.3 files/s, 96263.8 lines/s)"
41,Python,3061,2088,7012
5,Markdown,175,0,314
2,YAML,10,3,84
1,make,21,30,46
1,TOML,6,0,19
50,SUM,3273,2121,7475
この CSV 形式は、スプレッドシートや他のデータ分析ツールにインポートするのに特に便利です。
同様に、XML レポートを生成することもできます。
cloc --xml --out=flask_stats.xml .
これらのレポート機能により、CLOC はコード分析とプロジェクト管理において多用途のツールとなっています。
