Suspenders 技术文档

1. 安装指南

Suspenders 是一个基于 Rails 的引擎，它包含了一些用于配置 Rails 应用的生成器。在安装前，请确保满足以下要求：

• Rails ~> 7.0
• Ruby >= 3.1
• Node >= 20.0.0

2. 项目的使用说明

Suspenders 可以用于创建新的 Rails 应用程序，或增强现有的 Rails 应用程序。

在新的 Rails 应用程序中使用

这种方法使用应用程序模板来生成一个带有 Suspenders 的新 Rails 应用程序。

我们跳过了默认的测试框架，转而使用 RSpec，并首选 PostgreSQL 作为我们的数据库。

我们默认跳过 RuboCop 规则，转而使用我们的全面审查规则。

运行以下命令来创建新的应用：

rails new app_name \
 --skip_rubocop \
 --skip-test \
 -d=postgresql \
 -m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb

然后在新生成的应用程序中运行 bin/setup。

或者，如果您使用我们的 dotfiles，那么只需运行 rails new app_name，或者创建自己的 railsrc 文件，包含以下配置：

--skip_rubocop
--skip-test
--database=postgresql
-m=https://raw.githubusercontent.com/thoughtbot/suspenders/main/lib/install/web.rb

在现有的 Rails 应用程序中使用

将 Suspenders 添加到 :development 和 :test 组中，可以在现有的 Rails 应用程序中使用。

group :development, :test do
  gem "suspenders"
end

一旦安装，您可以调用网络安装生成器，这将调用所有生成器。

bin/rails g suspenders:install:web

或者，您可以单独调用生成器。要查看可用的生成器列表，运行：

bin/rails g | grep suspenders

要了解有关生成器的更多信息，运行：

bin/rails g suspenders:[generator_name] --help

可用的任务

Suspenders 随附了几个自定义 Rake 任务。

bin/rails suspenders:rake
bin/rails suspenders:db:migrate
bin/rails suspenders:cleanup:organize_gemfile

3. 项目API使用文档

本项目API使用文档暂无详细说明，请参考项目源码和官方文档。

4. 项目安装方式

Suspenders 的安装方式如下：

对于新项目，使用应用程序模板来生成带有 Suspenders 的新 Rails 应用程序。对于现有项目，将 Suspenders 添加到 Gemfile 的 :development 和 :test 组中，然后执行 bundle install。

本文档旨在帮助用户安装和使用 Suspenders，以便更好地配置和管理 Rails 应用程序。