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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update eslint-plugin-jsdoc to the latest version 馃殌 #14

Merged
merged 1 commit into from
May 9, 2020

Conversation

greenkeeper[bot]
Copy link
Contributor

@greenkeeper greenkeeper bot commented May 9, 2020


馃毃 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 馃挏 馃殮馃挩 馃挌

Find out how to migrate to Snyk at greenkeeper.io


The devDependency eslint-plugin-jsdoc was updated from 24.0.6 to 25.0.0.

This version is not covered by your current version range.

If you don鈥檛 accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.


Publisher: gajus
License: BSD-3-Clause

Release Notes for v25.0.0

25.0.0 (2020-05-09)

Bug Fixes

  • require-param: allow checking for [@arg](https://github.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.

Commits

The new version differs by 82 commits.

  • 30835cd chore: update to eslint 7
  • a516865 feat(check-param-names, require-param): check (and for require-param, fix) destructured objects and arrays, including the root.
  • 3da81f4 Merge branch 'destructured-squashed' into ds/destructuring
  • d906d1b feat(check-param-names, require-param): check (and for require-param, fix) destructured objects and arrays, including the root.
  • 27c970d docs: remove comment
  • 06add2f feat(require-param, check-param-names): checkTypesPattern (with docs, tests, and schema)
  • d841e64 feat(require-param); checkRestProperty option
  • 7ce31e0 feat(check-param-names): checkRestProperty (and docs/tests)
  • 27795c3 - Begin work on reporting back whether rest is a property
  • a0f0fa6 - Return object with rest element so metadata can be used
  • 9e7cfaa INCOMPLETE: Implement/get tests/coverage passing
  • e0722ce - Implement enableRootFixer
  • 8de6c44 - Adjust unnamedRootBase behavior
  • cfc45f8 - require parent on type annotations
  • 45a79fd - Remove unused code

There are 82 commits in total.

See the full diff


FAQ and help

There is a collection of frequently asked questions. If those don鈥檛 help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper bot 馃尨

@codecov
Copy link

codecov bot commented May 9, 2020

Codecov Report

Merging #14 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #14   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          112       112           
  Branches        15        15           
=========================================
  Hits           112       112           

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 4a35f18...fee18ac. Read the comment docs.

greenkeeper bot added a commit that referenced this pull request May 9, 2020
@greenkeeper
Copy link
Contributor Author

greenkeeper bot commented May 9, 2020


馃毃 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 馃挏 馃殮馃挩 馃挌

Find out how to migrate to Snyk at greenkeeper.io


Update to this version instead 馃殌

Release Notes for v25.0.1

25.0.1 (2020-05-09)

Bug Fixes

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

The new version differs by 2 commits.

  • 3f76c7c fix(check-param-names, require-param): ignore TSIndexSignature; fixes #529
  • 3140735 docs: update docs

See the full diff

@shazron shazron merged commit 863ca4c into master May 9, 2020
@shazron shazron deleted the greenkeeper/eslint-plugin-jsdoc-25.0.0 branch May 9, 2020 09:36
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.

None yet

1 participant