Docs: LintMessage.line and column are possibly undefined #15032
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
In
lib/linter/linter.js
, theparse()
function's exception handler translates the exception's message to aLintMessage
. It also passes through the exception'slineNumber
andcolumn
, but the exception is not guaranteed to have those properties. In that case,LintMessage.line
andcolumn
can beundefined
.eslint/lib/linter/linter.js
Lines 693 to 711 in f966fe6
In eslint/eslint-plugin-markdown#191, the processor would crash when attempting to map messages without a line.
Is there anything you'd like reviewers to focus on?
Normally widening a type like this would be a breaking change, but since this is only updating the docs to reflect reality, I think this can be a semver-patch change.
For the JSDoc type, I used
{number|undefined} line
instead of{number} [line]
becauseline
andcolumn
are always present but may have the valueundefined
.