Update dependency eslint-plugin-jsdoc to v34 - autoclosed #148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=60&v=4){kind=small}
renovate
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR contains the following updates:
^23.0.0->^34.0.0Release Notes
gajus/eslint-plugin-jsdoc
v34.6.0Compare Source
Features
no-multi-asterisksrule to prevent multiple asterisks with middle delimiters or at end of blocks (8848246)v34.5.0Compare Source
Features
multiline-blocks: allow control of how and whether jsdoc blocks can be expressed as single or multiple line blocks (06bbf37)v34.4.0Compare Source
Features
tag-line; fixes #93 (851e3fe)v34.3.0Compare Source
Features
check-values: ensure[@variation](https://togithub.com/variation)is a positive integer (56577ce)v34.2.2Compare Source
Bug Fixes
check-param-names: adjusts line numbers to be nearer problematic item (e6c9ab2)no-missing-syntax: pass in missingcomment(a977896)v34.2.1Compare Source
Bug Fixes
require-description,require-example: for missing description, use tag line number (310ea75)v34.2.0Compare Source
Features
no-bad-blocks: addpreventAllMultiasteriskBlocksboolean option to allow reporting of any multi-asterisked multiline comments (9669fc3)v34.1.0Compare Source
Features
check-line-alignment: addpreserveMainDescriptionPostDelimiteroption to preserve left-hand side spacings in the main description when using thealwaysoption. (54dac34)v34.0.2Compare Source
Bug Fixes
no-bad-blocks: avoid allowing 3+ asterisks with tag content (as with only 1 asterisk) (28397c7)v34.0.1Compare Source
Bug Fixes
v34.0.0Compare Source
chore
BREAKING CHANGES
Also:
Build: Switch to Node 12 target
Linting: Use
flatAPITravis: Add Node 16, remove Node 10
npm: Update devDep.
v33.3.0Compare Source
Features
check-line-alignment: allowtagsoption to apply with "always"; #703 (4421e4e)v33.2.0Compare Source
Features
v33.1.1Compare Source
Bug Fixes
v33.1.0Compare Source
Features
v33.0.0Compare Source
chore
@es-joy/jsdoccommentforgetJSDocCommentfunctionality (aa77e3b)BREAKING CHANGES
getJSDocCommentfile.Also updates Babel devDeps.
v32.3.4Compare Source
Bug Fixes
v32.3.3Compare Source
Bug Fixes
require-param,check-param-names: do not fail with destructured array pattern containing empty slots; fixes #716 (f19e706)v32.3.2Compare Source
Bug Fixes
check-line-alignment: prevent false never reporting where a space is present (post tag) followed by missing space (from a wholly missing type) and then a space (but a space first preceded by content (a name); fixes #714 (2c31db1)v32.3.1Compare Source
Bug Fixes
check-examples: disable chai-friendly/no-unused-expressions for default expression rules (06f0112)v32.3.0Compare Source
Features
check-tag-names: jsxTags an opt-in option for jsx annotations (8afb9fc)v32.2.0Compare Source
Features
check-types: checksettings.jsdoc.structuredTagsfor an array of permissible types, reporting if not present; fixes #695 (9dad3e0)no-undefined-types: allowstructuredTagstypes to be auto-defined (b7198e4)v32.1.1Compare Source
Bug Fixes
check-param-names,require-jsdoc,require-param: avoid erring uponMemberExpressionor other constructions within dynamic properties; fixes #699 (1cfdeb4)v32.1.0Compare Source
Features
require-jsdoc: allow checking for getter or setter only; fixes #515 (937d65e)v32.0.3Compare Source
Bug Fixes
require-jsdoc: more accurate and optimized decorator detection; fixes #697 (88655b3)v32.0.2Compare Source
Bug Fixes
match-description: while preserving internal newlines, ensure trailing whitespace is stripped for comparisons; for #692 (27b95b3)v32.0.1Compare Source
Bug Fixes
uflag forcheckTypesPatternoption forrequire-param,check-param-names; forcheck-values, default touflag and allow slashed regexes with own flags; formatch-description, allow slashed regexs with own flags; for all of the previous (andcheck-examples) allows newlines (4f0dc8e)v32.0.0Compare Source
Bug Fixes
[@example](https://togithub.com/example)frommdtomd/*.js. Only applies whenmatchingFileNameis not used. (2cc1227)BREAKING CHANGES
eslint-plugin-markdownv2 and its support of ESLint 7's new processor API, fenced blocks can (and must) be targeted separately from the Markdown parent file as a whole, so in order to allow the sameoverridesconfig to be reusable between Markdown fenced blocks and@exampletags (since one often wishes to disable the same kind of rules for each, being as that each may deliberately lack full context, e.g., undefined or unused variables), we update the default simulated extension set for@exampletags bycheck-examplesto simulate an expression which will now be a suitable choice foroverridesin targeting Markdown fenced blocks using the new parser API, as with eslint-plugin-markdown@2 (i.e., "md/*.js" instead of "md").If you need to use ESLint 6 (or eslint-plugin-markdown < 2, for example) with
check-examples, you should be able to manually supply thematchingFileNameoption targeting "md", e.g., set to'dummy.md.This commit also simplifies a testing example to avoid it throwing with changed config not having proper babel support (not meaningful to test anyways)
v31.6.1Compare Source
Bug Fixes
comment-parser; fixes #686 (7e0bbbe)v31.6.0Compare Source
Bug Fixes
require-returns,require-yields: support more AST checking (6fd8a07)require-yields: avoid checking nested generators (as with functions) (b9058e4)return-yields,return-yields-check: allow generator detection on exported; handle more AST types; fixes #682 (4e768aa)Features
require-returns-check: addexemptAsyncoption (0ed24c0)v31.5.0Compare Source
Bug Fixes
require-returns: check labeled statements (51f37f1)require-throws: check labeled statements (ceadcfe)require-yields: checktestpart of if expression and check conditionals (db001be)require-yields: check labeled statements (aceb7a0)Features
require-returns: if function returns a Promise whose executor resolves with undefined, avoid need to document unlessforceReturnsWithAsyncis set; fixes #550 (565fdbd)v31.4.0Compare Source
Bug Fixes
check-line-alignment: escape user tag name in regex (c0ae4cb)Features
check-line-alignment: allowtagsoption to configure which tags should be aligned. (780b8b5)v31.3.3Compare Source
Bug Fixes
check-line-alignment: apply alignment to return tags and avoid possibility for "never" option to insert extra space withreturns/returnas well as handle missing type (cb39556)v31.3.2Compare Source
Bug Fixes
Reverts
v31.3.1Compare Source
Bug Fixes
require-jsdocfixer (6bda6b4)v31.3.0Compare Source
Features
check-param-names: add optionsdisableExtraPropertyReportingto allow extra properties to be documented without error (as long as there are no siblings destructured as for such cases, they will still be expected since the function is not using them) (8b2d143)v31.2.3Compare Source
Bug Fixes
require-param,check-param-names: add optionuseDefaultObjectPropertiesfor expecting documentation or avoiding reporting of documented; addresses part of #676 (a36faf2)v31.2.2Compare Source
Bug Fixes
check-tag-names: should have previously auto-allowedsettings.jsdoc.structuredTagstags (5f586fd)v31.2.1Compare Source
Bug Fixes
v31.2.0Compare Source
Features
require-yields-check: add rule to check thatyield(of proper form) is present in the function body; fixes #354 (acf9529)v31.1.0Compare Source
Features
require-yields: add new rule to check thatyieldhas documentation; for #354 (e06fddd)require-yields: add options to check thatnexthas documentation (15daa12)v31.0.8Compare Source
Bug Fixes
no-undefined-types: supporttrueandfalseliterals (b8cb394)v31.0.7Compare Source
Bug Fixes
v31.0.6Compare Source
Bug Fixes
comment-parserto surface restoration of support for equal signs in defaults and multi-line types; fixes #669; fixes #673 (081d7eb)v31.0.5Compare Source
Bug Fixes
require-description-complete-sentence: regression re: not trimming of description for check as relevant to tag description checking; fixes #672 (d81caa2)v31.0.4Compare Source
Bug Fixes
v31.0.3Compare Source
Bug Fixes
newline-after-description: handle description on same line as opening asterisks; fixes #668 (040d177)v31.0.2Compare Source
Bug Fixes
check-line-alignment: implement defaultneveroptions; fixes #483 (b2db226)v31.0.1Compare Source
Bug Fixes
check-line-alignment: handle spaces in type and skip for single line (@renatho); closes #638 (577863b)v31.0.0Compare Source
chore
BREAKING CHANGES
Also updates:
require-description-complete-sentence- test to fix outputrequire-hyphen-before-param-description- test to preserve whitespace in fixed output (though still minus hyphen)require-param- test preserving whitespace4
require-jsdoc- test with no indentv30.7.13Compare Source
Bug Fixes
require-hyphen-before-param-description: regression failing to only check for hyphen at beginning; fixes #665 (acc3fc1)v30.7.12Compare Source
Bug Fixes
require-jsdoc: skip past type annotations when seeking backward through decorators; fixes #659 (62abd11)v30.7.11Compare Source
Bug Fixes
no-bad-blocks: avoid erring with/* */comment (4e6c73d)v30.7.10Compare Source
Bug Fixes
check-examples: disableno-newforcheck-examplesand default param checking (590d54e)require-hyphen-before-param-description: allow whitespace before hyphen when checking for hyphens; fixes #664 (fb906de)v30.7.9Compare Source
Bug Fixes
no-undefined-types: allowthis; fixes #660 (bda5959)v30.7.8Compare Source
Bug Fixes
check-examples: allow multiline captions; fixes #655 (8963394)v30.7.7Compare Source
Bug Fixes
require-jsdoc: regression causing uncommented nested syntax to be reported withpublicOnlyeven when export was commented; fixes #654 (bcd465f)v30.7.6Compare Source
Bug Fixes
check-examples: disable strict for expressions (245e4a7)v30.7.5Compare Source
Bug Fixes
v30.7.4Compare Source
Bug Fixes
templateproperly; fixes #653 (122a9b5)v30.7.3Compare Source
Bug Fixes
check-examples: Check defaults, params, properties as expressions (6163f3c)v30.7.2Compare Source
Bug Fixes
check-examples: usejsdoc-defaults,jsdoc-params, andjsdoc-propertiesas default extensions to allow these to have their own overrides (39fb1cb)v30.7.1Compare Source
Bug Fixes
check-examples: SetcheckDefaults,checkParams,checkPropertiesdefaults tofalse(2de1011)v30.7.0Compare Source
Features
check-examples: add optionscheckDefaults,checkParams,checkProperties; fixes #473 (262a474)v30.6.5Compare Source
Bug Fixes
valid-types: Ensuremoduletag operates as thoughmodule:prefix is present (so as to create valid namepath when valid); fixes #649 (2e0f2a6)v30.6.4Compare Source
Bug Fixes
require-jsdoc: for publicOnly ESM, adds direct ancestor check, allowing, e.g.,TSPropertySignatureandTSMethodSignature; fixes #647 (2b55275)v30.6.3Compare Source
Bug Fixes
require-jsdoc: Avoid error when comment block above export ofTSDeclareFunction; fixes #645 (0b95ba5)v30.6.2Compare Source
Bug Fixes
require-jsdoc: supportTSTypeAliasDeclarationwithpublicOnly(42a9b35)v30.6.1Compare Source
Bug Fixes
require-jsdoc: supportTSInterfaceDeclarationwithpublicOnly(3ae8e61)v30.6.0Compare Source
Features
ignoreInternalsetting to ignore blocks with[@internal](https://togithub.com/internal)tags; fixes #639 (80e16d0)v30.5.3Compare Source
Bug Fixes
no-bad-blocks: ensure reports bad blocks with descriptions (9a56863)v30.5.2Compare Source
Bug Fixes
require-jsdoc: allowcontextsto be usable in place ofrequireitems (a1d95e6)require-jsdoc: supportTSEnumDeclarationwithpublicOnly; fixes #640 (63ef3bc)v30.5.1Compare Source
Bug Fixes
check-line-alignment(ec71632)v30.5.0Compare Source
Features
check-line-alignment: add rule for line alignment (#636) (6e2b99d)v30.4.2Compare Source
Bug Fixes
check-param-names,require-param: support nested array destructuring (4f73e9c)v30.4.1Compare Source
Bug Fixes
check-param-names,require-param: properly check object parameters with default values; fixes #635 (7fc84e9)v30.4.0Compare Source
Features
require-example: addexemptNoArgumentsoption (#634) (c750c86)v30.3.3Compare Source
Bug Fixes
require-param,check-param-names: check deeply destructured parameters (fixes #569) (#630) (428174d)v30.3.2Compare Source
Bug Fixes
check-examples: disablejsdoc/require-file-overviewby default; fixes #633 (dd4a985)v30.3.1Compare Source
Bug Fixes
no-undefined-types: avoid checking private member of scopeManager; fixes #629 (d900a70)v30.3.0Compare Source
Bug Fixes
no-bad-blocks: allow TypeScript directive comments (41dcc19)Features
no-bad-blocks: make ignored tags customizable (a1e0c13)v30.2.4Compare Source
Bug Fixes
check-param-names: avoid erring uponTSCallSignatureDeclaration; fixes #624 (8341f97)v30.2.3Compare Source
Bug Fixes
no-defaults: adjust fixed AST to fully unsetdefaultas newcomment-parseradjustment would otherwise not wholly remove the default; also updates devDeps and tests use of opening jsdoc; fixes #568 (5cbc823)v30.2.2Compare Source
Bug Fixes
valid-types: Parse multiple names intemplatetags for non-jsdoc modes; fixes #622 (7818dde)v30.2.1Compare Source
Bug Fixes
check-examples: disable jsdoc/require-jsdoc (88c93bb)v30.2.0Compare Source
Features
require-param: addcheckDestructuredRootsoption; fixes #616 (3c06f09)v30.1.0Compare Source
Features
check-param-names: addcheckDestructuredoption to allow disabling of destructured checking; fixes part of #616 (c4d1b80)v30.0.3Compare Source
Bug Fixes
require-jsdoc: handleMethodDefinitioncontext without erring when usingexemptEmptyFunctionsandexemptEmptyConstructors; fixes #613 (08b5820)v30.0.2Compare Source
Bug Fixes
require-jsdoc: ensure conditionally checkingProperty/ObjectProperty/ClassPropertyas parents for arrow function expressions; fixes #612 (eac8357)v30.0.1Compare Source
Bug Fixes
require-jsdoc: avoid error withcheckConstructors: falsewhen attempting to check tags; fixes #611 (854fb24)v30.0.0Compare Source
Features
check-types,no-undefined-types,valid-types: AddstructuredTagssetting 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 #481 (89f2ad0)valid-types: changeallowEmptyNamepathsdefault tofalse, ensuring tags which expect names per docs will be reported (842381a)BREAKING CHANGES
check-types,no-undefined-types,valid-types: DropscheckSeesForNamepathssetting. 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.
typdefnow requiresallowEmptyNamepaths: false,to report empty names (as with other tags)4. Requires a name for
eventandexternal(andextendsin jsdoc mode); some tweaking of other tags per docsv29.2.0Compare Source
Features
require-description: report more precisely the action to take when "body"descriptionStyleis set and where user has a desc/description tag; fixes #608 (#609) (69fd79d)v29.1.4Compare Source
Bug Fixes
check-types,no-undefined-types,valid-types: In jsdoc mode, ensurethisonly checked for namepath; in TypeScript or Closure, ensurethischecked only for type (ef7b294)check-types,no-undefined-types,valid-types: In TypeScript or Closure, addtemplatefor checking of optional type and namepath (e305cce)v29.1.3Compare Source
Bug Fixes
v29.1.2Compare Source
Bug Fixes
check-param-names: ensure mismatching quoted vs. non-quoted tag name is not treated as an extra property (0c1c763)require-param: Object destructuring in function parameters if key is string | number (quoted or otherwise) (1842fd2)v29.1.1Compare Source
Bug Fixes
v29.1.0Compare Source
Features
check-types: allow two types (set one to the other inpreferredTypes); make this the default for typescript with "object"/"Object" (82ca868)v29.0.0Compare Source
chore
jsdoctypeparser(96dcdce)BREAKING CHANGES
Also adds support in typescript mode for
readonlyand intersections (X & Y)v28.7.0Compare Source
Features
require-jsdoc: addexemptEmptyConstructorsand settrueas default; fixes #600 (5409f25)v28.6.1Compare Source
Bug Fixes
require-throws: arrow function expressions should check body only; fixes #597 (e5387f1)v28.6.0Compare Source
Features
require-jsdoc: addenableFixeroption; if set tofalse, will avoid fixer; fixes #372 (c39fd75)v28.5.1Compare Source
Bug Fixes
valid-types: ensure checkingpropertytags for valid namepath (0f5996b)v28.5.0Compare Source
Bug Fixes
valid-types,no-undefined-types,check-types: have mode default totypescriptwhentypescript-eslint/parseris on; fixes #593 (8e9195a)Features
valid-types: forextends,packageand access tags (e.g.,private), report bracketed type in non-Closure mode; fixes #356 (c134928)v28.4.0Compare Source
Features
valid-types,no-undefined-types: checkmodulefor namepath in non-"typescript" mode; fixes part of #356 (947836a)v28.3.0Compare Source
Features
check-syntax: only check against Closure syntax in "jsdoc" and "typescript" mode; fixes part of #356 (8dfdd0b)v28.2.0Compare Source
Features
check-tag-names: for "closure" mode, prefer "return" over "returns"; fixes part of #356 (fceb74c)v28.1.0Compare Source
Features
valid-types: disallow namepath oninterfacetag for Closure mode; continue checking on jsdoc; fixes part of #356 (#587) (794aea8)v28.0.0Compare Source
Features
check-types,no-undefined-types,valid-types: use mode-aware type parsing; fixes part of #356; fixes #495 (6341e27)check-types,no-undefined-types,valid-types: use mode-aware type parsing; fixes part of #356; fixes #495 (#586) (f98a8e4)BREAKING CHANGES
check-types,no-undefined-types,valid-types: Requires Node 10+Also:
1. Adds "permissive" mode
2. Checks "param" for valid namepaths
check-types,no-undefined-types,valid-types: Requires Node 10+Also:
1. Adds "permissive" mode
2. Checks "param" for valid namepaths
3. Refactors to use updated/better Node 10+ syntax/packages
v27.1.2Compare Source
Bug Fixes
require-jsdoc: place comment block above any decorators; fixes #571 (d5f8159)v27.1.1Compare Source
Bug Fixes
no-undefined-types: if no scope found, resume checking current node for template tags; fixes #578, fixes #579 (fed7586)v27.1.0Compare Source
Features
require-throws: add rule (#574) (3d3c38b)v27.0.7Compare Source
Bug Fixes
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.
This PR has been generated by WhiteSource Renovate. View repository job log here.