docz-rollup

2.4.0 verified Mon Apr 27 auth: no javascript maintenance

An internal rollup configuration package for building packages within the docz ecosystem. Version 2.4.0 is the latest stable release. This package is not intended for direct use by most developers; it is used internally by docz to bundle its source code. It provides a shared rollup config to ensure consistent builds across docz monorepo packages. It requires TypeScript as a peer dependency and is part of the docz documentation toolchain. Differentiator: not a public utility, but a monorepo internal tool.

Common errors

error Module not found: Can't resolve 'docz-rollup' ↓

cause Package is internal and may not be published to npm registry in some environments.

fix

Check if the package is available in your project scope; use the main 'docz' package instead.

error TypeError: docz-rollup.default is not a function ↓

cause Trying to call default export as function, but it's an object.

fix

Use import config from 'docz-rollup' and access config properties directly.

Warnings

gotcha This package is internal and may change without notice. Not recommended for direct use. ↓

fix Use the main 'docz' package or wait for stable external API.

deprecated The docz project has been deprecated in favor of newer tools like Docusaurus or Storybook. ↓

fix Consider migrating to alternative documentation tooling.

breaking Requires TypeScript peer dependency (^3.5.0 || ^4.0.0). Missing TypeScript will cause build failures. ↓

fix Install TypeScript: npm install --save-dev typescript

Install

npm install docz-rollup

yarn add docz-rollup

pnpm add docz-rollup

Imports

default (rollup config object)
wrong
```
const config = require('docz-rollup')
```
correct
```
import config from 'docz-rollup'
```
Internal package, ESM export. Unlikely to be imported directly.
rollupConfig
```
import { rollupConfig } from 'docz-rollup'
```
Exported as named export if using destructured import.

TypeScript

import { rollupConfig } from 'docz-rollup'
// Used as: rollup({ plugins: [typescript()] })

The config itself is a function returning rollup options.

Quickstart

Example of using docz-rollup config as base for a rollup build pipeline.

import config from 'docz-rollup';
import typescript from '@rollup/plugin-typescript';

export default {
  input: 'src/index.ts',
  output: {
    dir: 'dist',
    format: 'esm',
  },
  plugins: [
    typescript({ tsconfig: './tsconfig.json' }),
  ],
  // ...additional options from config
};