使用 `unused-scanner` 项目的教程

使用 unused-scanner 项目的教程

unused-scannerDetect unused composer dependencies项目地址:https://gitcode.com/gh_mirrors/un/unused-scanner

1. 项目的目录结构及介绍

unused-scanner 是一个用于检测未使用 Composer 依赖项的工具。以下是其基本的目录结构：

unused-scanner/
├── bin/
│   └── unused_scanner
├── config/
│   └── scanner_config.php
├── src/
│   └── Scanner.php
├── tests/
│   └── ScannerTest.php
├── composer.json
├── README.md
└── LICENSE

• bin/：包含可执行文件 unused_scanner。
• config/：包含配置文件 scanner_config.php。
• src/：包含项目的主要源代码文件 Scanner.php。
• tests/：包含测试文件 ScannerTest.php。
• composer.json：Composer 依赖管理文件。
• README.md：项目说明文档。
• LICENSE：项目许可证文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 unused_scanner。这个文件是一个可执行脚本，用于启动 unused-scanner 工具。

启动文件的基本用法如下：

./bin/unused_scanner /path/to/configuration/file/scanner_config.php

如果配置文件 scanner_config.php 存在于当前工作目录中，可以省略路径参数：

./bin/unused_scanner

3. 项目的配置文件介绍

配置文件 scanner_config.php 位于 config/ 目录下。这个文件包含了 unused-scanner 工具运行所需的所有配置选项。

以下是一个示例配置文件的内容：

<?php

return [
    'composer_json_path' => './composer.json',
    'vendor_dir' => './vendor',
    'exclude_packages' => [
        'php',
        'ext-json',
        'ext-mbstring',
    ],
];

• composer_json_path：指定 composer.json 文件的路径。
• vendor_dir：指定 vendor 目录的路径。
• exclude_packages：指定需要排除的依赖包列表。

通过编辑这个配置文件，可以自定义 unused-scanner 工具的行为。

unused-scannerDetect unused composer dependencies项目地址:https://gitcode.com/gh_mirrors/un/unused-scanner