A regexp based customizable linter
- id: com.example.githubmessage: | GitHub is GitHub, not Github You may have misspelling the name of the service!pattern: Github
index.html: 91: - <a>Signup via Github </a>: GitHub is GitHub, not Github
Define patterns with messages in a goodcheck.yml file and run goodcheck within your repository. Any matching results will be displayed in the terminal.
- id: com.sample.no-blinkmessage: | Stop using <blink> tagpattern: <blink
index.html:50: <h3> <blink> HTML5 Markup</blink></h3>: Stop using <blink> tag
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.
- id: com.sample.negatednot:message: | Write a doctype on HTML files.
pattern: <!DOCTYPE html>glob: **/*.html
index.html:-:<html lang="en">: Write a doctype on HTML files.
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.
- id: com.sample.without_pattern
message: | Read the operation manual for DB migration: https://example.com/guides/123glob: db/schema.rb
db/schema.rb:-:# This file is auto-generated from the current state of the database. Instead: Read the operation manual for DB migration: https://example.com/guides/123