go.mondoo.com/cnquery@v0.0.0-20231005093811-59568235f6ea/.github/actions/spelling/README.md (about)

     1  # check-spelling/check-spelling configuration
     2  
     3  | File                                               | Purpose                                                         | Format                                                    | Info                                                                                                 |
     4  | -------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
     5  | [allow.txt](allow.txt)                             | Add words to the dictionary                                     | one word per line (only letters and `'`s allowed)         | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)                   |
     6  | [reject.txt](reject.txt)                           | Remove words from the dictionary (after allow)                  | grep pattern matching whole dictionary words              | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)     |
     7  | [excludes.txt](excludes.txt)                       | Files to ignore entirely                                        | perl regular expression                                   | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) |
     8  | [only.txt](only.txt)                               | Only check matching files (applied after excludes)              | perl regular expression                                   | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)         |
     9  | [patterns.txt](patterns.txt)                       | Patterns to ignore from checked lines                           | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
    10  | [line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines                               | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) |
    11  | [expect.txt](expect.txt)                           | Expected words that aren't in the dictionary                    | one word per line (sorted, alphabetically)                | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)                 |
    12  | [advice.md](advice.md)                             | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown                                           | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)     |
    13  
    14  Note: you can replace any of these files with a directory by the same name (minus the suffix)
    15  and then include multiple files inside that directory (with that suffix) to merge multiple files together.