{"id":22097,"library":"rollup-plugin-jsdoc","title":"rollup-plugin-jsdoc","description":"A Rollup plugin that wraps JSDoc to generate API documentation during the build process. Version 0.1.2 is the latest release and appears to be in early development with low release cadence. It passes JSDoc CLI options through Rollup, allowing integration of documentation generation into the build pipeline. Differentiators: minimalistic, no magic, direct JSDoc configuration.","status":"active","version":"0.1.2","language":"javascript","source_language":"en","source_url":"https://github.com/fralonra/rollup-plugin-jsdoc","tags":["javascript","rollup-plugin","jsdoc"],"install":[{"cmd":"npm install rollup-plugin-jsdoc","lang":"bash","label":"npm"},{"cmd":"yarn add rollup-plugin-jsdoc","lang":"bash","label":"yarn"},{"cmd":"pnpm add rollup-plugin-jsdoc","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"core functionality - JSDoc is the documentation generator being wrapped","package":"jsdoc","optional":true},{"reason":"peer dependency – required to use as a Rollup plugin","package":"rollup","optional":true}],"imports":[{"note":"Package does not export a CommonJS default; use ESM import.","wrong":"const jsdoc = require('rollup-plugin-jsdoc');","symbol":"jsdoc","correct":"import jsdoc from 'rollup-plugin-jsdoc'"},{"note":"If using CommonJS, destructure default export.","wrong":"const jsdoc = require('rollup-plugin-jsdoc');","symbol":"jsdoc","correct":"const { default: jsdoc } = require('rollup-plugin-jsdoc');"},{"note":"The plugin is a default export, not named.","wrong":"import { jsdoc } from 'rollup-plugin-jsdoc'","symbol":"default","correct":"import jsdoc from 'rollup-plugin-jsdoc'"}],"quickstart":{"code":"// rollup.config.js\nimport jsdoc from 'rollup-plugin-jsdoc';\n\nexport default {\n  input: 'src/index.js',\n  output: {\n    file: 'dist/bundle.js',\n    format: 'cjs'\n  },\n  plugins: [\n    jsdoc({\n      args: ['-d', 'docs'],\n      config: 'jsdoc.config.json'\n    })\n  ]\n};","lang":"javascript","description":"Shows how to integrate the plugin into a Rollup config to generate JSDoc documentation in the 'docs' folder."},"warnings":[{"fix":"Move configuration file path to the 'config' option.","message":"Do not use '-c' or '--configure' in 'args' – use the 'config' option instead.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Run: npm install -D jsdoc","message":"JSDoc must be installed separately as a devDependency.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Pin version with exact version or use lockfile.","message":"Plugin is in early stage and may have breaking changes without major version bump.","severity":"deprecated","affected_versions":">=0.0.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"npm install -D jsdoc","cause":"JSDoc not installed as dependency.","error":"Error: Cannot find module 'jsdoc'"},{"fix":"import jsdoc from 'rollup-plugin-jsdoc'","cause":"Incorrect import style (named import instead of default).","error":"TypeError: jsdoc is not a function"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}