Skip to content

Vale prose style checker #2401

@wesley-dean-flexion

Description

@wesley-dean-flexion

Is your feature request related to a problem? Please describe.

I recently started using Vale to scan the documentation I write to make it more readable and accessible. So far, it's been pretty helpful at finding passive voice, sentences of excessive length, etc..

Describe the solution you'd like

It would be nice if MegaLinter included a linter for prose in addition to the extant linters, perhaps included in the documentation flavor.

Describe alternatives you've considered

There exist a variety of mechanisms to accomplish this outside of MegaLinter, such as via Docker image (jdkato/vale) or GitHub Action (LanguageTool with reviewdog or vale-linter).

Tangentially, before submitting this, I thought, "there are already actions to handle Vale -- this would be redundant!" and that would be a fair and reasonable response. Then I thought about Hadolint, Checkov, and flake8, all of which have actions published in the GitHub Actions Marketplace. As they're all included in MegaLinter, I think Vale's inclusion would be consistent with MegaLinter.

All of that said, I believe this feature suggestion -- in my humble opinion -- would likely be an extremely low-priority suggestion.

Additional context

Vale supports JSON output so a jq script may be able to coerce the results into something more-easily integrated with MegaLinter.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions