Registry / testing / esdoc-lint-plugin

esdoc-lint-plugin

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

npm install esdoc-lint-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · ESDOC-LINT-PLUGIN

esdoc-lint-plugin

testingjavascriptv1.0.2

harness data pending

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.

default

✓ import LintPlugin from 'esdoc-lint-plugin'

✗ const LintPlugin = require('esdoc-lint-plugin')

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

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

✗ const E = require('esdoc-lint-plugin').E

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

Config

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

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

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

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 issues

deprecatedESDoc 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.

affects: >=1.0.0

gotchaESDoc 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.

affects: >=1.0.0

gotchaThe '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.

affects: >=1.0.0

Errors

Common errors & fixes

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

Package not installed or missing from node_modules.

fix

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

ESDoc Lint Plugin is not a valid plugin

Plugin object format incorrect in esdoc.json.

fix

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

Upgrade

Version history

1.0.2latest on npm

Audit

Dependencies

esdocrequiredRuntime peer dependency required for lint plugin to function

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/esdoc/esdoc-plugins ↗

packagehttps://www.npmjs.com/package/esdoc-lint-plugin ↗