anahkiasen/janitor

Janitor 是一个帮助您从代码库中移除未使用代码、视图和资源的工具。

dev-master / 0.1.x-dev 2015-05-21 13:18 UTC

This package is auto-updated.

Last update: 2024-09-08 00:39:49 UTC


README

Build Status Latest Stable Version Total Downloads Scrutinizer Quality Score Code Coverage Dependency Status Support via Gittip

Janitor 是一个帮助您从代码库中移除未使用代码、路由、视图和资源的工具。

安装

只需通过 Composer 运行以下命令

$ composer require anahkiasen/janitor --dev

然后将 Janitor 的服务提供者添加到您应用程序的本地提供者中

'Janitor\JanitorServiceProvider',

用法

命令行

您只需运行以下命令即可查看 Janitor 可以执行的各种操作

$ php artisan list janitor

程序化

Janitor 也可以程序化使用,为了这样做

<?php
// Define your codebase
$codebase = new Janitor\Codebase('app');

// Create an instance of any of Janitor's analyzer classes
$analyzer = new Janitor\Services\Analyzers\ViewsAnalyzer($codebase);

// Tell it which files you wish to analyze, and run the process
$analyzer->setFiles('app/views');
$files = $analyzer->analyze();

在这里,$files 将是一个包含 AbstractAnalyzedEntity 实例的集合。它最重要的属性是 usage 属性,它是一个整数,其值从 0(文件未使用)到 1(文件使用)。值可以在这两个点之间变化,以指示 Janitor 对文件使用的确定性。

{
  "root": "/Users/foobar/Sites/foo/bar/app/views",
  "name": "_emails/feedback.twig",
  "usage": 0
}

可用的分析器

欢迎贡献和建议。

测试

$ phpunit

贡献

请参阅 CONTRIBUTING 了解详细信息。

许可证

MIT 许可证(MIT)。有关更多信息,请参阅 License AbstractAnalyzedFile