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 including / excluding individual checks by key #951

Closed
wants to merge 1 commit into from

Conversation

AlexRiina
Copy link

@AlexRiina AlexRiina commented Apr 28, 2019

This pull requests allows the end user to include or exclude individual tests as part of the config file. I was using this to lint a file where my markdown pipeline automatically converted ellipsis and quotes to their nicer html entity equivalents. Prior to this pull request, I could only disable the entire typography.symbols suite but my pipeline would not automatically convert a (c) so I didn't want to disable the whole suite.

Resolves #729. Resolves #491. Resolves #1091.

@Nytelife26
Copy link
Member

This is a very interesting proposition. At present the config does only allow enabling or disabling modules, rather than specific sub-checks. How do we feel about this, @suchow?

@Nytelife26 Nytelife26 added the status: awaiting-triage Issues and PRs awaiting investigation and relabelling. label May 24, 2021
@suchow
Copy link
Member

suchow commented May 24, 2021

First, there are three interrelated issues here:

  1. Proselint isn't Markdown-aware and so complains about syntax that's acceptable in Markdown but not in prose (e.g., ... vs. ). To sidestep this issue, @AlexRiina wanted to disable only some of the typographic checks. But we should also fix the underlying problem. I think there's an issue open for this already, somewhere; people run into it all the time.

2a. There is no mechanism to disable only some of a module's checks.

2b. If we create a mechanism to disable only some of a module's checks using the proposed approach, it's quality will depend on how well we are using the check namespace, breaking modules down into logical submodules that people would want to independently turn on and off.

I'm 👍 on allowing enabling/disabling submodules via the config and think it'll be useful to many people. I'm agnostic as to whether the current PR is the "right" way to do that; I defer to you. I think we should, perhaps as part of this PR or as a follow-on PR, review the whole namespace and see if there's anything obvious that should be renamed, split, or combined.

@Nytelife26
Copy link
Member

Nytelife26 commented May 24, 2021 via email

@Nytelife26 Nytelife26 added priority: null Issues and PRs that are of negligible importance so may be postponed. status: postponed Issues and PRs that are being temporarily set aside in favour of others. type: feat Issues and PRs related to new features. version: minor Issues and PRs with new features belonging to the next minor release. and removed status: awaiting-triage Issues and PRs awaiting investigation and relabelling. labels May 24, 2021
@Nytelife26
Copy link
Member

It occurs to me that actually, there is a more sensible way to do this. Many of our checks are formatted like so: check.subcheck. There is never any check.subcheck.subsubcheck. Why, then, are we grouping several subchecks into one file?

An easy way to solve this would be to make them individual, as they should be.

@Nytelife26 Nytelife26 added status: rejected Issues and PRs that have been denied and will not be worked on. and removed priority: null Issues and PRs that are of negligible importance so may be postponed. status: postponed Issues and PRs that are being temporarily set aside in favour of others. type: feat Issues and PRs related to new features. version: minor Issues and PRs with new features belonging to the next minor release. labels Jun 1, 2021
@Nytelife26 Nytelife26 closed this Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: rejected Issues and PRs that have been denied and will not be worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow disabling individual checks Support more than two keys in .proselintrc .proselintrc usage
3 participants