Registry / devops / prisma-docs-generator

prisma-docs-generator

library0.8.0jsnpmunverified

Automatically generate a reference documentation website from your Prisma Schema. Version 0.8.0 is the latest stable release, with no frequent release cadence documented. Key differentiator: integrates as a Prisma generator, so docs update automatically on `prisma generate`. Serves as an alternative to manually writing schema documentation. Outputs static HTML that can be served via a built-in CLI server.

devops

npm install prisma-docs-generator

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PRISMA-DOCS-GENERA

prisma-docs-generator

devopsjavascriptv0.8.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generator docs

✓ generator docs { provider = "node node_modules/prisma-docs-generator" }

✗ generator docs { provider = "prisma-docs-generator" }

Must include 'node ' prefix in provider; the package is a Node.js script, not a binary.

serve command

✓ npx prisma-docs-generator serve

✗ npx prisma-docs-generator

The CLI requires a subcommand; bare invocation does nothing.

Default import

✓ const generator = require('prisma-docs-generator')

✗ import generator from 'prisma-docs-generator'

Package is CJS only; no ESM exports.

Shows setup of Prisma generator, generation trigger, and serving of documentation.

// Step 1: Install generator docs { provider = "node node_modules/prisma-docs-generator" output = "../../docs" includeRelationFields = true } // Step 2: Generate // npx prisma generate // Step 3: Serve // npx prisma-docs-generator serve --port 4000 // The above will create docs in prisma/docs and serve them at http://localhost:4000

Debug

Known issues

gotchaProvider must include 'node ' prefix: `provider = "node node_modules/prisma-docs-generator"`

fix

Use `provider = "node node_modules/prisma-docs-generator"` in Prisma schema.

affects: >=0.1.0

gotchaCLI requires subcommand; `npx prisma-docs-generator` alone does nothing

fix

Run `npx prisma-docs-generator serve`.

affects: >=0.8.0

deprecatedNo ESM support; package is CommonJS only

fix

Use `require('prisma-docs-generator')` or stick to CJS.

affects: >=0.1.0

gotchaGenerator only runs via `prisma generate`; manual schema changes don't trigger docs update

fix

Re-run `npx prisma generate` after schema changes.

affects: >=0.1.0

gotchaOutput folder default is `prisma/docs`; if custom output is set via `output` option, must match server expectation

fix

Set `output` in schema and ensure `serve` reads the correct directory.

affects: >=0.8.0

Errors

Common errors & fixes

Error: Cannot find module 'C:\project\node_modules\@prisma\generator-helper'

Missing dependency or incorrect Node module resolution when running the generator

fix

Run `npm install @prisma/generator-helper` or ensure Prisma is installed.

Error: Generator 'docs' is not recognized

Invalid provider syntax; provider must start with 'node '

fix

Set `provider = "node node_modules/prisma-docs-generator"` in schema.

ENOENT: no such file or directory, open '...prisma/docs/index.html'

Generator did not run or output path is incorrect

fix

Run `npx prisma generate` first, then verify output path matches.

Upgrade

Version history

0.8.0latest on npm

Audit

Dependencies

prismarequiredRuntime dependency required to run the generator and access schema metadata

Agent activity

11 hits · last 30 days

node

Resources

githubssh://git@github.com/pantharshit00/prisma-docs-generator ↗

packageprisma-docs-generator ↗

homepagehttps://github.com/pantharshit00/prisma-docs-generator ↗