Skip to content

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

Open
@JoshuaKGoldberg

Description

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. 😄

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    area: repository toolingconcerning ease of contributioncore-teamissues which must be handled by Mocha's core teamstatus: accepting prsMocha can use your help with this one!type: choregenerally involving deps, tooling, configuration, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions