Skip to content
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

feat: structuredTags setting to control type/name portions of existing or custom tags #610

Merged
merged 2 commits into from
Jul 19, 2020

Commits on Jul 15, 2020

  1. feat(check-types, no-undefined-types, valid-types): Add `struct…

    …uredTags` setting to control whether the type and namepath portions should be checked for validity and whether such portions are required, and to let user-defined "namepath-defining" tags be added to defined types. Closes gajus#481
    
    BREAKING CHANGE:
    
    Drops `checkSeesForNamepaths` setting. Use `{settings: {jsdoc: {structuredTags: {name: 'namepath', type: false, required: ['name'],}}}}` instead.
    
    Also:
    1. Clarifies in more cases where a problem is specific to the mode or not
    2. Reports simultaneous invalid name *and* type errors
    3. `typdef` now requires `allowEmptyNamepaths: false,` to report empty names (as with other tags)
    4. Requires a name for `event` and `external` (and `extends` in jsdoc mode); some tweaking of other tags per docs
    brettz9 committed Jul 15, 2020
    Configuration menu
    Copy the full SHA
    8281a64 View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2020

  1. feat(valid-types): change allowEmptyNamepaths default to false,…

    … ensuring tags which expect names per docs will be reported
    
    Also ensures `see` tag with only an inline link tag is not treated as empty.
    brettz9 committed Jul 18, 2020
    Configuration menu
    Copy the full SHA
    f151479 View commit details
    Browse the repository at this point in the history