Registry / testing / esdoc-lint-plugin

esdoc-lint-plugin

JSON →
library1.0.2jsnpmunverified

ESDoc Lint Plugin is a lint plugin for ESDoc documentation generator. Version 1.0.2 is the current stable release; the package is no longer actively developed as ESDoc itself is deprecated. It enables linting of documentation comments during the ESDoc generation process. Key differentiators: integrates directly with ESDoc pipeline, requires minimal configuration, and is the only dedicated lint plugin for ESDoc. However, note that ESDoc and its plugins are no longer maintained; users are advised to migrate to alternatives like TypeDoc or JSDoc.

testing
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

ESDoc plugins are typically loaded via configuration JSON, not imported directly. This import may not be used directly by users.

import LintPlugin from 'esdoc-lint-plugin'

The exported 'E' object is internal; not typically needed by users. Prefer configuration-based usage.

import { E } from 'esdoc-lint-plugin'

TypeScript type export for configuration; available only if types are defined.

import { Config } from 'esdoc-lint-plugin'

Shows how to install and configure the lint plugin in an ESDoc project.

// Install: npm install esdoc esdoc-lint-plugin // Use in esdoc.json: // { // "source": "./src", // "destination": "./doc", // "plugins": [ // {"name": "esdoc-lint-plugin", "option": {"enable": true}} // ] // } // Then run: npx esdoc
Debug
Known footguns
deprecatedESDoc and all its plugins are deprecated. Consider migrating to TypeDoc or JSDoc.
gotchaESDoc plugins are configured via JSON, not imported programmatically. Trying to use require or import in code will not work as expected.
gotchaThe 'enable' option defaults to true; setting it to false disables the lint plugin, which might be unintended.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
10 hits · last 30 days
claudebot
4
gptbot
3
ahrefsbot
3
Resources