`TokenIgnores` does not seem to be taking effect

[andrewvaughan]

Check for existing issues

• Completed

Environment

• macOS
• Homebrew Install (also running MegaLinter and via the VSCode extension)
• vale version 2.29.5

.vale.ini:

##
# Vale prose linter
#
# Vale is a command-line and open source linting tool that allows developers to define and apply custom rules for
# documentation/editorial style guides. Incorporating Vale in documentation helps to detect errors and provides error-
# fixing suggestions.
#
# MegaLinter manages all execution of this linter.
#
# @link https://vale.sh/
# @link https://megalinter.io/beta/descriptors/spell_vale/
# @link https://vale.sh/docs/topics/config/
# @link https://vale.sh/explorer/
#

##
# The linter configuration root is the base for Vale styles
#
StylesPath = .config/linters/vale/styles

##
# Hardened consistency requires the most verbose option
#
# The default level is `warning` for projects that don't need stringent prose requirements
#
MinAlertLevel = suggestion

##
# By default, projects use the Google Developer Documentation Style Guide
#
# @link https://developers.google.com/style/
#
Packages = Google

##
# Two vocab sets exist for ops and the project
#
# This isn't used for spellcheck, as CSpell manages that. Instead, informs Vale what words to treat as proper nouns and
# capitalization standards.
#
# @link https://vale.sh/docs/topics/vocab/
#
Vocab = Ops, Project


##
# Global rules
#
[*]

##
# The Google style-guide is the default for these projects
#
BasedOnStyles = Vale, Google

##
# Don't lint URLs
#
# This is an interim fix until the Vale project resolves this for code linting.
#
# @link https://github.com/errata-ai/vale/issues/249
#
TokenIgnores = (https?:\/\/[^\n\s]+)

##
# The project disables spelling as the project uses CSpell for spellcheck
#
Vale.Spelling = NO

##
# Users of these projects understand common acronyms
#
Google.Acronyms = NO


##
# File extension associations
#
# @link https://vale.sh/docs/topics/config/#format-associations
# @link https://vale.sh/docs/topics/scoping/#code-1
#
[formats]

ini = pl
Makefile = pl
mak = pl
scss = sass

Describe the bug / provide steps to reproduce it

I've read through #320 - I thought it might be reasonable to simply ignore all URLs everywhere with a simple addition under [*] in the .vale.ini file:

[*]
TokenIgnores = (https?:\/\/[^\n\s]+)

https://regex101.com/r/Vc5TZO/1

That said, this doesn't work. Am I misunderstanding how TokenIgnores works? Ideally, I'd use a more robust expression like this, but I wanted to start simple:

TokenIgnores = (https?:\/\/(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b[-a-zA-Z0-9()@:%_\+.~#?&//=]*)

https://regex101.com/r/riG1Zx/1

It seems that no matter what I put in TokenIgnores it makes no difference. Adding .*, I expected it to ignore everything, but the behavior doesn't change. Is this a user error?

[andrewvaughan]

I've run this on Actions to help with debugging:

https://github.com/andrewvaughan/template-core/actions/runs/6580397179/job/17878287721?pr=51#step:4:245

This is using 2.28.1 given MegaLinter's monthly release cycle, but running this locally on the latest version of Vale gives the same results.

Here is the more advanced regex for TokenIgnores I used:

https://github.com/andrewvaughan/template-core/blob/ebc22e090ebac488b0bde43d24ee806fc2520fbc/.vale.ini#L75

The hope I have is to ignore the following in-line:

• https://... (all URLs)
• @.* (so that comments with @ directives don't get flagged)
• Inline code

As well as all code blocks with ``` via BlockIgnores

[andrewvaughan]

I've also noticed that <!-- vale off --> has stopped working... I can't tell if this is an issue with me or with the latest .5 release.

# Vale

Vale is a prose linter that ensures that these projects have easy-to-read, well executed documentation. While the
Project Maintainers recommend linting all files, currently, linting only occurs on documentation files such as Markdown.

## Installing Vale locally

Vale has detailed [installation instructions][vale-install] for any platform. The Project Maintainers also recommend
installing the [Vale extension][vale-extension] for VSCode, this project's preferred IDE, which helps to improve more
documentation areas, such as code comments.

`npx` can also run Vale, which is a standard dependency for this project.

## Updating configuration

<!-- vale off -->

Developers can add or modify Vale styles via the [`.vale.ini`](../../../.vale.ini) configuration file. It's critical
to update the local Vale style structure after doing so by updating the project's development dependencies:

\```bash
make dev-dependencies
\```

<!-- Link repository -->

[vale-extension]: https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server
[vale-install]: https://vale.sh/docs/vale-cli/installation/

Results in:

Every 2.0s: vale .config/linters/vale/README.md                                                                                  Andrews-MBP: Thu Oct 19 18:59:01 2023


 .config/linters/vale/README.md
 16:6   error  Use 'Vale' instead of 'vale'.  Vale.Terms
 18:53  error  Use 'Vale' instead of 'vale'.  Vale.Terms

✖ 2 errors, 0 warnings and 0 suggestions in 1 file.

[andrewvaughan]

Further research, it seems that whatever is linting the Markdown links is interfering with the linter's ability to turn off after. If I set vale off before any Markdown links are processed, it works fine. If vale off is put after any links (whether or not they have backticks) it fails.

[jdkato]

See #745 (comment).