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.

Sign up for GitHub

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

Jump to bottom

rubocop: Try out rubocop-md for linting the code in our docs #16518

Merged
merged 16 commits into from Feb 2, 2024
Merged

rubocop: Try out rubocop-md for linting the code in our docs #16518

merged 16 commits into from Feb 2, 2024

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Jan 21, 2024

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?
  • Maybe we can tidy up the code in our docs using this RuboCop extension to lint codeblocks in Markdown?

@issyl0
Copy link
Member Author

issyl0 commented Jan 21, 2024

cannot load such file -- rubocop-md Yes, I'm also getting this locally. But brew style on this branch initially runs install_bundler_gems, because of the Gemfile changes, and it does install the gem, so it should work? What am I missing? 🤔

@issyl0
Copy link
Member Author

issyl0 commented Jan 21, 2024

I figured it out! I was missing brew vendor-gems.

@apainintheneck
Copy link
Contributor

I'm kind of surprised that the number of offenses is so low.

@issyl0
Copy link
Member Author

issyl0 commented Jan 22, 2024

Oh, CI passing isn't representative, I've not got this working yet, but locally there are still 60-odd problems.

MikeMcQuaid
MikeMcQuaid reviewed Jan 22, 2024
View reviewed changes
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looking good so far, thanks @issyl0!

@issyl0 issyl0 force-pushed the rubocop-md branch 4 times, most recently from c759444 to 37fad74 Compare January 23, 2024 23:33
@issyl0
Add rubocop-md gem to the Gemfile in the style group
9786955 
- This could be useful for linting code in our docs.
@issyl0
Configure RuboCop to use rubocop-md
7c25ea6
@issyl0
brew vendor-gems for rubocop-md
e2251ad
@issyl0
Fix basic Ruby syntax errors in docs example code
28c513a 
- Blocks should open with `do` and close with `end`.
- `...` is not valid Ruby syntax, so comment it out so that the user
  knows that it's a placeholder for "other things here".
- Reword the "header line details" in `Cask-Cookbook` otherwise RuboCop
  crashes even with an `end` because of the empty block. There was
  already an example of a valid header line in the first code block on
  the page, so it's not a big loss.
@issyl0
Run brew style for docs as part of the docs CI job
1fe968e 
- Let's see how this goes.
@issyl0
Fix Sorbet/ group offenses in docs example code
6485324 
- T::Sig hasn't been needed in every file for a long time.
@issyl0
Fix RuboCop Layout/ group offenses in docs example code
af90f08
@issyl0
Fix RuboCop Style/ group offenses in docs example code
9b6903f
@issyl0
Fix RuboCop FormulaAudit/ group offenses for docs code examples
e5ae67f
@issyl0
Teach brew style about docs/.rubocop.yml
00b47d1 
- Yes, we have yet another `.rubocop.yml` but in-line exclusions in
  `<span class="display:none;">` in the Markdown seemed more ugly.
- This needed tweaks to `brew style` to make it read the new config
  file when we're scanning docs.
MikeMcQuaid
MikeMcQuaid reviewed Jan 24, 2024
View reviewed changes
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looking great so far, thanks @issyl0!

docs/.rubocop.yml Outdated Show resolved Hide resolved
@issyl0 issyl0 marked this pull request as ready for review January 27, 2024 19:03
MikeMcQuaid
MikeMcQuaid reviewed Jan 28, 2024
View reviewed changes
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looks pretty good, a few nits, thanks @issyl0!

docs/Adding-Software-to-Homebrew.md Outdated Show resolved Hide resolved
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
docs/Node-for-Formula-Authors.md Outdated Show resolved Hide resolved
MikeMcQuaid
MikeMcQuaid approved these changes Jan 31, 2024
View reviewed changes
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looks good! One suggestion, non-blocking.

docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
@issyl0
Ignore the generated manpage; reinstate its trailing whitespace
bcd3a78
@issyl0
Turn off FormulaAudit/{Desc,Homepage} for docs
ca92fca 
- We don't need this blanket enabled, we only have a few docs where it actually matters that there's a description, it's just cruft having to invent descriptions.
@issyl0 issyl0 enabled auto-merge February 2, 2024 15:40
@issyl0 issyl0 merged commit 06028c2 into Homebrew:master Feb 2, 2024
24 checks passed
@issyl0 issyl0 deleted the rubocop-md branch February 2, 2024 15:57
@chenrui333 chenrui333 mentioned this pull request Feb 3, 2024
Merged
9 tasks
@github-actions github-actions bot added the outdated PR was locked due to age label Mar 4, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@MikeMcQuaid MikeMcQuaid MikeMcQuaid approved these changes

Assignees
No one assigned
Labels
outdated PR was locked due to age
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@issyl0 @apainintheneck @MikeMcQuaid