RuboCop GitHub Action 使用教程

RuboCop GitHub Action 使用教程

action-rubocopRun rubocop with reviewdog 🐶项目地址:https://gitcode.com/gh_mirrors/ac/action-rubocop

项目介绍

action-rubocop 是一个 GitHub Action，用于在您的 Ruby 代码库上运行 RuboCop，并将结果输出到 GitHub Checks UI 中。RuboCop 是一个 Ruby 代码风格检查和格式化工具，帮助开发者遵循 Ruby 社区的最佳实践和代码规范。

项目快速启动

安装步骤

1. 创建 GitHub Actions 工作流文件：在您的仓库中创建一个 .github/workflows/rubocop.yml 文件。
2. 添加以下内容到 rubocop.yml 文件：

name: RuboCop Linter

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Run RuboCop
      uses: reviewdog/action-rubocop@v3
      with:
        rubocop_version: latest
        rubocop_extensions: rubocop-rails,rubocop-performance:1.5.1,rubocop-minitest,rubocop-rspec:1.37.0
        reporter: github-check
        fail_on_error: true
      env:
        REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}

解释

• rubocop_version: 指定 RuboCop 的版本。
• rubocop_extensions: 指定 RuboCop 扩展的版本。
• reporter: 指定报告的格式，这里使用 github-check。
• fail_on_error: 如果 RuboCop 发现错误，是否使构建失败。

应用案例和最佳实践

应用案例

• 开源项目维护：在开源项目中使用 action-rubocop 可以帮助维护代码质量，确保所有贡献者遵循统一的代码风格。
• 企业内部项目：在企业内部项目中使用，可以统一团队成员的代码风格，减少代码审查的工作量。

最佳实践

• 定期更新 RuboCop 版本：保持 RuboCop 及其扩展的最新版本，以利用最新的代码检查规则和改进。
• 自定义配置文件：根据项目需求，自定义 RuboCop 配置文件，以适应特定的代码风格和规则。

典型生态项目

• RuboCop：核心的 Ruby 代码风格检查工具。
• RuboCop Rails：针对 Rails 项目的扩展。
• RuboCop Performance：针对性能优化的扩展。
• RuboCop Minitest：针对 Minitest 测试框架的扩展。
• RuboCop RSpec：针对 RSpec 测试框架的扩展。

通过结合这些扩展，可以更全面地检查和优化 Ruby 项目的代码质量。

action-rubocopRun rubocop with reviewdog 🐶项目地址:https://gitcode.com/gh_mirrors/ac/action-rubocop