brew/docs/vale-styles/Homebrew/Abbreviations.yml

---
extends: substitution
message: Use '%s' instead of '%s'.
ignorecase: false
link: "https://github.com/Homebrew/brew/blob/HEAD/docs/Prose-Style-Guidelines.md#style-and-usage"
level: error
nonword: true
swap:
  '\beg\b': e.g.
  '\bie\b': i.e.
  'e\.g\.,': e.g.
  'i\.e\.,': i.e.
  '(?<!^\{.*|\.|<)\borg\b': organisation
  '(?<!^\{.*)\borgs\b': organisations
  '(?<!^\{.*|<|\{#)\brepo\b': repository # FIXME: https://github.com/errata-ai/vale/issues/818
  '(?<!^\{.*)\brepos\b': repositories
  '\bivar\b': instance variable
  '\bivars\b': instance variables
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`---`
			`extends: substitution`
Lint Ruby docs. 2024-04-30 11:10:23 +02:00			`message: Use '%s' instead of '%s'.`
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`ignorecase: false`
vale-styles: Upgrade all checks to "error" level - I added these all the way back in December 2019 in #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. 2020-10-17 21:47:58 +01:00			`link: "https://github.com/Homebrew/brew/blob/HEAD/docs/Prose-Style-Guidelines.md#style-and-usage"`
Add Vale linting for our docs - I noticed that another open source project had taken the Homebrew style guide and made it into [Vale linting rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew). This copies them into here, so that we can make use of them. Thanks! - What use is a style guide if our own docs don't at least try to adhere to it? This aims to make the rules more visible to all contributors. - In order for these to do anything, you'll have to `brew install vale` and run `vale` in the root of this repo. It will look for Markdown files. - A next step would be adding this as a pre-commit hook, or... - The GitHub Action would have been really good, but [it doesn't support forks](https://github.com/errata-ai/vale-action#limitations). 2019-12-09 18:42:14 +00:00			`level: error`
			`nonword: true`
			`swap:`
			`'\beg\b': e.g.`
			`'\bie\b': i.e.`
			`'e\.g\.,': e.g.`
			`'i\.e\.,': i.e.`
Lint Ruby docs. 2024-04-30 11:10:23 +02:00			`'(?<!^\{.*\|\.\|<)\borg\b': organisation`
			`'(?<!^\{.*)\borgs\b': organisations`
			`'(?<!^\{.*\|<\|\{#)\brepo\b': repository # FIXME: https://github.com/errata-ai/vale/issues/818`
			`'(?<!^\{.*)\brepos\b': repositories`
			`'\bivar\b': instance variable`
			`'\bivars\b': instance variables`