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

Allow disabling individual checks #1091

Open
benknoble opened this issue Jul 21, 2020 · 2 comments · Fixed by #1081 · May be fixed by #1172
Open

Allow disabling individual checks #1091

benknoble opened this issue Jul 21, 2020 · 2 comments · Fixed by #1081 · May be fixed by #1172
Labels
cat: maintenance Issues and PRs related to the maintenance of a module. priority: high Issues and PRs that should be resolved as soon as possible. status: needs-help Issues and PRs that require volunteer assistance to proceed. type: feat Issues and PRs related to new features. version: minor Issues and PRs with new features belonging to the next minor release.

Comments

@benknoble
Copy link

Inspired by #1086 : almost all linters allow disabling individual checks (not just categories, as is the case today). Indeed, as someone who writes markdown in vim in a terminal, I really don't like or need "curly quotes"—ellipses, on the other hand, make perfect sense.

Having the ability to disable individual checks would be a great feature, and close both issues.

samcan added a commit to samcan/proselint that referenced this issue Sep 6, 2020
Creates list of individual subchecks which have been disabled by user in config
file and then removes them from the list of checks to be executed. Each
subcheck's function should start with 'check_'. The name of the check should
also match the function. For example: The subcheck
typography.symbols.curly_quotes would be the function check_curly_quotes in
typography.symbols. I saw that some subchecks have slightly different function
names and so these would need to be adjusted. An example is the subcheck
typography.symbols.copyright, which is the function check_copyright_symbol in
typography.symbols. To keep the tests running, I think this subcheck's name
should be adjusted to typography.symbols.copyright_symbol.
@benknoble
Copy link
Author

@Nytelife26 this needs re-opened (for some reason I cannot do so?). It has not been solved by the PR, which appears to allow me to say where the config file is.

What I want to do is allow a subset of typography.symbols, but not all of them. For example: I don't use curly quotes, but I do use ellipsis… and I want to configure proselint to match this style. I cannot do that with just the category-level granularity.

@Nytelife26 Nytelife26 reopened this May 25, 2021
@Nytelife26 Nytelife26 added the status: awaiting-triage Issues and PRs awaiting investigation and relabelling. label May 29, 2021
@Nytelife26 Nytelife26 linked a pull request Jun 1, 2021 that will close this issue
@Nytelife26 Nytelife26 added cat: maintenance Issues and PRs related to the maintenance of a module. priority: high Issues and PRs that should be resolved as soon as possible. status: needs-help Issues and PRs that require volunteer assistance to proceed. version: minor Issues and PRs with new features belonging to the next minor release. type: feat Issues and PRs related to new features. and removed status: awaiting-triage Issues and PRs awaiting investigation and relabelling. labels Sep 28, 2021
@thebergamo
Copy link

Is there any chance of this getting fixed? I could try to submit a PR if that would be ok :)

@Nytelife26 Nytelife26 added this to the 1.0.0 milestone Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat: maintenance Issues and PRs related to the maintenance of a module. priority: high Issues and PRs that should be resolved as soon as possible. status: needs-help Issues and PRs that require volunteer assistance to proceed. type: feat Issues and PRs related to new features. version: minor Issues and PRs with new features belonging to the next minor release.
Projects
None yet
3 participants