Skip to content

check-examples: add options to allow checking @default values and @param/@property defaults #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 19, 2020

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Oct 15, 2020

feat(check-examples): add options checkDefaults, checkParams, checkProperties; fixes #473

This 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, and matchingFileNameProperties to simulate a file name which can cause content within these tags to be linted differently from @example (by use of overrides).

Also add info on `internal` and missing tags to `empty-tags` and missing Tags section to `require-property-*`
@brettz9 brettz9 requested a review from golopot October 15, 2020 09:17
@brettz9 brettz9 merged commit 865cd65 into gajus:master Oct 19, 2020
@gajus
Copy link
Owner

gajus commented Oct 19, 2020

🎉 This PR is included in version 30.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Oct 19, 2020
@brettz9 brettz9 deleted the check-examples-defaults branch October 19, 2020 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lint default param/property values and @default/@defaultvalue
2 participants