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 - v30.1.0

Published by gajus about 4 years ago

30.1.0 (2020-07-31)

Features

  • check-param-names: add checkDestructured option to allow disabling of destructured checking; fixes part of #616 (c4d1b80)
eslint-plugin-jsdoc - v30.0.3

Published by gajus over 4 years ago

30.0.3 (2020-07-20)

Bug Fixes

  • require-jsdoc: handle MethodDefinition context without erring when using exemptEmptyFunctions and exemptEmptyConstructors; fixes #613 (08b5820)
eslint-plugin-jsdoc - v30.0.2

Published by gajus over 4 years ago

30.0.2 (2020-07-20)

Bug Fixes

  • require-jsdoc: ensure conditionally checking Property/ObjectProperty/ClassProperty as parents for arrow function expressions; fixes #612 (eac8357)
eslint-plugin-jsdoc - v30.0.1

Published by gajus over 4 years ago

30.0.1 (2020-07-20)

Bug Fixes

  • require-jsdoc: avoid error with checkConstructors: false when attempting to check tags; fixes #611 (854fb24)
eslint-plugin-jsdoc - v30.0.0

Published by gajus over 4 years ago

30.0.0 (2020-07-19)

Features

  • check-types, no-undefined-types, valid-types: Add structuredTags setting 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: change allowEmptyNamepaths default to false, ensuring tags which expect names per docs will be reported (842381a)

BREAKING CHANGES

  • check-types, no-undefined-types, valid-types: Drops checkSeesForNamepaths setting. 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. typdef now requires allowEmptyNamepaths: false, to report empty names (as with other tags)
  4. Requires a name for event and external (and extends in jsdoc mode); some tweaking of other tags per docs
eslint-plugin-jsdoc - v29.2.0

Published by gajus over 4 years ago

29.2.0 (2020-07-13)

Features

  • require-description: report more precisely the action to take when "body" descriptionStyle is set and where user has a desc/description tag; fixes #608 (#609) (69fd79d)
eslint-plugin-jsdoc - v29.1.4

Published by gajus over 4 years ago

29.1.4 (2020-07-12)

Bug Fixes

  • check-types, no-undefined-types, valid-types: In jsdoc mode, ensure this only checked for namepath; in TypeScript or Closure, ensure this checked only for type (ef7b294)
  • check-types, no-undefined-types, valid-types: In TypeScript or Closure, add template for checking of optional type and namepath (e305cce)
eslint-plugin-jsdoc - v29.1.3

Published by gajus over 4 years ago

29.1.3 (2020-07-09)

Bug Fixes

  • with fixers, create proper inner indent (of an additional space) when a tab is in use; fixes #607 (4dfbc8d)
eslint-plugin-jsdoc - v29.1.2

Published by gajus over 4 years ago

29.1.2 (2020-07-09)

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)
eslint-plugin-jsdoc - v29.1.1

Published by gajus over 4 years ago

29.1.1 (2020-07-09)

Bug Fixes

  • Object destructuring in function parameters if key is string (#599) (64e1b64)
eslint-plugin-jsdoc - v29.1.0

Published by gajus over 4 years ago

29.1.0 (2020-07-08)

Features

  • check-types: allow two types (set one to the other in preferredTypes); make this the default for typescript with "object"/"Object" (82ca868)
eslint-plugin-jsdoc - v29.0.0

Published by gajus over 4 years ago

29.0.0 (2020-07-08)

chore

BREAKING CHANGES

    1. Adds spaces between union items per jsdoctypeparser update.
  1. Removes JSDuck support (unions with "/" instead of "|")

Also adds support in typescript mode for readonly and intersections (X & Y)

eslint-plugin-jsdoc - v28.7.0

Published by gajus over 4 years ago

28.7.0 (2020-07-08)

Features

  • require-jsdoc: add exemptEmptyConstructors and set true as default; fixes #600 (5409f25)
eslint-plugin-jsdoc - v28.6.1

Published by gajus over 4 years ago

28.6.1 (2020-07-01)

Bug Fixes

  • require-throws: arrow function expressions should check body only; fixes #597 (e5387f1)
eslint-plugin-jsdoc - v28.6.0

Published by gajus over 4 years ago

28.6.0 (2020-06-30)

Features

  • require-jsdoc: add enableFixer option; if set to false, will avoid fixer; fixes #372 (c39fd75)
eslint-plugin-jsdoc - v28.5.1

Published by gajus over 4 years ago

28.5.1 (2020-06-23)

Bug Fixes

  • valid-types: ensure checking property tags for valid namepath (0f5996b)
eslint-plugin-jsdoc - v28.5.0

Published by gajus over 4 years ago

28.5.0 (2020-06-23)

Bug Fixes

  • valid-types, no-undefined-types, check-types: have mode default to typescript when typescript-eslint/parser is on; fixes #593 (8e9195a)

Features

  • valid-types: for extends, package and access tags (e.g., private), report bracketed type in non-Closure mode; fixes #356 (c134928)
eslint-plugin-jsdoc - v28.4.0

Published by gajus over 4 years ago

28.4.0 (2020-06-23)

Features

  • valid-types, no-undefined-types: check module for namepath in non-"typescript" mode; fixes part of #356 (947836a)
eslint-plugin-jsdoc - v28.3.0

Published by gajus over 4 years ago

28.3.0 (2020-06-23)

Features

  • check-syntax: only check against Closure syntax in "jsdoc" and "typescript" mode; fixes part of #356 (8dfdd0b)
eslint-plugin-jsdoc - v28.2.0

Published by gajus over 4 years ago

28.2.0 (2020-06-23)

Features

  • check-tag-names: for "closure" mode, prefer "return" over "returns"; fixes part of #356 (fceb74c)
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