A regexp based customizable linterGet Started
rules: - id: com.example.github pattern: Github message: | GitHub is GitHub, not Github You may have misspelling the name of the service!
A Goodcheck rule
Define patterns with messages in a
goodcheck.yml file and run goodcheck within your repository. Any matching results will be displayed in the terminal.
rules: - id: com.sample.no_blink pattern: <blink message: | Stop using <blink> tag.
A rule with negated pattern
Goodcheck rules are usually to detect if something is included in a file. You can define the negated rules for the opposite, something is missing in a file.
rules: - id: com.sample.negated not: pattern: <!DOCTYPE html> message: | Write a doctype on HTML files. glob: "**/*.html"
A rule without pattern
You can define a rule without pattern. The rule emits an issue on each file specified with glob. You cannot omit glob from a rule definition without pattern.
rules: - id: com.sample.without_pattern message: | Read the operation manual for DB migration. See https://example.com/guides/123 glob: db/schema.rb
Stop reviewing the same patterns.