Skip to content

Commit 5d80b59

Browse files
authored
docs: specify that ruleId can be null in custom formatter docs (#18857)
Fixes #18856
1 parent 156b1c3 commit 5d80b59

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/src/extend/custom-formatters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,12 @@ Each object in the `results` array is a `result` object. Each `result` object co
106106

107107
Each `message` object contains information about the ESLint rule that was triggered by some source code. The properties available on each `message` object are:
108108

109-
* **ruleId**: the ID of the rule that produced the error or warning.
109+
* **ruleId**: the ID of the rule that produced the error or warning. If the error or warning was not produced by a rule (for example, if it's a parsing error), this is `null`.
110110
* **severity**: the severity of the failure, `1` for warnings and `2` for errors.
111111
* **message**: the human readable description of the error.
112112
* **line**: the line where the issue is located.
113113
* **column**: the column where the issue is located.
114-
* **nodeType**: the type of the node in the [AST](https://github.com/estree/estree/blob/master/es5.md#node-objects)
114+
* **nodeType**: the type of the node in the [AST](https://github.com/estree/estree/blob/master/es5.md#node-objects) or `null` if the issue isn't related to a particular AST node.
115115

116116
### The `context` Argument
117117

0 commit comments

Comments
 (0)