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

🛠 Repo: Consider adding a sentences-per-line linter #5053

Open
5 tasks done
JoshuaKGoldberg opened this issue Dec 27, 2023 · 0 comments
Open
5 tasks done

🛠 Repo: Consider adding a sentences-per-line linter #5053

JoshuaKGoldberg opened this issue Dec 27, 2023 · 0 comments
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team status: accepting prs Mocha can use your help with this one! type: chore generally involving deps, tooling, configuration, etc.

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Dec 27, 2023

Tooling Suggestion Checklist

Overview

I'm a fan of roughly enforcing that Markdown docs keep to one sentence per line. This is useful because:

  • Shorter lines result in simpler, easier-to-understand Git diffs
  • Longer lines are harder to read in source code

In #5038 I switched a large percentage of the Mocha docs to use that. It'd be nice to enforce this preference - if and only if we agree we like it.

Additional Info

Mentioned by @voxpelli in #5038 (comment).

Right now, https://github.com/JoshuaKGoldberg/sentences-per-line is a markdownlint plugin. We don't use markdownlint (yet?) and per JoshuaKGoldberg/create-typescript-app#567 I'd be very interested in using eslint-plugin-mdx for linting .md instead. TBD.

This isn't a very high priority item IMO. I'm not listing it in the Maintenance Reboot project. Someone yell at me if we actually should treat this with any urgency. 😄

@JoshuaKGoldberg JoshuaKGoldberg added status: needs review a maintainer should (re-)review this pull request area: repository tooling concerning ease of contribution labels Dec 27, 2023
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Mocha can use your help with this one! type: cleanup a refactor core-team issues which must be handled by Mocha's core team type: feature enhancement proposal type: chore generally involving deps, tooling, configuration, etc. and removed status: needs review a maintainer should (re-)review this pull request type: cleanup a refactor type: feature enhancement proposal labels Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team status: accepting prs Mocha can use your help with this one! type: chore generally involving deps, tooling, configuration, etc.
Projects
None yet
Development

No branches or pull requests

1 participant