composer如何统计项目中包的代码量_composer相关插件使用方法【详解】

12次阅读

不能。composer show仅列出已安装包的名称、版本和描述,读取vendor/composer/installed.json,不含源码路径或行数信息;统计代码行数需用cloc等工具遍历文件系统。

composer如何统计项目中包的代码量_composer相关插件使用方法【详解】

composer show 能不能直接统计代码行数

不能。composer show 只列出已安装包的名称、版本和描述,不提供文件或行数信息。它读的是 vendor/composer/installed.json,里面没有源码路径或尺寸字段。

想统计代码量,必须落到文件系统层面:遍历 vendor/ 下每个包的源码目录,再用工具统计有效行数(排除空行、注释等)。

用 cloc 统计 vendor 包的代码行数(推荐方案)

cloc 是最靠谱的命令行代码统计工具,支持按目录、语言、排除规则精细控制。它能自动识别 php、JS、css 等,并跳过 tests/examples/vendor/递归时防误入)等常见非生产代码路径。

在项目根目录执行:

cloc --exclude-dir=tests,Examples,docs,benchmarks,node_modules,.github,vendor/composer vendor/ --by-file --quiet

说明:

  • --exclude-dir 必须显式排除测试、文档等干扰目录,否则 vendor/ 里大量 demo 和 test 会严重虚高结果
  • vendor/composer 要单独排除——它是 Composer 自身元数据,不是包代码
  • --by-file 可定位到具体哪个包贡献最多,便于后续分析
  • --quiet 减少冗余输出,适合脚本集成

注意:cloc 不区分“你主动 require 的包”和“它们的依赖”,统计的是整个 vendor/ 目录结构下的实际文件。如需只算顶层依赖,得先用 composer show --tree 提取一级包路径,再逐个 cloc

用 composer-unused 检查未使用的包(间接降低代码量)

真正影响维护成本的不是总行数,而是「被加载但没调用」的包。这类包白占磁盘、拖慢 autoloader、增加安全扫描范围。

composer-unused 插件可静态分析 use 语句和函数调用,标出疑似未使用的包:

composer global require composer-unused/composer-unused composer unused

常见误报点:

  • 运行时动态加载(class_exists($name)new $class)不会被检测到
  • PHP 扩展类(如 pdoredis)会被错误标记为未使用
  • 配置驱动的依赖(如 laravel 的 Service Provider)需手动白名单

执行后它会输出类似这样的提示:
Package "symfony/polyfill-mbstring" is not used.
别急着删——先确认你的代码是否隐式依赖了它提供的函数别名(比如 mb_strlen() 在无扩展时由它兜底)。

自定义脚本统计“顶层 require 包”的代码量

如果只想知道 composer.jsonrequire 字段声明的那些包(不含 transitive deps)占多少行,得组合两个命令:

composer show --format=json | php -r " $j = json_decode(file_get_contents('php://stdin'), true); foreach ($j as $pkg => $info) {     if (isset($info['type']) && $info['type'] === 'library') {         $dir = 'vendor/' . $pkg;         if (is_dir($dir)) {             echo "$pkg\n";             passthru("cloc --quiet --exclude-dir=tests,Examples,docs $dir 2>/dev/null | tail -n1 | awk '{print $5}'");         }     } }"

这个脚本做了三件事:

  • composer show --format=json 获取所有已安装包的元数据
  • 过滤出 type: library 的包(排除 projectmetapackage 等)
  • 对每个包目录跑一次 cloc,只取最终的 code 行数列(第 5 列)

关键限制:cloc 默认不递归子目录的子目录,所以它只统计该包自身源码,不包含其 vendor/(如果有),这点比全量 vendor/ 统计更贴近“你引入的成本”。

真正难的不是跑出数字,而是判断哪一行该算、哪一行该忽略——比如一个包带了 5000 行测试代码,但你只用了它 3 个函数,这时候行数本身已经失去参考价值。盯住 composer-unused 的报告,比盯着总行数有用得多。

text=ZqhQzanResources