discover-unused-partials 项目使用教程

discover-unused-partials 项目使用教程

discover-unused-partialsA script to help you finding out unused partials. Good for big projects or projects under heavy refactoring项目地址:https://gitcode.com/gh_mirrors/di/discover-unused-partials

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

discover-unused-partials 是一个用于帮助开发者查找未使用部分的开源项目。以下是该项目的目录结构及其介绍：

discover-unused-partials/
├── bin/
│   └── discover-unused-partials
├── lib/
│   ├── discover-unused-partials.rb
│   └── discover-unused-partials/
│       └── version.rb
├── spec/
│   ├── discover-unused-partials_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── Gemfile
├── LICENSE
├── README.rdoc
├── Rakefile
├── VERSION
└── discover-unused-partials.gemspec

• bin/：包含可执行文件 discover-unused-partials。
• lib/：包含项目的主要代码文件，包括 discover-unused-partials.rb 和版本文件 version.rb。
• spec/：包含项目的测试文件。
• .gitignore：Git 忽略文件配置。
• Gemfile：Ruby 依赖管理文件。
• LICENSE：项目许可证。
• README.rdoc：项目说明文档。
• Rakefile：Rake 任务配置文件。
• VERSION：项目版本号。
• discover-unused-partials.gemspec：Gem 包配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 discover-unused-partials。该文件是一个可执行脚本，用于启动查找未使用部分的功能。

启动文件的内容如下：

#!/usr/bin/env ruby

require 'discover-unused-partials'

DiscoverUnusedPartials.run(ARGV)

该脚本首先引入了 discover-unused-partials 库，然后调用 DiscoverUnusedPartials.run(ARGV) 方法来执行查找未使用部分的功能。

3. 项目的配置文件介绍

项目的配置文件可以通过在应用的配置目录中添加 discover-unused-partials.yml 文件来进行自定义配置。

配置文件的内容示例如下：

# 列出不会被报告的文件
keep:
  - app/views/my/partial/_to_keep.html.erb

# 列出动态生成的部分及其来源
dynamic:
  app/controllers/user_controller.rb:
    - app/views/user/_first_dynamic_partial.html.erb
    - app/views/user/_second_dynamic_partial.text.haml

• keep：列出不会被报告的文件。
• dynamic：列出动态生成的部分及其来源。

通过配置文件，可以精确控制哪些部分不会被报告，以及哪些部分是动态生成的。

discover-unused-partialsA script to help you finding out unused partials. Good for big projects or projects under heavy refactoring项目地址:https://gitcode.com/gh_mirrors/di/discover-unused-partials