本記事では、VS Code Counterをインストールしてソースのステップを計測する方法を説明する。
インストールするバージョンは、VS Code Counter v3.4.0 (2024/05/26時点で最新)
VS Code Counterとは？
プログラム言語の空行、コメント行、ソースコードの物理行を計測するVS Codeの拡張機能。
ワークスペースやディレクトリのソースコードの行カウントと、リアルタイムな現在のファイルの行カウントが可能。
インストール環境
- Windows 11 Home 23H2
- Visual Studio Code 1.89
インストール方法
手順1. VS CodeでExtensionビューを開く(Ctrl+Shift+X)
手順2. “VS Code Counter”を検索し、[インストール]
主な使用方法
ワークスペースのステップ計測
コマンドパレット(Ctrl+Shift+P) -> VSCodeCounter: ワークスペース内のコード行を数える (Count lines in workspace)
デフォルトでは以下のように結果出力される。
.VSCodeCounter/yyyy-MM-dd_hh-mm-ss // 計測日時がディレクトリ名になる
details.md // ファイル毎の詳細
diff-details.md // 前回計測時との差分詳細(ファイル毎)
diff.csv // 前回計測時との差分(csv)
diff.md // 前回計測時との差分(md)
diff.txt // 前回計測時との差分(txt)
results.csv // 計測結果(csv)
results.json // 計測結果(json)
results.md // 計測結果(md)
results.txt // 計測結果(txt)任意のディレクトリをステップ計測
VSCodeのエクスプローラ(Ctrl+Shift+E)で対象のディレクトリを右クリック -> ディレクトリ内のコード行を数える
リアルタイムでステップ計測
コマンドパレット(Ctrl+Shift+P) -> VSCodeCounter: リアルタイムコードカウンタの表示・非表示切り替え (Toggle Real-time Counter Visibility)
以下のように、ステータスバーにコード、コメント、空行が表示される。
サポート言語を確認
コマンドパレット(Ctrl+Shift+P) -> VSCodeCounter: 利用可能な言語を確認する (Check available languages)
cpp : aliases[C++,Cpp,cpp], extensions[.cpp,.cc,.cxx,.c++,.hpp,.hh,.hxx,.h++,.h,.ii,.ino,.inl,.ipp,.ixx,.tpp,.txx,.hpp.in,.h.in], filenames:[]
javascriptreact : aliases[JavaScript JSX,JavaScript React,jsx], extensions[.jsx], filenames:[]
typescriptreact : aliases[TypeScript JSX,TypeScript React,tsx], extensions[.tsx], filenames:[]
bat : aliases[Batch,bat], extensions[.bat,.cmd], filenames:[]
...(略)
yaml : aliases[YAML,yaml], extensions[.yaml,.yml,.eyaml,.eyml,.cff,.yaml-tmlanguage,.yaml-tmpreferences,.yaml-tmtheme], filenames:[]
tailwindcss : aliases[Tailwind CSS], extensions[], filenames:[]
graphql : aliases[], extensions[.graphql], filenames:[]
vue : aliases[], extensions[.vue], filenames:[]
VS Code Counter : available all 73 languages.設定
settings.jsonで拡張機能の設定を行うことができる。
| No. | プロパティ | 説明 |
|---|---|---|
| 1 | VSCodeCounter.useGitignore | .gitignoreを使用してファイルを除外するか |
| 2 | VSCodeCounter.useFilesExclude | ‘files.exclude’ (settings.jsonの設定値)を使用してファイルを除外するか |
| 3 | VSCodeCounter.maxOpenFiles | 同時読み込み可能なファイル上限 |
| 4 | VSCodeCounter.printNumberWithCommas | 3桁区切りのカンマを出力するか (e.g. 1,000、1,000,000) |
| 5 | VSCodeCounter.ignoreUnsupportedFile | 未サポートファイルを無視するか |
| 6 | VSCodeCounter.endOfLine | 出力結果の改行コード |
| 7 | VSCodeCounter.include | 対象ファイルとディレクトリのglobパターン |
| 8 | VSCodeCounter.exclude | 除外ファイルとディレクトリのglobパターン |
| 9 | VSCodeCounter.outputDirectory | 結果出力するディレクトリパス |
| 10 | VSCodeCounter.outputAsText | txtファイルで結果出力するか |
| 11 | VSCodeCounter.outputAsCSV | csvファイルで結果出力するか |
| 12 | VSCodeCounter.outputAsMarkdown | md(マークダウン)ファイルで結果出力するか |
| 13 | VSCodeCounter.outputPreviewType | ステップ計測後にプレビューする結果ファイル(オプション: text, csv, markdown, diff-text, diff-csv, diff-markdown or none) |
| 14 | VSCodeCounter.saveLocation | 言語設定の保存先 |
| 15 | VSCodeCounter.history | 履歴として保持する結果数 |
(設定例)
計測直後のプレビューをデフォルトのマークダウンからCSVに変更したい場合
// .vscode/settings.json
{
"VSCodeCounter.outputPreviewType": "csv"
}参考
VS Code Counter - Visual Studio Marketplace
Extension for Visual Studio Code - Count lines of code in many programming languages.
marketplace.visualstudio.com
