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

docs/vale-styles: Bump all style violations to "error" level so they fail CI #8940

Merged
merged 3 commits into from Oct 21, 2020
Merged

docs/vale-styles: Bump all style violations to "error" level so they fail CI #8940

merged 3 commits into from Oct 21, 2020

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Oct 17, 2020

  • 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 tests with your changes locally?
  • Have you successfully run brew man locally and committed any changes?
  • I added these all the way back in December 2019 in Add Vale linting for our docs #6826, but only today (thanks to my Sorbet PR) realised that things have been failing unnoticeably because "warning" level exits with status code 0, so doesn't fail CI.
  • Upgrading to "error" level will enable us to see the style errors in our docs in every CI run and fix them faster.
  • My editor also auto-formatted the YAML to have double quotes instead of single. And I fixed all the remaining style failures, now I can see them!

@issyl0
Copy link
Member Author

issyl0 commented Oct 17, 2020 •
edited

I've attempted an upstream PR to fix (hopefully) the errors we're seeing with not being able to use / in capitalization exclusions any more.

On the upside, at least these "style failures" fail the CI build now!

@Rylan12
Copy link
Member

Rylan12 commented Oct 19, 2020 •
edited

Good catch! Should the rules for oxford commas and pronouns be upgraded to errors as well?

@MikeMcQuaid
Copy link
Member

Thanks @issyl0!

Good catch! Should the rules for oxford commas and pronouns be upgraded to errors as well?

Agreed. I don't personally see the point in any non-error rules as they will be ignored and the warnings be confusing when an actual error occurs.

@issyl0
Copy link
Member Author

issyl0 commented Oct 19, 2020

Should the rules for oxford commas and pronouns be upgraded to errors as well?

Good catch, that was an oversight rather than a deliberate choice. Done now, everything is at "error" level.

@issyl0
vale-styles: Add "macOS" to the titlecase exceptions list
d214d56 
- Otherwise this surfaces an error and suggests a fix that doesn't match
  Apple's branding.
@issyl0
vale-styles: Upgrade all checks to "error" level
c0642e1 
- I added these all the way back in December 2019 in Homebrew#6826, but only
  today realised that things have been failing unnoticeably because
  "warning" level exits with status code 0, so doesn't fail CI.
- Upgrading to "error" level will enable us to see the style errors in
  our docs and fix them faster.
- My editor also auto-formatted the YAML to have double quotes instead
  of single.
@issyl0
docs/typechecking: Titlecase the word "With"
e54980e 
- I don't necessarily agree with this, but it's AP style that words with
  four or more letters should start with a capital when in titles.
@issyl0 issyl0 merged commit 5efa3d6 into Homebrew:master Oct 21, 2020
@issyl0 issyl0 deleted the fix-vale branch October 21, 2020 21:09
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Dec 1, 2020
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Dec 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@MikeMcQuaid MikeMcQuaid MikeMcQuaid approved these changes

@Rylan12 Rylan12 Rylan12 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
4 participants
@issyl0 @Rylan12 @MikeMcQuaid @BrewTestBot