rollup-plugin-jsdoc

0.1.2 verified Mon Apr 27 auth: no javascript

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.

Common errors

error Error: Cannot find module 'jsdoc' ↓

cause JSDoc not installed as dependency.

fix

npm install -D jsdoc

error TypeError: jsdoc is not a function ↓

cause Incorrect import style (named import instead of default).

fix

import jsdoc from 'rollup-plugin-jsdoc'

Warnings

gotcha Do not use '-c' or '--configure' in 'args' – use the 'config' option instead. ↓

fix Move configuration file path to the 'config' option.

gotcha JSDoc must be installed separately as a devDependency. ↓

fix Run: npm install -D jsdoc

deprecated Plugin is in early stage and may have breaking changes without major version bump. ↓

fix Pin version with exact version or use lockfile.

Install

npm install rollup-plugin-jsdoc

yarn add rollup-plugin-jsdoc

pnpm add rollup-plugin-jsdoc

Imports

jsdoc

wrong

const jsdoc = require('rollup-plugin-jsdoc');

correct

import jsdoc from 'rollup-plugin-jsdoc'

Package does not export a CommonJS default; use ESM import.

jsdoc

wrong

const jsdoc = require('rollup-plugin-jsdoc');

correct

const { default: jsdoc } = require('rollup-plugin-jsdoc');

If using CommonJS, destructure default export.

default

wrong

import { jsdoc } from 'rollup-plugin-jsdoc'

correct

import jsdoc from 'rollup-plugin-jsdoc'

The plugin is a default export, not named.

Quickstart

Shows how to integrate the plugin into a Rollup config to generate JSDoc documentation in the 'docs' folder.

// rollup.config.js
import jsdoc from 'rollup-plugin-jsdoc';

export default {
  input: 'src/index.js',
  output: {
    file: 'dist/bundle.js',
    format: 'cjs'
  },
  plugins: [
    jsdoc({
      args: ['-d', 'docs'],
      config: 'jsdoc.config.json'
    })
  ]
};