Add --additional-github-domain to check-vcs-permalinks #530
Conversation
|
|
||
| if args.github_enterprise_domain: | ||
| github_enterprise_non_permalink = re.compile( | ||
| NON_PERMALINK % args.github_enterprise_domain.encode(), |
There was a problem hiding this comment.
please don't use %s, if anything use .format() or f-strings -- thanks!
I notice this is a bytestring which doesn't support .format() or f-strings, but you can change it to not be a bytestring and then do .encode() afterwards as you've done for the domain
you can probably also inline the string as well
There was a problem hiding this comment.
Since the NON_PERMALINK is used only inside the function that converts the domain to a regular expression, I changed it to inline and used the f-string.
| NON_PERMALINK % args.github_enterprise_domain.encode(), | ||
| ) | ||
| for filename in args.filenames: | ||
| retv |= _check_filename(filename, github_enterprise_non_permalink) |
There was a problem hiding this comment.
this is going to re-parse twice, maybe add an additional argument to _check_filename such that it only runs over each file twice? this will also help with output ordering as well
There was a problem hiding this comment.
Rather than increasing the logic branch, using a list can make it simpler, so I tried using a list. I tried modifying action='append' to allow users to add more than one domain. How about this?
tests/check_vcs_permalinks_test.py
Outdated
| b'https://example.com/asottile/test/blob/master/foo%20bar\n' | ||
| # regression test for overly-greedy regex | ||
| b'https://example.com/ yes / no ? /blob/master/foo#L1\n', | ||
| ) |
There was a problem hiding this comment.
you can just use a simpler test, no need to re-test everything again
There was a problem hiding this comment.
Since the logic does not change even if the user specifies additional domains to check, I removed the previously wrote test cases and added a test case that fails. Are there any more test cases to add?
README.md
Outdated
| @@ -66,6 +66,7 @@ Attempts to load all TOML files to verify syntax. | |||
|
|
|||
| #### `check-vcs-permalinks` | |||
| Ensures that links to vcs websites are permalinks. | |||
| - `--github-enterprise-domain DOMAIN` - Add check for specified GitHub Enterprise domain. | |||
There was a problem hiding this comment.
maybe --additional-domain is simpler? it doesn't necessarily have to be github enterprise, just something with similar url structure
youngminz
changed the title
There was a problem hiding this comment.
since it looks like your company is using pre-commit, maybe consider sponsoring (I'm currently unemployed!)
|
Thanks to pre-commit, our team can reduce unnecessary convention discussions and have more productive business logic discussions! I hope my sponsor is helpful to you. |
<3 thanks! I really appreciate it! |
youngminz
changed the title
I have added an option to inspect the source code of the additional domain, especially useful on GitHub Enterprise.