Skip to content

Vale suppression comments don't work for footnotes. #1078

@samcunliffe

Description

@samcunliffe

Check for existing issues

  • Completed

Environment

MacOS installed via Homebrew.
Also GitHub runners with ubuntu-latest installed via vale-action

❯ vale --version
vale version 3.13.1

Describe the bug / provide steps to reproduce it

This seems to have been reported in #927 which was closed (?)

mwe.md

Here is some text that has a footnote[^footnote-link].

<!-- vale proselint.Annotations = NO -->

[^footnote-link]: I want to keep Proselint-dot-Annotations enabled globally to flag up FIXMEs and TODOs. But! Annoyingly, there is a legitimate group called the [TODO Group](https://todogroup.org/) and I want to talk about them in a footnote.

<!-- vale proselint.Annotations = YES -->

Some more text, let's pretend that this is a longer document with other sections and other footnotes

vale.ini

StylesPath = .styles

# https://github.com/errata-ai/packages
Packages = proselint

[*.md]
BasedOnStyles = proselint

The comment suppressions turning off and on seem to break in chunks of footnotes...

❯ vale sync && vale mwe.md
Syncing proselint [1/1] █████████████████████████████████████████████ 100% | 0s
 SUCCESS  Synced 1 package(s) to '/Users/scnlf/projects/open-source-seed/mwe-vale/.styles'.

 mwe.md
 6:162  error  'TODO' left in text.  proselint.Annotations

✖ 1 error, 0 warnings and 0 suggestions in 1 file.

Which should be suppressed by the comments.

Have also tried <!-- vale off -->/<!-- vale on --> with the same results.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions