开源项目 guard-rubocop
使用教程
guard-rubocopGuard plugin for RuboCop项目地址:https://gitcode.com/gh_mirrors/gu/guard-rubocop
1. 项目的目录结构及介绍
guard-rubocop
项目的目录结构如下:
guard-rubocop/
├── lib/
│ ├── guard/
│ │ └── rubocop.rb
│ └── guard/rubocop/
│ ├── runner.rb
│ └── version.rb
├── spec/
│ ├── guard/rubocop_spec.rb
│ └── spec_helper.rb
├── .gitignore
├── .rspec
├── .rubocop.yml
├── .rubocop_todo.yml
├── .yardopts
├── CHANGELOG.md
├── Gemfile
├── Guardfile
├── LICENSE.txt
├── README.md
├── Rakefile
└── guard-rubocop.gemspec
目录结构介绍
lib/
:包含项目的主要代码文件。guard/rubocop.rb
:guard-rubocop
的主要逻辑文件。guard/rubocop/
:包含guard-rubocop
的辅助文件。runner.rb
:负责运行RuboCop
的文件。version.rb
:定义版本信息的文件。
spec/
:包含项目的测试文件。guard/rubocop_spec.rb
:guard-rubocop
的测试文件。spec_helper.rb
:测试辅助文件。
.gitignore
:Git 忽略文件配置。.rspec
:RSpec 配置文件。.rubocop.yml
:RuboCop
的主要配置文件。.rubocop_todo.yml
:RuboCop
的待办配置文件。.yardopts
:YARD 文档生成器配置文件。CHANGELOG.md
:项目变更日志。Gemfile
:项目的依赖管理文件。Guardfile
:Guard
的配置文件。LICENSE.txt
:项目的许可证文件。README.md
:项目的说明文档。Rakefile
:Rake 任务配置文件。guard-rubocop.gemspec
:项目的 gem 规范文件。
2. 项目的启动文件介绍
guard-rubocop
的启动文件是 lib/guard/rubocop.rb
。这个文件定义了 Guard::RuboCop
类,负责初始化和运行 RuboCop
检查。
启动文件主要功能
- 初始化
Guard::RuboCop
实例。 - 定义
start
、run_all
、run_on_changes
等方法,用于在不同事件触发时运行RuboCop
检查。 - 配置
RuboCop
的运行选项和参数。
3. 项目的配置文件介绍
guard-rubocop
的配置文件主要包括 Guardfile
和 .rubocop.yml
。
Guardfile
Guardfile
是 Guard
的配置文件,用于定义 guard-rubocop
的行为。示例如下:
guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--rails'] do
watch(%r{^app/.+\.rb$})
watch(%r{^lib/.+\.rb$})
watch(%r{^spec/.+\.rb$})
end
.rubocop.yml
.rubocop.yml
是 RuboCop
的配置文件,用于定义代码风格检查的规则。示例如下:
AllCops:
Exclude:
- 'db/schema.rb'
- 'vendor/bundle/**/*'
TargetRubyVersion: 2.7
Style/StringLiterals:
EnforcedStyle: double_quotes
配置文件主要功能
Guardfile
:定义guard-rubocop
的监听文件和运行选项。.rubocop.yml
:定义RuboCop
的代码风格检查规则和排除文件。
通过以上配置文件,可以灵活地调整 guard-rubocop
的行为和 `
guard-rubocopGuard plugin for RuboCop项目地址:https://gitcode.com/gh_mirrors/gu/guard-rubocop