ESDoc Lint Plugin

1.0.2 verified Fri May 01 auth: no javascript deprecated

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.

Common errors

error Error: Cannot find module 'esdoc-lint-plugin' ↓

cause Package not installed or missing from node_modules.

fix

Run 'npm install esdoc-lint-plugin' in your project.

error ESDoc Lint Plugin is not a valid plugin ↓

cause Plugin object format incorrect in esdoc.json.

fix

Ensure plugin config follows format: {"name": "esdoc-lint-plugin", "option": {}}

Warnings

deprecated ESDoc and all its plugins are deprecated. Consider migrating to TypeDoc or JSDoc. ↓

fix Switch to a maintained documentation tool such as TypeDoc (for TypeScript) or JSDoc.

gotcha ESDoc plugins are configured via JSON, not imported programmatically. Trying to use require or import in code will not work as expected. ↓

fix Define plugin in esdoc.json under 'plugins' array.

gotcha The 'enable' option defaults to true; setting it to false disables the lint plugin, which might be unintended. ↓

fix Explicitly set 'enable' to true if you want linting, or omit to use default.

Install

npm install esdoc-lint-plugin

yarn add esdoc-lint-plugin

pnpm add esdoc-lint-plugin

Imports

default
wrong
```
const LintPlugin = require('esdoc-lint-plugin')
```
correct
```
import LintPlugin from 'esdoc-lint-plugin'
```
ESDoc plugins are typically loaded via configuration JSON, not imported directly. This import may not be used directly by users.
E
wrong
```
const E = require('esdoc-lint-plugin').E
```
correct
```
import { E } from 'esdoc-lint-plugin'
```
The exported 'E' object is internal; not typically needed by users. Prefer configuration-based usage.

Config

wrong

const Config = require('esdoc-lint-plugin').Config

correct

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

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

Quickstart

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