Registry / testing / esdoc2-lint-plugin

esdoc2-lint-plugin

JSON →
library2.0.0jsnpmunverified

A lint plugin for esdoc2 that validates documentation comments against configured rules. Version 2.0.0 (latest 2.1.0) is the current stable release, with a low release cadence. It integrates into the esdoc2 build pipeline as a plugin, enabling lint checks on documentation output. Unlike standalone linters, it works within esdoc2's plugin system, requiring no additional tooling. Supports wildcards in manual file paths since v2.1.0.

testing
npm install esdoc2-lint-plugin
github ↗package ↗
INSTALL
IMPORT
SIG · ESDOC2-LINT-PLUGIN
E
esdoc2-lint-plugin
testingjavascriptv2.0.0
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.

esdoc2-lint-plugin
✓ {"name": "esdoc2-lint-plugin"}
✗ {"name": "esdoc2-lint-plugin", "option": {"enable": false}}
Plugin is configured as an esdoc2 plugin in esdoc.json, not imported in code.
plugin object
✓ {"name": "esdoc2-lint-plugin", "option": {"enable": true}}
✗ {"name": "esdoc2-lint-plugin", "option": {"enabled": true}}
Option key is 'enable', not 'enabled'. Default is true.

Configures and runs esdoc2 with the lint plugin enabled, validating documentation.

// Create esdoc.json { "source": "./src", "destination": "./doc", "plugins": [ {"name": "esdoc2-lint-plugin", "option": {"enable": true}} ] } // Run esdoc2 npx esdoc2
Debug
Known issues
gotchaOption key 'enable' is often misspelled as 'enabled'
fix
Use 'enable' (not 'enabled') in the plugin option.
affects: >=2.0.0
deprecatedesdoc2 itself is a fork of esdoc; original esdoc is deprecated. This plugin may follow the same fate.
fix
Consider migrating to a more active documentation tool like TypeDoc.
affects: >=2.0.0
Errors
Common errors & fixes
Error: Cannot find module 'esdoc2-lint-plugin'
The plugin is not installed in the project's node_modules.
fix
Run 'npm install esdoc2-lint-plugin --save-dev'.
Error: Invalid plugin option: enabled
Used 'enabled' instead of 'enable' in the plugin option.
fix
Change 'enabled' to 'enable' in esdoc.json.
Upgrade
Version history
2.0.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/esdoc2/esdoc2-plugins ↗
packagehttps://www.npmjs.com/package/esdoc2-lint-plugin ↗
esdoc2-lint-plugin — npm install esdoc2-lint-plugin · libregistry