check-examples
: add options to allow checking @default
values and @param
/@property
defaults
#650
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.
feat(
check-examples
): add optionscheckDefaults
,checkParams
,checkProperties
; fixes #473This PR allows
check-examples
to also check the value of@default
/@defaultvalue
tags (which can include code subject to linting) as well as the default values of optional@param
or@property
tags.Also adds
matchingFileNameDefaults
,matchingFileNameParams
, andmatchingFileNameProperties
to simulate a file name which can cause content within these tags to be linted differently from@example
(by use ofoverrides
).