eslint-plugin-jsdoc

JSDoc specific linting rules for ESLint.

OTHER License

Downloads
9.7M
Stars
1.1K
Committers
104

Bot releases are hidden (Show)

eslint-plugin-jsdoc - v8.2.0

Published by gajus over 5 years ago

8.2.0 (2019-06-19)

Bug Fixes

  • add null checks (71aeacf)
  • check class declarations (10bb92e)
  • only modify window variable when browserEnv option is enabled (287232b)

Features

  • add public exports only option to require-jsdoc rule (abd2170), closes #192
eslint-plugin-jsdoc - v8.1.0

Published by gajus over 5 years ago

8.1.0 (2019-06-16)

Features

  • require-returns: add forceReturnsWithAsync (7e4369b)
  • require-returns: add forceReturnsWithAsync (bc184a4)
eslint-plugin-jsdoc - v8.0.2

Published by gajus over 5 years ago

8.0.2 (2019-06-16)

Bug Fixes

  • Stop warning missing param and returns tags if [@type](https://github.com/type) is present (f652d08)
eslint-plugin-jsdoc - v8.0.1

Published by gajus over 5 years ago

8.0.1 (2019-06-11)

Bug Fixes

  • allow [@memberof](https://github.com/memberof) and [@memberof](https://github.com/memberof)! to have a trailing member operator after their path (a949094)
eslint-plugin-jsdoc - v8.0.0

Published by gajus over 5 years ago

8.0.0 (2019-06-11)

  • Merge pull request #270 from brettz9/parent-types (805017c), closes #270
  • BREAKING CHANGE: change <> to no longer apply to SomeType.<> but instead to now support SomeType<> (22918c7)

BREAKING CHANGES

  • change <> to no longer apply to SomeType.<> but instead to now support SomeType<>
    feat: pseudo-type [] to catch parent array types of form string[], number[], etc.
    feat: support .<> as separate type
    fix: ensure working with nested type arrays/objects
    fix: ensure fixer preserves angle-bracket-dot or square bracket notation for arrays/objects
    chore: Update husky, semantic-release devDeps; add typescript devDep for type-fest peer dep. (used indirectly by husky and semantic-release)
  • through jsdoctypeparser update.
eslint-plugin-jsdoc - v7.2.3

Published by gajus over 5 years ago

7.2.3 (2019-05-30)

Bug Fixes

  • false positive with optional chaining (7015225), closes #182
eslint-plugin-jsdoc - v7.2.2

Published by gajus over 5 years ago

7.2.2 (2019-05-30)

Bug Fixes

  • require-hyphen-before-param-description: fix fixer to account for multiline descriptions (6873b03)
eslint-plugin-jsdoc - v7.2.1

Published by gajus over 5 years ago

7.2.1 (2019-05-30)

Bug Fixes

  • require-hyphen-before-param-description: fixer should insert hyphen in correct line (#176) (bca8d3c)
eslint-plugin-jsdoc - v7.2.0

Published by gajus over 5 years ago

7.2.0 (2019-05-29)

Features

  • check-alignment: add fixer (a05741a)
eslint-plugin-jsdoc - v7.1.0

Published by gajus over 5 years ago

7.1.0 (2019-05-28)

Features

  • add settings overrideReplacesDocs, augmentsExtendsReplacesDocs, implementsReplacesDocs and apply to require-param, require-description, require-example, and require-returns for exempting all of these from errors in the case of the presence of [@override](https://github.com/override), [@augments](https://github.com/augments)/[@extends](https://github.com/extends), or [@implements](https://github.com/implements), respectively. (9cc49a2)
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.
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