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.

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

Update README --help out #103

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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