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

chore(deps): update dependency eslint-plugin-jsdoc to v25 - autoclosed #436

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented May 9, 2020

This PR contains the following updates:

Package Type Update Change
eslint-plugin-jsdoc devDependencies major 18.11.0 -> 25.4.3

Release Notes

gajus/eslint-plugin-jsdoc

v25.4.3

Compare Source

Bug Fixes
  • require-jsdoc: ensure ArrowFunctionExpression potentially reported when part of AssignmentExpression; fixes #​551 (d8c4e87)

v25.4.2

Compare Source

Bug Fixes
  • require-returns: async with return should be documented; fixes #​518 (99476af)

v25.4.1

Compare Source

Bug Fixes
  • workaround for 'constructor' key in tagNamePreference; fixes #​537 (ed0fa4e)

v25.4.0

Compare Source

Features
  • require-param: add checkDestructured option; fixes #​530 (4df57a8)

v25.3.1

Compare Source

Bug Fixes
  • check-param-name, check-property-names, empty-tags, no-defaults, no-types, require-property: avoid mangled indent with fixers, e.g., on class methods (8d5d837)
  • require-description, implements-on-classes: fix constructor detection if MethodDefinition (including with any) is the context; fixes #​534 (1a69565)
  • require-returns, implements-on-classes, no-types: fix iterating function detection to include an explicit MethodDefinition context (82fb8c9)

v25.3.0

Compare Source

Features
  • check-param-names, check-property-names: add enableFixer option (3d5ee0c)

v25.2.1

Compare Source

Bug Fixes
  • check-param-names, require-param: check ExperimentalRestProperty from babel-eslint as with RestElement; fixes #​536 (d330391)

v25.2.0

Compare Source

Features
  • require-returns-description: avoid reporting missing descroptions for Promise<void> and Promise<undefined> (d855301)

v25.1.0

Compare Source

Features
  • require-jsdoc: support objects to contexts with a context and optional inlineCommentBlock property; fixes part of #​530 (548bd59)

v25.0.1

Compare Source

Bug Fixes
  • check-param-names, require-param: ignore TSIndexSignature; fixes #​529 (3f76c7c)

v25.0.0

Compare Source

Bug Fixes
  • require-param: allow checking for [@arg](https://togithub.com/arg) jsdoc param names if preferred (35088cb)
Features
  • check-param-names: checkRestProperty (and docs/tests) (7ce31e0)
  • check-param-names, require-param: check (and for require-param, fix) destructured objects and arrays, including the root. (a516865)
  • check-param-names, require-param: check (and for require-param, fix) destructured objects and arrays, including the root. (d906d1b)
  • require-param, check-param-names: checkTypesPattern (with docs, tests, and schema) (06add2f)
BREAKING CHANGES
  • check-param-names, require-param: Completes work on destructuring (prevents adding ...any for rest properties).

Works with renamed parameters and defaults and has special handling for rest elements/properties and type annotations.

For require-param: Adds options unnamedRootBase, autoIncrementBase, checkRestProperty, enableFixer, enableRootFixer, enableRestElementFixer, checkTypesPattern

For check-param-names: Add options checkRestProperty and checkTypesPattern

Also ensures indent is relative to applicable node, not whole source code; fix indents in tests

For testing, add output and cover more cases.

v24.0.6

Compare Source

Bug Fixes
  • comment-detection logic issue with function expressions within function declarations (e7720ec)

v24.0.5

Compare Source

Bug Fixes

v24.0.4

Compare Source

Bug Fixes
  • in conjunction with comment-parser update, remove last line break in last tag description for proper stringification (and fix old tests) (fdf129b)

v24.0.3

Compare Source

Bug Fixes
  • require-jsdoc: check above export for named exports; fixes #​526 (757d97a)

v24.0.2

Compare Source

Performance Improvements
  • only check moved settings if jsdoc settings exist (36ede65)

v24.0.1

Compare Source

Bug Fixes

v24.0.0

Compare Source

Bug Fixes
  • check-tag-names, empty-tags, require-description, require-example, require-param, require-returns: explicitly allow inheritDoc in all modes while only allowing inheritdoc in non-Closure mode; fixes #​520 (48fc58b)
Features
  • add a global option for checking constructors, getters or setters and remove avoidExampleOnConstructors option. (e5236a2)
Reverts
  • Revert "fix(check-tag-names, empty-tags, require-description, require-example, require-param, require-returns) explicitly allow inheritDoc in all modes while only allowing inheritdoc in non-Closure mode; fixes #​520" (d97c8f0), closes #​520
BREAKING CHANGES
  • Replaces the option avoidExampleOnConstructors for
    the require-example rule by checkConstructors

Also makes build-call platform independent and ensures env-variables work an all platforms.

v23.1.0

Compare Source

Features
  • require-param: further support for typescript functions; closes #​512 (fe637d5)

v23.0.1

Compare Source

Bug Fixes
  • require-jsdoc: allow requiring of MethodDefinition with publicOnly ESM export; fixes #​519 (dfde551)

v23.0.0

Compare Source

Features
  • require-description, require-example, require-param, require-returns: cause exemptedBy to overwrite inheritdoc exempting; closes #​510 (a402330)
BREAKING CHANGES
  • require-description, require-example, require-param, require-returns: While still defaulting to having inheritdoc exempt rules, for the impacted rules,
    if one has defined an exemptedBy options array one must now explicitly add
    back "inheritdoc" to get the exemption for that tag as well. This change allows
    users to omit inheritdoc from the array so as to cause its presence not to
    trigger exemption of the rule.

v22.2.0

Compare Source

Features

v22.1.0

Compare Source

Features
  • require-returns: add checkGetter option to be able to disable enforcement on getters (eb3cc84)

v22.0.1

Compare Source

Bug Fixes
  • require-jsdoc: ensure exemptEmptyFunctions doesn't attempt to apply when non-function contexts are in use (causing errors); fixes #​501 (7daf934)

v22.0.0

Compare Source

BREAKING CHANGES
  • Drops ESLint@5 support

v21.0.0

Compare Source

Bug Fixes
  • check-param-names, check-property-names, require-file-overview: avoid direct use of uncertain license of object.entries-ponyfill; closes #​487 (4403fb0)
BREAKING CHANGES
  • check-param-names, check-property-names, require-file-overview: Now requires Node >= 8

v20.4.0

Compare Source

Features

v20.3.1

Compare Source

Bug Fixes
  • check-values: allow [@version](https://togithub.com/version) and [@since](https://togithub.com/since) to have versions surrounded by whitespace (37466a8)

v20.3.0

Compare Source

Features
  • no-bad-blocks: add rule to check for multi-line-style comments which fail to meet criteria of a jsdoc block (4ce07d1)

v20.2.0

Compare Source

Features
  • no-defaults: add new rule to reports defaults on [@param](https://togithub.com/param) or [@default](https://togithub.com/default) and optionally report optional args; fixes #​477 (d7fec9a)

v20.1.0

Compare Source

Features
  • require-hyphen-before-param-description: add option to support checking property/prop (1383c02)

v20.0.5

Compare Source

Performance Improvements
  • check-examples: avoid caching unused config (6cbf286)

v20.0.4

Compare Source

Bug Fixes
  • no-types, require-param: fixable meta should be code not true (b0aed65)
  • require-file-overview: omit fixable meta on non-fixable rule (efddc1c)

v20.0.3

Compare Source

Bug Fixes
  • check-property-names: check duplicate nested names (1c31782)

v20.0.2

Compare Source

Bug Fixes
  • check-param-names: check duplicate nested names; fixes #​474 (c51d616)

v20.0.1

Compare Source

Bug Fixes
  • require-jsdoc: handle spread elements in typescript-eslint/parser; for #​378 (3e8ea59)

v20.0.0

Compare Source

Features
  • check-examples: apply rules by default as if on current JavaScript file (though with md extension for easier automated overriding); fixes #​434 (976cfc1)
refactoring
  • check-examples: rename eslintrcForExamples to checkEslintrc; also ensure matchingFileName always triggers config retrieval (5a85f0f)
BREAKING CHANGES
  • check-examples: This commit also clarifies new precedence and behavior in docs.

v19.2.0

Compare Source

Features
  • require-file-overview: allow user to specify whether checking for tag, duplicates, or preceding non-comments, and for which tags (f6e467e)

v19.1.0

Compare Source

Features
  • no-types, implements-on-classes: add contexts option which if set to any will allow checking of virtual functions (c4079b8)
  • require-param-*, require-returns-*, require-returns: allows contexts option to be set to "any" to check virtual function docs like [@callback](https://togithub.com/callback) or [@function](https://togithub.com/function) with [@interface](https://togithub.com/interface); fixes #​406 (7500b00)

v19.0.1

Compare Source

Bug Fixes
  • require-file-overview: fix logic for detecting start of file (601e52d)

v19.0.0

Compare Source

Features
  • check-property-names: add rule to check for duplicated and improperly nested properties (492b814)

  • require-property*: add rules for ensuring property tags have a name, type, and/or description (in any context); fixes #​409 (e5f2a23)

  • feat(require-property); add rule to check for property on typedef or namespace where the type is object; fixes #​410 (68bf6cd), closes #​410

BREAKING CHANGES
  • check-property-names: Adds new rule to recommended
  • require-property*: Adds rules to recommended
  • Adds new rule to recommended config.

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by WhiteSource Renovate. View repository job log here.

@commit-lint
Copy link

commit-lint bot commented May 9, 2020

Chore

  • deps: update dependency eslint-plugin-jsdoc to v25 (b3beb4c)

Contributors

@renovate-bot

@coveralls
Copy link

coveralls commented May 9, 2020

Coverage Status

Coverage remained the same at 100.0% when pulling b3beb4c on renovate/eslint-plugin-jsdoc-25.x into c5e24da on master.

@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-25.x branch 8 times, most recently from 8b3f25c to 6804644 Compare May 14, 2020 01:35
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-25.x branch from 6804644 to b5f45fd Compare May 18, 2020 09:56
@renovate renovate bot force-pushed the renovate/eslint-plugin-jsdoc-25.x branch from b5f45fd to b3beb4c Compare May 26, 2020 13:50
@renovate renovate bot changed the title chore(deps): update dependency eslint-plugin-jsdoc to v25 chore(deps): update dependency eslint-plugin-jsdoc to v25 - autoclosed May 28, 2020
@renovate renovate bot closed this May 28, 2020
@renovate renovate bot deleted the renovate/eslint-plugin-jsdoc-25.x branch May 28, 2020 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants