wip
This commit is contained in:
@@ -0,0 +1,48 @@
|
||||
# prisma format
|
||||
|
||||
Formats your Prisma schema file.
|
||||
|
||||
## Command
|
||||
|
||||
```bash
|
||||
prisma format [options]
|
||||
```
|
||||
|
||||
## What It Does
|
||||
|
||||
- Fixes formatting (indentation, spacing)
|
||||
- Adds missing back-relations (e.g., adds the other side of a relation)
|
||||
- Adds missing relation arguments (e.g., `fields`, `references`)
|
||||
- Sorts fields and attributes (opinionated)
|
||||
|
||||
## Options
|
||||
|
||||
| Option | Description |
|
||||
|--------|-------------|
|
||||
| `--schema` | Path to schema file |
|
||||
| `--config` | Custom path to your Prisma config file |
|
||||
|
||||
## Examples
|
||||
|
||||
### Format default schema
|
||||
|
||||
```bash
|
||||
prisma format
|
||||
```
|
||||
|
||||
### Format specific schema
|
||||
|
||||
```bash
|
||||
prisma format --schema=./custom/schema.prisma
|
||||
```
|
||||
|
||||
## Behavior
|
||||
|
||||
`prisma format` modifies the file in place. It is equivalent to "Prettier for Prisma schemas" but also has semantic understanding to fix/add missing schema definitions.
|
||||
|
||||
## Use in Editor
|
||||
|
||||
Most Prisma editor extensions (VS Code, WebStorm) run `prisma format` automatically on save. This command is useful for:
|
||||
- CI pipelines (check formatting)
|
||||
- CLI-based workflows
|
||||
- Fixing large schema refactors
|
||||
Reference in New Issue
Block a user