rubocop/rubocop-rspec
GitHub: rubocop/rubocop-rspec
RuboCop 的 RSpec 扩展插件,为 Ruby 项目中的 RSpec 测试文件提供专门的代码风格检查能力。
Stars: 857 | Forks: 294
# RuboCop RSpec
作为 [RuboCop](https://github.com/rubocop/rubocop) 的扩展,为您的项目提供针对 [RSpec](https://rspec.info/) 的分析。
- [安装](#installation)
- [升级至 RuboCop RSpec v3.x](#upgrading-to-rubocop-rspec-v3x)
- [升级至 RuboCop RSpec v2.x](#upgrading-to-rubocop-rspec-v2x)
- [用法](#usage)
- [文档](#documentation)
- [Cop 详解](#the-cops)
- [贡献](#contributing)
- [许可证](#license)
## 安装
只需安装 `rubocop-rspec` gem
```
gem install rubocop-rspec
```
或者,如果您使用 bundler,请将其放入您的 `Gemfile` 中
```
gem 'rubocop-rspec', require: false
```
### 升级至 RuboCop RSpec v3.x
请阅读我们的[升级至 3.x 版本](https://docs.rubocop.org/rubocop-rspec/3.0/upgrade_to_version_3.html)文档以了解所有细节。
### 升级至 RuboCop RSpec v2.x
请阅读我们的[升级至 2.x 版本](https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html)文档以了解所有细节。
## 用法
您需要告诉 RuboCop 加载 RSpec 扩展。有三种方法可以做到这一点:
### RuboCop 配置文件
将以下内容放入您的 `.rubocop.yml` 中。
```
plugins: rubocop-rspec
```
或者,在指定多个扩展时使用以下数组表示法。
```
plugins:
- rubocop-other-extension
- rubocop-rspec
```
现在您可以运行 `rubocop`,它会自动将 RuboCop RSpec cops 与标准 cops 一起加载。
### 命令行
```
rubocop --plugin rubocop-rspec
```
### Rake 任务
```
RuboCop::RakeTask.new do |task|
task.plugins << 'rubocop-rspec'
end
```
### Code Climate
rubocop-rspec 作为 rubocop 引擎的一部分可在 Code Climate 上使用。[了解更多](https://marketing.codeclimate.com/changelog/55a433bbe30ba00852000fac/)。
## 文档
您可以在其[官方手册](https://docs.rubocop.org/rubocop-rspec)中阅读有关 RuboCop RSpec 的更多信息。
## Cop 详解
所有 cops 都位于 [`lib/rubocop/cop/rspec`](lib/rubocop/cop/rspec) 下,并包含示例与文档。
在您的 `.rubocop.yml` 中,您可以像对待任何其他 cop 一样对待 RSpec cops。例如:
```
RSpec/SpecFilePathFormat:
Exclude:
- spec/my_poorly_named_spec_file.rb
```
## 贡献
请查看[贡献指南](.github/CONTRIBUTING.md)。
## 许可证
`rubocop-rspec` 采用 MIT 许可证。[查看附带的文件](MIT-LICENSE.md)以了解全文。
标签:LNA, RSpec, RuboCop, Ruby, 云安全监控, 代码规范, 测试工具, 知识库, 静态分析