项目技术文档：发现未使用的部分

1. 安装指南

1.1 安装 gem

要安装 discover-unused-partials gem，请在终端中运行以下命令：

gem install discover-unused-partials

1.2 配置文件

为了微调脚本的行为，您可以在应用程序的配置目录中添加一个名为 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

2. 项目的使用说明

2.1 运行脚本

要使用此脚本，只需在终端中运行以下命令：

discover-unused-partials path/to/your/rails_root

如果未提供路径，脚本将在当前目录中执行。

2.2 输出结果

脚本将返回一个未提及的部分列表。它支持检测 Haml 和 Erb（包括 .erb 和 .rhtml）模板。

3. 项目API使用文档

3.1 脚本功能

该脚本的主要功能是帮助开发者发现未使用的部分（partials）。它通过扫描 Rails 项目的视图文件，识别出哪些部分在项目中未被引用。

3.2 配置选项

• keep: 指定不报告的文件列表。
• dynamic: 指定动态生成的部分及其源文件列表。

4. 项目安装方式

4.1 通过 gem 安装

最简单的安装方式是通过 RubyGems 安装 discover-unused-partials gem：

gem install discover-unused-partials

4.2 手动安装

如果您不想通过 gem 安装，也可以手动下载脚本并将其放置在您的项目目录中。然后，您可以通过命令行直接运行脚本。

---

通过以上文档，您应该能够顺利安装和使用 discover-unused-partials 脚本，帮助您发现 Rails 项目中未使用的部分。