vale
vale copied to clipboard
Title case rules error out when everything is already capitalized
Check for existing issues
- [X] Completed
Description
Rule:
extends: capitalization
message: "'%s' should be in title case"
level: error
scope: heading.md
match: $title
style: AP # AP or Chicago; only applies when match is set to $title.
exceptions:
- gRPC
Github Action:
name: reviewdog
on: [pull_request]
jobs:
vale:
runs-on: ubuntu-latest
steps:
..........
- name: reviewdog
uses: errata-ai/vale-action@reviewdog
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
with:
separator: ","
files: ${{ steps.files.outputs.added_modified }}
reporter: github-check
fail_on_error: true
I've not changed the configuration or github action for a few months and the rule was working as intended. These few days I've been noticing exceptions such as:
As you can see they're already in title case and Vale should not report an error.
What could have changed recently? Appreciate any pointer.
This issue is reproducible in v2.29.6. I rolled my github action back to use v2.29.4 and the issue is gone, so it's probably a bug.
This bug is also present in the repositories I manage.
My guess is that this https://github.com/errata-ai/vale/issues/706#issuecomment-1771748870 will resolved your problems.
@jdkato Sorry I don't quite get the suggestion here, could you elaborate?
So in the above screenshot I had a title Define Multiple Matching Rules which was already in the title case. None of these words are in my accept.txt and I can't think of any other rule that might affect it.
The idea is that one of the case-sensitive entries in your accept.txt is matching a word in the heading. See if disabling your vocabularies makes the error go away.
@meaghanfitzgerald, I'm nearly certain that this is the issue in your case (based on this file). If you follow the instructions in https://github.com/errata-ai/vale/issues/706#issuecomment-1771748870 (only one entry per term), the issue will go away.