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

make checks individual #1172

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

make checks individual #1172

wants to merge 6 commits into from

Conversation

Nytelife26
Copy link
Collaborator

This relates to...

The structure of checks directories.

Related issues:

Rationale

At present, some subcheck files (e.g. typography.symbols, redundancy.misc)
contain multiple subchecks. This is an illogical structure, prevents disabling
the subchecks in .proselintrc which should be possible, et cetera. This PR
fixes that by moving them into individual subcheck files, where they belong.

Changes

N/A (WIP).

Features

N/A.

Bug Fixes

N/A.

Breaking Changes and Deprecations

N/A.

@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: wip Issues and PRs that are still a work in progress. type: refactor Issues and PRs related to code cleanup. version: minor Issues and PRs with new features belonging to the next minor release. labels Jun 1, 2021
@codecov
Copy link

codecov bot commented Jun 1, 2021

Codecov Report

Merging #1172 (281e88c) into main (ae2161b) will not change coverage.
The diff coverage is n/a.

❗ Current head 281e88c differs from pull request most recent head 0b992d5. Consider uploading reports for the commit 0b992d5 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1172   +/-   ##
=======================================
  Coverage   90.19%   90.19%           
=======================================
  Files          83       83           
  Lines        1203     1203           
=======================================
  Hits         1085     1085           
  Misses        118      118           
Flag Coverage Δ
macos-latest 90.19% <0.00%> (ø)
py3.6 89.22% <0.00%> (ø)
py3.7 89.22% <0.00%> (ø)
py3.8 90.19% <0.00%> (ø)
py3.9 90.19% <0.00%> (ø)
pypypy3 89.22% <0.00%> (ø)
ubuntu-latest 90.19% <0.00%> (ø)
windows-latest 90.19% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae2161b...0b992d5. Read the comment docs.

@Nytelife26 Nytelife26 mentioned this pull request Sep 28, 2021
@Nytelife26
Copy link
Collaborator Author

Nytelife26 commented Nov 3, 2022

As an update, I think it would be better to make a plan for recategorising things before actually implementing the changes. Ideally, there will be some kind of framework as to what kind of checks are supported and determining where they belong.

Categories

nytelife26@[Elysian] » ls | where type == dir | skip | get name
╭────┬───────────────────╮
│  0 │ airlinese         │
│  1 │ annotations       │
│  2 │ archaism          │
│  3 │ cliches           │
│  4 │ consistency       │
│  5 │ corporate_speak   │
│  6 │ cursing           │
│  7 │ dates_times       │
│  8 │ hedging           │
│  9 │ hyperbole         │
│ 10 │ inprogress        │
│ 11 │ jargon            │
│ 12 │ lexical_illusions │
│ 13 │ lgbtq             │
│ 14 │ links             │
│ 15 │ malapropisms      │
│ 16 │ misc              │
│ 17 │ mixed_metaphors   │
│ 18 │ mondegreens       │
│ 19 │ needless_variants │
│ 20 │ nonwords          │
│ 21 │ oxymorons         │
│ 22 │ psychology        │
│ 23 │ redundancy        │
│ 24 │ security          │
│ 25 │ sexism            │
│ 26 │ skunked_terms     │
│ 27 │ spelling          │
│ 28 │ terms             │
│ 29 │ typography        │
│ 30 │ uncomparables     │
│ 31 │ weasel_words      │
╰────┴───────────────────╯

Squash

airlinese and corporate_speak into simply corporate_speak.
sexism and lgbtq into societal(? title WIP).

Uncertain

I think a lot of the content of cursing is somewhat beyond our scope. People only ever write those things when they mean to, and there are too many vulgar words around for us to accurately capture them.

@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: wip Issues and PRs that are still a work in progress. type: refactor Issues and PRs related to code cleanup. version: minor Issues and PRs with new features belonging to the next minor release.
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
1 participant