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

[BUG] summary-only and messages-only flags on .prospector.yaml not taken into account running pre-commit #484

Closed
pfernandesviz opened this issue Feb 8, 2022 · 1 comment

Comments

@pfernandesviz
Copy link

pfernandesviz commented Feb 8, 2022

Describe the bug
The flags summary-only and messages-only defined on a .prospector.yaml file are not taken into account running pre-commit.

To Reproduce
Steps to reproduce the behavior:

  1. Add messages-only: true in a .prospector.yaml
  2. Add prospector as a pre-commit hook
  3. Run pre-commit like: pre-commit run prospector --files [...]
  4. See that summary is present

Also happens with summary-only.

Expected behavior
The flags should work as expected defined in .prospector.yaml.

Environment:

  • OS: macOS Monterey 12.0.1
  • Tool: prospector/pre-commit
  • Prospector version: 1.6.0
  • Python version 3.7.9
@pfernandesviz pfernandesviz changed the title [BUG] summary-only and messages-only flags not taken into account running pre-commit [BUG] summary-only and messages-only flags on .prospector.yaml not taken into account running pre-commit Feb 8, 2022
@carlio
Copy link
Member

carlio commented Feb 28, 2022

--summary-only and --messages-only are not options which can be added to a profile.

They are CLI only options - they affect display, profiles are about changing what messages are generated.

I've added proper documentation to explain how to use the pre-commit hooks here - https://prospector.landscape.io/en/master/pre-commit.html

(Also had to fix up a couple of things with the pre-commit hook!)

@carlio carlio closed this as completed Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants