- name: Run Vale Linter
        run: |
          docker run --rm -i \
          -v ${{ github.workspace }}:/repo \
          -w /repo \
          jdkato/vale --config=.vale/.vale.ini .

# Configuration for Vale, a syntax-aware linter for prose.

# Location of the Vale styles directory:
StylesPath = styles

# Minimum alert level to display (suggestion, warning, or error):
MinAlertLevel = suggestion

# List of third party styles to use:
Packages = proselint

# Custom vocabulary directory located in `config/vocabularies` for Spelling
Vocab = spoores

# Ignore repetition in msp430fr5964.h to remove false positives.
[*SpooresLeakValve/test/unit-tests/mocks/include/msp430fr5964.h]
Vale.Repetition = NO

# This section applies to all Markdown files.
[*.{md}]
BasedOnStyles = Vale, proselint, custom

# This section applies to all C,C++, and Python files.
[*.{h,c,cpp,.py}]
BasedOnStyles = Vale, proselint, custom

# Disabling Typography rule for C and H files to prevent false positives 
# on hexadecimal literals (e.g., 0x45), which are mistakenly flagged as 
# multiplication expressions by Proselint.
proselint.Typography = NO

# Disabling DateSpacing rule for C and H files to prevent false positives
# on variables that appear to contain times like P2PMgr appears to have 2 PM.
proselint.DateSpacing = NO

# Ignore Annotations (Tasks) because there is a custom rule for them.
proselint.Annotations = No

# Disable Spelling for C and H files to prevent false positives on
# variable names and function names. Spelling handled by custom Spelling.yml.
Vale.Spelling = NO

# Ignore all files in the doxygen-awesome-css directory.
[*doxygen-awesome-css/*]
BasedOnStyles =

# Ignore all files in the proselint directory.
[*proselint/*]
BasedOnStyles =