bears/hypertext: Add HTTPoliceLintBear.py #1962
Conversation
|
CC @Makman2 |
yash-nisar
force-pushed
the
httpolice
branch
2 times, most recently
from
326dd15
to
3988b72
Compare
bears/hypertext/HTTPoliceLintBear.py
Outdated
|
|
||
| severity_map = {'E': RESULT_SEVERITY.MAJOR, | ||
| 'C': RESULT_SEVERITY.NORMAL, | ||
| 'D': RESULT_SEVERITY.INFO} |
There was a problem hiding this comment.
you have to provide this at @linter, not here^^
There was a problem hiding this comment.
Ohh, I've seen this mapping outside the decorator in many bears. Nvm will raise an issue
bears/hypertext/HTTPoliceLintBear.py
Outdated
| def create_arguments(filename, file, config_file, | ||
| silent: typed_list(str)=[]): | ||
| """ | ||
| :param silent: |
There was a problem hiding this comment.
hmm the name silent is very general, maybe you can make it more precise?
bears/hypertext/HTTPoliceLintBear.py
Outdated
| silent: typed_list(str)=[]): | ||
| """ | ||
| :param silent: | ||
| Silences the given list of notice IDs. |
There was a problem hiding this comment.
is there a sensible default list?
There was a problem hiding this comment.
Couldn't find one. Completely depends on the user IMO.
| @@ -0,0 +1,37 @@ | |||
| { | |||
| "_warning": "This is not a real HAR file! It only contains the keys that are interesting to HTTPolice. Please do not use this as an example of a valid HAR file.", | |||
There was a problem hiding this comment.
do you maybe have at least one real HAR file?
There was a problem hiding this comment.
Yes, I have collected a real valid HAR file manually, will update the tests.
There was a problem hiding this comment.
test_valid_file has a real HAR file
yash-nisar
force-pushed
the
httpolice
branch
2 times, most recently
from
3fed145
to
c56888c
Compare
|
@Makman2 Updated. |
bears/hypertext/HTTPoliceLintBear.py
Outdated
| def create_arguments(filename, file, config_file, | ||
| silence_ids: typed_list(str)=[]): | ||
| """ | ||
| :param silence_ids: |
There was a problem hiding this comment.
I actually meant to name the setting to something "HTTPolice" related ;)
The concept of silencing ids is not uncommon for other linters too, so we should disambiguate :)
E.g. silence_httpolice_ids (maybe look out for other linters that have also ids you can silence (I think BanditBear has this too), and try to adapt the naming scheme
bears/hypertext/HTTPoliceLintBear.py
Outdated
| silence_ids: typed_list(str)=[]): | ||
| """ | ||
| :param silence_ids: | ||
| Silences the given list of notice IDs. |
There was a problem hiding this comment.
The documentation shall also state that these IDs are defined by HTTPolice, so people know where to lookup those
|
Updated @Makman2 |
| :param httpolice_silence_ids: | ||
| Silences the given list of notice IDs. You can get more information | ||
| about the available notices and their IDs at | ||
| https://httpolice.readthedocs.io/en/stable/notices.html. |
There was a problem hiding this comment.
since it's RST, is a special syntax required for links?
|
ack 40dd5d4 |
1 similar comment
|
ack 40dd5d4 |
|
@rultor merge |
Closes #596
For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!
Checklist
them.
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!
After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.
Please consider helping us by reviewing other peoples pull requests as well:
cobot mark wip <URL>to get it outof the review queue.
The more you review, the more your score will grow at coala.io and we will
review your PRs faster!