eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.

OTHER License

Downloads
9.7M
Stars
1.1K
Committers
104
View Code on GitHub View on X
Ecosystems: ESLint

Bot releases are visible (Hide)

eslint-plugin-jsdoc - v7.0.2

Published by gajus over 5 years ago

7.0.2 (2019-05-24)

Bug Fixes

  • avoid errors when tags not present or invalidTypes is empty (cda6839)
eslint-plugin-jsdoc - v7.0.1

Published by gajus over 5 years ago

7.0.1 (2019-05-24)

Bug Fixes

  • require-returns: Ensure that [@returns](https://github.com/returns) {undefined} tags with return undefined are not reported (5c8a011)
eslint-plugin-jsdoc - v7.0.0

Published by gajus over 5 years ago

7.0.0 (2019-05-24)

  • Merge pull request #259 from brettz9/check-types-preferred-generic-specific (2605705), closes #259

BREAKING CHANGES

  • Cause preferredTypes setting not to apply by default to parent types; need to target type name with "<>" appended to target parent types (and only parent types); can alternatively; also adds option unifyParentAndChildTypeChecks to restore the old behavior

Allows for warning against overly generic types only (e.g., Array without its own children) or against the parent type only (to disallow Array.<someType>)

To restore old behavior, also target type names with "<>" or set the unifyParentAndChildTypeChecks option.

eslint-plugin-jsdoc - v6.0.3

Published by gajus over 5 years ago

6.0.3 (2019-05-22)

Bug Fixes

  • no-undefined-types: add "object" (as with "Object") to defined types fixes #249 (bb7c1ba)
  • require-returns: don't report with forceRequireReturn when tag is explicitly undefined/void (696d048)
  • valid-types: allow more namepath-defining tags by default (54d8bec)
eslint-plugin-jsdoc - v6.0.2

Published by gajus over 5 years ago

6.0.2 (2019-05-22)

Bug Fixes

  • implements-on-classes: had failed to check for tag itself; added test (a989204)
eslint-plugin-jsdoc - v6.0.1

Published by gajus over 5 years ago

6.0.1 (2019-05-22)

Performance Improvements

  • match-description: simplify and optimize default regex (af32667)
eslint-plugin-jsdoc - v6.0.0

Published by gajus over 5 years ago

6.0.0 (2019-05-21)

  • Merged pull request #248 from brettz9/object-default (05c24d1), closes #248 #164

BREAKING CHANGES

  • check-types now expects "object" instead of "Object"

Makes consistent with Typescript recommendation and fact that Object.create(null) is not instanceof Object but its typeof is object.

eslint-plugin-jsdoc - v5.0.2

Published by gajus over 5 years ago

5.0.2 (2019-05-15)

Bug Fixes

  • remove regexp unsupported by node 6 (2fb9326)
eslint-plugin-jsdoc - v5.0.1

Published by gajus over 5 years ago

5.0.1 (2019-05-15)

Bug Fixes

  • make checkTagNames report position more precise (557885d)
eslint-plugin-jsdoc - v5.0.0

Published by gajus over 5 years ago

5.0.0 (2019-05-15)

Features

BREAKING CHANGES

  • Node.js v4 is no longer supported. Next supported version is v6.
eslint-plugin-jsdoc - v4.8.4

Published by gajus over 5 years ago

4.8.4 (2019-05-11)

Bug Fixes

  • update GitSpo badge URL (0b04319)
eslint-plugin-jsdoc - v4.8.3

Published by gajus over 5 years ago

4.8.3 (2019-04-09)

Bug Fixes

eslint-plugin-jsdoc - v4.8.2

Published by gajus over 5 years ago

4.8.2 (2019-04-08)

Bug Fixes

  • require-returns-check false positive (2093ab5), closes #142
eslint-plugin-jsdoc - v4.8.1

Published by gajus over 5 years ago

4.8.1 (2019-04-08)

Bug Fixes

eslint-plugin-jsdoc - v4.8.0

Published by gajus over 5 years ago

4.8.0 (2019-04-04)

Features

  • add fixer to check-tag-names (22096fb)
  • add rule check-alignment (b596e09), closes #76
  • add rule check-indentation (42706cb)
  • add rule check-syntax (e03be63)
eslint-plugin-jsdoc - v4.7.0

Published by gajus over 5 years ago

4.7.0 (2019-04-01)

Features

  • make check-returns ignore abstract methods (7505604)
eslint-plugin-jsdoc - v4.6.0

Published by gajus over 5 years ago

4.6.0 (2019-03-28)

Features

  • add always/never options to require-hyphen-before-param-description (3e4ae0f)
eslint-plugin-jsdoc - v4.5.0

Published by gajus over 5 years ago

4.5.0 (2019-03-26)

Features

eslint-plugin-jsdoc - v4.4.3

Published by gajus over 5 years ago

4.4.3 (2019-03-19)

Bug Fixes

  • requireReturnsCheck false positve on async functions (fixes #174) (a47e157)
eslint-plugin-jsdoc - v4.4.2

Published by gajus over 5 years ago

4.4.2 (2019-03-15)

Bug Fixes

  • recognize implicit return in require-returns-check (fixes #156) (b8b9692)
  • recognize implicit return in require-returns-check (fixes #156) (3483159)
Package Rankings
Top 0.88% on Npmjs.org
Top 6.73% on Proxy.golang.org
Badges
Extracted from project README
NPM version Travis build status js-canonical-style Discord Chat
Related Projects
eslint-plugin-comment-length

ESLint rules that limits the line length of your comments.

08 Sep 2021 14
eslint-plugin-jest

ESLint plugin for Jest

08 Nov 2017 1,109
eslint-plugin-vitest

eslint plugin for vitest

02 Jan 2022 316
eslint-plugin-eslint-plugin

An ESLint plugin for linting ESLint plugins

13 Dec 2016 187
eslint-plugin-css

An ESLint plugin that provides rules to verify CSS definition objects.

09 Nov 2021 33
eslint-plugin-svelte

ESLint plugin for Svelte using AST

28 Apr 2021 253
eslint-plugin-lodash-template

ESLint plugin for John Resig-style micro template, Lodash's template, Underscore's template and EJS.

11 May 2018 17
eslint-plugin-node

Additional ESLint's rules for Node.js

23 Nov 2015 958
eslint-plugin-playwright

ESLint plugin for Playwright

30 Mar 2020 231
eslint-plugin-functional

ESLint rules to disable mutation and promote fp in JavaScript and TypeScript.

01 Jul 2019 792
eslint-plugin-ember

An ESLint plugin that provides set of rules for Ember applications based on commonly known good p...

08 Dec 2016 260
eslint-doc-generator

Automatic documentation generator for ESLint plugins and rules.

29 Sep 2022 91
eslint-config-prettier

Turns off all rules that are unnecessary or might conflict with Prettier.

29 Jan 2017 5,203
eslint-plugin-github

An opinionated collection of ESLint rules used by GitHub.

28 Mar 2016 295
markdown

Lint JavaScript code blocks in Markdown documents

01 Jul 2015 404