jsdoc-scribe API/packages/eslint-plugin-jsdoc-scribe/indexCurrent
Variables & Constants(15)
#requireJsdoc
line 19
const requireJsdoc: any
const
eslint-plugin-jsdoc-scribe ---------------------------------------- Flat-config ESLint plugin exposing the same 12 rule names jsdoc-scribe's `--lint` CLI flag ships in v1.18.0 (docs/backlog/adr-012-eslint-plugin-package.md, §5 — the ADR's section title says "9" but the rule list it enumerates has 12; that discrepancy is called out in sprint-12-scope.md's closeout note rather than silently ported through). `no-bad-blocks` is intentionally not included — it depends on jsdoc-scribe's TypeScript-Compiler-API malformed-comment detection (extractor.js's `badComment` field), which has no ESLint/ESTree equivalent (see ADR §2). Legacy `.eslintrc` config and autofixing (`--fix`) are both out of scope for v1 — see ADR §4 and §6.
Signature
const requireJsdoc: any
#requireParam
line 20
const requireParam: any
const
Signature
const requireParam: any
#requireParamDescription
line 21
const requireParamDescription: any
const
Signature
const requireParamDescription: any
#checkParamNames
line 22
const checkParamNames: any
const
Signature
const checkParamNames: any
#requireReturns
line 23
const requireReturns: any
const
Signature
const requireReturns: any
#requireReturnsDescription
line 24
const requireReturnsDescription: any
const
Signature
const requireReturnsDescription: any
#requireReturnsCheck
line 25
const requireReturnsCheck: any
const
Signature
const requireReturnsCheck: any
#requireDescription
line 26
const requireDescription: any
const
Signature
const requireDescription: any
#checkTagNames
line 27
const checkTagNames: any
const
Signature
const checkTagNames: any
#emptyTags
line 28
const emptyTags: any
const
Signature
const emptyTags: any
#noMultiAsterisks
line 29
const noMultiAsterisks: any
const
Signature
const noMultiAsterisks: any
#noBlankBlockDescriptions
line 30
const noBlankBlockDescriptions: any
const
Signature
const noBlankBlockDescriptions: any
#{ version }
line 32
const { version }: any
const
Signature
const { version }: any
const rules: Object
const
Signature
const rules: Object
#plugin
line 49
const plugin: Object
const
Signature
const plugin: Object