{"id":25469,"library":"esdoc-lint-plugin","title":"ESDoc Lint Plugin","description":"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.","status":"deprecated","version":"1.0.2","language":"javascript","source_language":"en","source_url":"https://github.com/esdoc/esdoc-plugins","tags":["javascript","esdoc","lint","plugin"],"install":[{"cmd":"npm install esdoc-lint-plugin","lang":"bash","label":"npm"},{"cmd":"yarn add esdoc-lint-plugin","lang":"bash","label":"yarn"},{"cmd":"pnpm add esdoc-lint-plugin","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Runtime peer dependency required for lint plugin to function","package":"esdoc","optional":false}],"imports":[{"note":"ESDoc plugins are typically loaded via configuration JSON, not imported directly. This import may not be used directly by users.","wrong":"const LintPlugin = require('esdoc-lint-plugin')","symbol":"default","correct":"import LintPlugin from 'esdoc-lint-plugin'"},{"note":"The exported 'E' object is internal; not typically needed by users. Prefer configuration-based usage.","wrong":"const E = require('esdoc-lint-plugin').E","symbol":"E","correct":"import { E } from 'esdoc-lint-plugin'"},{"note":"TypeScript type export for configuration; available only if types are defined.","wrong":"const Config = require('esdoc-lint-plugin').Config","symbol":"Config","correct":"import { Config } from 'esdoc-lint-plugin'"}],"quickstart":{"code":"// Install: npm install esdoc esdoc-lint-plugin\n// Use in esdoc.json:\n// {\n//   \"source\": \"./src\",\n//   \"destination\": \"./doc\",\n//   \"plugins\": [\n//     {\"name\": \"esdoc-lint-plugin\", \"option\": {\"enable\": true}}\n//   ]\n// }\n\n// Then run: npx esdoc","lang":"javascript","description":"Shows how to install and configure the lint plugin in an ESDoc project."},"warnings":[{"fix":"Switch to a maintained documentation tool such as TypeDoc (for TypeScript) or JSDoc.","message":"ESDoc and all its plugins are deprecated. Consider migrating to TypeDoc or JSDoc.","severity":"deprecated","affected_versions":">=1.0.0"},{"fix":"Define plugin in esdoc.json under 'plugins' array.","message":"ESDoc plugins are configured via JSON, not imported programmatically. Trying to use require or import in code will not work as expected.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Explicitly set 'enable' to true if you want linting, or omit to use default.","message":"The 'enable' option defaults to true; setting it to false disables the lint plugin, which might be unintended.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'npm install esdoc-lint-plugin' in your project.","cause":"Package not installed or missing from node_modules.","error":"Error: Cannot find module 'esdoc-lint-plugin'"},{"fix":"Ensure plugin config follows format: {\"name\": \"esdoc-lint-plugin\", \"option\": {}}","cause":"Plugin object format incorrect in esdoc.json.","error":"ESDoc Lint Plugin is not a valid plugin"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}