sarif.json

{
  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
  "version": "2.1.0",
  "properties": {
    "comment": "check-spelling test"
  },
  "runs": [
    {
      "tool": {
        "driver": {
          "name": "check-spelling",
          "informationUri": "https://github.com/check-spelling/check-spelling",
          "rules": [
            {
              "id": "unrecognized-spelling",
              "name": "UnrecognizedSpelling",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#unrecognized-spelling",
              "shortDescription": {
                "text": "Unrecognized Spelling"
              },
              "fullDescription": {
                "text": "Token is neither in the dictionary nor expected"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Correct spelling\n- Add to [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)\n- Mask using [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n\n"
              },
              "defaultConfiguration": {
                "level": "error"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "error",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "forbidden-pattern",
              "name": "ForbiddenPattern",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#forbidden-pattern",
              "shortDescription": {
                "text": "Forbidden Pattern"
              },
              "fullDescription": {
                "text": "Forbidden pattern matched this text"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Alter text so the pattern does not match\n- Add a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns) to patterns.txt that matches (a portion of) the flagged content to accept it\n- Delete, edit, or comment out the pattern\n\n"
              },
              "defaultConfiguration": {
                "level": "error"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "error",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "noisy-file",
              "name": "NoisyFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#noisy-file",
              "shortDescription": {
                "text": "Noisy File"
              },
              "fullDescription": {
                "text": "There were more non-words than dictionary words in the file"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the file to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Add more words to the dictionary\n- Use patterns to mask tokens.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "recommendation",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "noisy-file-list",
              "name": "NoisyFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#noisy-file-list",
              "shortDescription": {
                "text": "Noisy File List"
              },
              "fullDescription": {
                "text": "There were more non-words than dictionary words in the file list"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Disable [`check_file_names`](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Add more words from file paths/names to the dictionary\n- Use patterns to mask tokens.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "recommendation",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "large-file",
              "name": "LargeFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#large-file",
              "shortDescription": {
                "text": "Large File"
              },
              "fullDescription": {
                "text": "File is very large"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the file to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Adjust 'largest_file' in action configuration if you want to check the file."
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "limited-references",
              "name": "LimitedReferences",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#limited-references",
              "shortDescription": {
                "text": "Limited References"
              },
              "fullDescription": {
                "text": "There were an excessive number of uses of this token. Not all instances are identified."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add word to the [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)\n- Correct the spelling\n- To see more instances, increase action configuration \"unknown_word_limit\".\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "candidate-pattern",
              "name": "CandidatePattern",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#candidate-pattern",
              "shortDescription": {
                "text": "Candidate Pattern"
              },
              "fullDescription": {
                "text": "A line with unrecognized tokens matches a pattern. Patterns enable the tool to ignore content."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the pattern to [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n- Remove the pattern from candidates.patterns\n\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "recommendation",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "bad-regex",
              "name": "BadRegex",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#bad-regex",
              "shortDescription": {
                "text": "Bad Regex"
              },
              "fullDescription": {
                "text": "Perl did not like the regular expression pattern."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Correct the [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n- See [bad-regex](https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#bad-regex)\n- Remove the pattern.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "error",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "dictionary-not-found",
              "name": "DictionaryNotFound",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#dictionary-not-found",
              "shortDescription": {
                "text": "Dictionary not found"
              },
              "fullDescription": {
                "text": "The specified dictionary could not be found."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Correct the dictionary address.\n- Check the [dictionary_source_prefixes](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary_source_prefixes)\n- Remove the entry.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "no-newline-at-eof",
              "name": "NoNewlineAtEOF",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#no-newline-at-eof",
              "shortDescription": {
                "text": "No newline at EOF"
              },
              "fullDescription": {
                "text": "The specified file is missing a newline at the end of the file."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add a blank line to the end of the file.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "recommendation",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "non-alpha-in-dictionary",
              "name": "NonAlphaInDictionary",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#non-alpha-in-dictionary",
              "shortDescription": {
                "text": "Non-alpha in dictionary"
              },
              "fullDescription": {
                "text": "The dictionary entry has non-alpha characters."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Remove non-alpha characters\n- Place each word on its own line\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "recommendation",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },            {
              "id": "check-file-path",
              "name": "CheckFilePath",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#check-file-path",
              "shortDescription": {
                "text": "Check File Path"
              },
              "fullDescription": {
                "text": "Token in file path is neither in the dictionary nor expected"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\nNote that this check is against the file path not the displayed line.\n- Rename file/directory to correct spelling\n- Add to [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)\n- Mask using [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n\n"
              },
              "defaultConfiguration": {
                "level": "error"
              },
              "properties": {
                "precision": "high",
                "problem.severity": "error",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "minified-file",
              "name": "MinifiedFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#minified-file",
              "shortDescription": {
                "text": "Minified File"
              },
              "fullDescription": {
                "text": "File has incredibly long lines, perhaps it's minified?"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the file to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Add 'minified-file' to 'disable_checks' in the configuration.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "duplicate-extra-dictionary",
              "name": "DuplicateExtraDictionary",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#duplicate-extra-dictionary",
              "shortDescription": {
                "text": "Duplicate Extra Dictionary"
              },
              "fullDescription": {
                "text": "Workflow 'extra_dictionaries' contains multiple entries for the same dictionary"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Remove duplicate entries. check-spelling will ignore duplicate instances.\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "utf16-surrogate",
              "name": "Utf16Surrogate",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#utf16-surrogate",
              "shortDescription": {
                "text": "UTF-16 Surrogate"
              },
              "fullDescription": {
                "text": "File contains a utf-16 surrogate. It's likely not a text file."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the file to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "medium",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "binary-file",
              "name": "BinaryFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#binary-file",
              "shortDescription": {
                "text": "Binary File"
              },
              "fullDescription": {
                "text": "File magic determined to be binary. It's likely not a text file."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the file to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Disable `use_file_magic`\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "low",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "token-is-substring",
              "name": "TokenIsSubstring",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#token-is-substring",
              "shortDescription": {
                "text": "Token is a substring"
              },
              "fullDescription": {
                "text": "While trying to find the token in the line, the exact instance could not be found."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the entry to [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)\n- Correct any overeager [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n- See [Feature: Warning about substring matches](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Warning-about-substring-matches)\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "low",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "slow-file",
              "name": "SlowFile",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#slow-file",
              "shortDescription": {
                "text": "Slow file"
              },
              "fullDescription": {
                "text": "Parsing the file exceeded the parsing timeout."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Add the entry to [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Adjust [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration#patterns)\n- Adjust the [timeout](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Parsing-Timeouts#configuration)\n- See [Feature: Parsing Timeouts](https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Parsing-Timeouts)\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "low",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "ignored-expect-variant",
              "name": "IgnoredExpectVariant",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#ignored-expect-variant",
              "shortDescription": {
                "text": "Ignored Expect Variant"
              },
              "fullDescription": {
                "text": "Multiple related word variants listed in expect"
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Remove the entry from [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "low",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            },
            {
              "id": "no-files-to-check",
              "name": "NoFilesToCheck",
              "helpUri": "https://github.com/check-spelling/check-spelling/wiki/Event-descriptions#no-files-to-check",
              "shortDescription": {
                "text": "No files to check"
              },
              "fullDescription": {
                "text": "After applying any excludes and only patterns, no files were found to check."
              },
              "help": {
                "text": "?",
                "markdown": "**Remediation (click \"Show more\" below)**:\n\n- Remove or fix patterns in [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration#excludes)\n- Remove or broaden patterns in [only](https://github.com/check-spelling/check-spelling/wiki/Configuration#only)\n\n"
              },
              "defaultConfiguration": {
                "level": "warning"
              },
              "properties": {
                "precision": "low",
                "problem.severity": "warning",
                "tags": [
                  "source-code",
                  "code-reviews"
                ]
              }
            }
          ]
        }
      },
      "results": []
    }
  ]
}