{"id":25468,"library":"esdoc2-lint-plugin","title":"esdoc2 Lint Plugin","description":"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.","status":"active","version":"2.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/esdoc2/esdoc2-plugins","tags":["javascript","esdoc2","lint","plugin"],"install":[{"cmd":"npm install esdoc2-lint-plugin","lang":"bash","label":"npm"},{"cmd":"yarn add esdoc2-lint-plugin","lang":"bash","label":"yarn"},{"cmd":"pnpm add esdoc2-lint-plugin","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"Plugin is configured as an esdoc2 plugin in esdoc.json, not imported in code.","wrong":"{\"name\": \"esdoc2-lint-plugin\", \"option\": {\"enable\": false}}","symbol":"esdoc2-lint-plugin","correct":"{\"name\": \"esdoc2-lint-plugin\"}"},{"note":"Option key is 'enable', not 'enabled'. Default is true.","wrong":"{\"name\": \"esdoc2-lint-plugin\", \"option\": {\"enabled\": true}}","symbol":"plugin object","correct":"{\"name\": \"esdoc2-lint-plugin\", \"option\": {\"enable\": true}}"}],"quickstart":{"code":"// Create esdoc.json\n{\n  \"source\": \"./src\",\n  \"destination\": \"./doc\",\n  \"plugins\": [\n    {\"name\": \"esdoc2-lint-plugin\", \"option\": {\"enable\": true}}\n  ]\n}\n\n// Run esdoc2\nnpx esdoc2","lang":"javascript","description":"Configures and runs esdoc2 with the lint plugin enabled, validating documentation."},"warnings":[{"fix":"Use 'enable' (not 'enabled') in the plugin option.","message":"Option key 'enable' is often misspelled as 'enabled'","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Consider migrating to a more active documentation tool like TypeDoc.","message":"esdoc2 itself is a fork of esdoc; original esdoc is deprecated. This plugin may follow the same fate.","severity":"deprecated","affected_versions":">=2.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 esdoc2-lint-plugin --save-dev'.","cause":"The plugin is not installed in the project's node_modules.","error":"Error: Cannot find module 'esdoc2-lint-plugin'"},{"fix":"Change 'enabled' to 'enable' in esdoc.json.","cause":"Used 'enabled' instead of 'enable' in the plugin option.","error":"Error: Invalid plugin option: enabled"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}