prismadocify

Generate documentation for Prisma schemas.

prismadocify is a command-line tool that generates markdown documentation for Prisma schemas. It reads your Prisma schema file, parses the models and enums, and outputs a markdown file documenting the schema.

Installation

Prerequisites

• Node.js (>= 16.x)
• Yarn or npm

Install via npm

npm install prismadocify

Install via Yarn

yarn add prismadocify

Usage

After installing prismadocify, you can use it from the command line to generate documentation for your Prisma schema.

Command

prismadocify

By default, prismadocify looks for the Prisma schema file at ./prisma/schema.prisma and generates the documentation in ./prisma-docs.md.

Example

• Make sure your Prisma schema file is located at ./prisma/schema.prisma.

• Run the prismadocify command:

  prismadocify
  

• Check the generated prisma-docs.md file in the root directory of your project.

Example

• Make sure your Prisma schema file is located at ./prisma/schema.prisma.

• Run the prismadocify command:

  prismadocify
  

• Check the generated prisma-docs.md file in the root directory of your project.

Example

Here is an example of a simple Prisma schema and the generated documentation:

Prisma Schema (schema.prisma)

generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model User {
  id         String   @id @default(uuid())
  email      String   @unique
  name       String?
  role       UserRole @default(USER)
  createdAt  DateTime @default(now())
  updatedAt  DateTime @updatedAt

  @@map("users")
}

enum UserRole {
  ADMIN
  USER
}

Generated Markdown Documentation (prisma-docs.md)

# Prisma Schema Documentation

## User

| Field     | Type      | List | Required | Unique |
|-----------|-----------|------|----------|--------|
| id        | String    | No   | Yes      | No     |
| email     | String    | No   | Yes      | Yes    |
| name      | String?   | No   | No       | No     |
| role      | UserRole  | No   | Yes      | No     |
| createdAt | DateTime  | No   | Yes      | No     |
| updatedAt | DateTime  | No   | Yes      | No     |

## Enums

### UserRole

---
ADMIN, USER

Options

Currently, prismadocify does not support additional options. It follows the convention of looking for the Prisma schema file at the default location (./prisma/schema.prisma). Future versions may include support for specifying custom paths and other options.

Contributing

Contributions are welcome! Please open an issue or submit a pull request to contribute.

Creating Issues

If you encounter a bug or have a feature request, please create an issue on GitHub.

• Bug Reports: Include as much detail as possible about the issue, including steps to reproduce, expected behavior, and screenshots if applicable.
• Feature Requests: Describe the feature you would like to see, the problem it solves, and any potential implementation details.

To create an issue, go to the issues page and click on the "New issue" button.

License

This project is licensed under the MIT License.

Acknowledgements

Thanks to the Prisma team for their awesome ORM and inspiration for this tool.