Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve rubocop setup #1139

Merged
merged 3 commits into from
Jul 17, 2024
Merged

Improve rubocop setup #1139

merged 3 commits into from
Jul 17, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Jul 12, 2024

  1. The previous rubocop rake task has been renamed to format_generated_files to express its intention clearer. The rubocop configs for this task now lives in .generated_files_rubocop.yml and is referenced explicitly in the new task's options.
  2. A new .rubocop.yml is added with very simple rules to serve as a starting point. bundle exec rubocop should be used to format RDoc's source code.
  3. A new lint job is created to enforce the rules in .rubocop.uml, and perform sanity check for the new format_generated_files task.

@st0012 st0012 force-pushed the improve-rubocop-setup branch from 78b1dd9 to f47979e Compare July 12, 2024 15:59
@st0012 st0012 requested a review from colby-swandale July 12, 2024 20:22
Copy link
Member

@colby-swandale colby-swandale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@st0012 st0012 merged commit 27932d0 into master Jul 17, 2024
45 checks passed
@st0012 st0012 deleted the improve-rubocop-setup branch July 17, 2024 20:43
matzbot pushed a commit to ruby/ruby that referenced this pull request Jul 17, 2024
(ruby/rdoc#1139)

* Rename rake rubocop to rake format_generated_files

* Add rubocop rules to ensure spaces are applied consistently

* Improve rubocop related CI workflows

ruby/rdoc@27932d001c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants