Skip to content

Commit

Permalink
Update README --help out (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
blablatdinov authored Sep 23, 2024
1 parent a2e4c27 commit e4de9de
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,18 +55,32 @@ Usage: ondivi [OPTIONS]
Options:
--baseline TEXT Commit or branch which will contain legacy code. Program
filter out violations on baseline (default: "master")
--format TEXT Template for parsing linter messages. The template should include the following named parts:
--format TEXT Template for parsing linter messages. The template should
include the following named parts:
{filename} The name of the file with the error/warning
{line_num} The line number with the error/warning (integer)
{line_num} The line number with the error/warning
(integer)
Example usage:
--format "{filename}:{line_num:d}{other}"
In this example, the linter message
"src/app_types/listable.py:23:1: UP035 Import from collections.abc instead: Sequence"
will be recognized and parsed into the following components:
"src/app_types/listable.py:23:1: UP035 Import from
collections.abc instead: Sequence"
will be recognized and parsed into the following
components:
- filename: "src/app_types/listable.py"
- line_num: 23
- other: :1: UP035 Import from collections.abc instead: Sequence"
Ensure that the template matches the format of the messages generated by your linter.
- other: :1: UP035 Import from collections.abc instead:
Sequence"
Ensure that the template matches the format of the
messages generated by your linter.
(default: "{filename}:{line_num:d}{other}")
--only-violations Show only violations
--help Show this message and exit.
Expand Down

0 comments on commit e4de9de

Please sign in to comment.