Skip to content

๐Ÿš€ Feature: Move sentences-per-line into the formatter, Prettierย #2216

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Feature Request Checklist

Overview

Coming over from JoshuaKGoldberg/eslint-plugin-package-json#998 (comment): @michaelfaith brings up a good point that the "one sentence per line" enforcement currently implemented as a Markdownlint rule -https://github.com/JoshuaKGoldberg/sentences-per-line- is really more of a formatter concern.

Summarizing my interpretation (did I read it correctly?):

  • The biggest priority is encouraging folks to write docs, since that's often an afterthought & tough ask
  • The inconvenience of having a not-often-configured-by-default tool, especially a linter, conflicts with that priority
  • The net benefit of keeping to one sentence per line in docs is arguably lesser than the net cost of that inconvenience

Additional Info

I actually have been meaning to rework the other Prettier plugins used in this repo:

...but haven't had the time to really buckle down and figure out how to refactor, say, prettier-plugin-curly to the "right" way of doing things. Once that's figured out I think it'd be good to write a prettier-plugin-sentences-per-line or something like that.

Co-authored-by: @michaelfaith

๐ŸŽ

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: blockedWaiting for something else to be resolvedtype: featureNew enhancement or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions