A linter for Prisma schema files.
npm install prisma-lintA linter for Prisma schema files.
``sh`
> npm install --save-dev prisma-lintor
> yarn add --dev prisma-lint
`sh`
> npx prisma-lintor
> yarn prisma-lint
The default schema path is prisma/schema.prisma. The schema path can also be configured in:
1. prisma.config.ts or .config/prisma.ts (Prisma 7+): The schema field is used if present.package.json#prisma.schema
2. (legacy): Supported for backwards compatibility.
Alternatively, you can provide one or more explicit paths as CLI arguments. These can be globs, directories, or file paths.
Run yarn prisma-lint --help for all options.
The file RULES.md contains documentation for each rule. All rules are disabled by default. Create a configuration file to enable the rules you'd like to enforce.
The configuration file format is loosely based on eslint's conventions. Here's an example .prismalintrc.json:
`json`
{
"rules": {
"field-name-mapping-snake-case": [
"error",
{
"compoundWords": ["S3"]
}
],
"field-order": [
"error",
{
"order": ["tenantId", "..."]
}
],
"forbid-required-ignored-field": ["error"],
"model-name-grammatical-number": [
"error",
{
"style": "singular"
}
],
"model-name-mapping-snake-case": [
"error",
{
"compoundWords": ["GraphQL"]
}
],
"require-field-index": [
"error",
{
"forAllRelations": true,
"forNames": ["tenantId"]
}
]
}
}
See Loop's configuration for a more thorough example. Configuration files are loaded with cosmiconfig.
Rules can be ignored with three-slash (///) comments inside models.
To ignore all lint rules for a model and its fields:
`prisma`
model User {
/// prisma-lint-ignore-model
}
To ignore specific lint rules for a model and its fields:
`prisma`
model User {
/// prisma-lint-ignore-model require-field
/// prisma-lint-ignore-model require-field-type
}
Some rules support parameterized ignore comments like this:
`prisma`
model User {
/// prisma-lint-ignore-model require-field revisionNumber,revisionCreatedAt
}
Omitting revisionNumber and revisionCreatedAt fields from this model will not result in a violation. Other required fields remain required.
To ignore specific lint rules for a single field, use prisma-lint-ignore-field:
`prisma`
model User {
/// prisma-lint-ignore-field field-name-camel-case
user_name String
}
You can ignore all rules for a field by omitting the rule names:
`prisma`
model User {
/// prisma-lint-ignore-field
user_name String
}
Multiple rules can be specified separated by spaces or commas:
`prisma`
model User {
/// prisma-lint-ignore-field field-name-camel-case field-name-mapping-snake-case
user_name String
/// prisma-lint-ignore-field field-name-camel-case,field-name-mapping-snake-case
another_field String
}
There are a few output options.
`
> yarn prisma-lint -o simple
example/invalid.prisma ✖
Users 11:1
error Expected singular model name. model-name-grammatical-number
error Missing required fields: "createdAt". require-field
Users.emailAddress 13:3
error Field name must be mapped to snake case. field-name-mapping-snake-case
example/valid.prisma ✔
`
> yarn prisma-lint -o contextual
example/invalid.prisma:11:1 Users
model Users {
^^^^^^^^^^^
error Expected singular model name. model-name-grammatical-number
error Missing required fields: "createdAt". require-field
example/invalid.prisma:13:3 Users.emailAddress
emailAddress String
^^^^^^^^^^^^
error Field name must be mapped to snake case. field-name-mapping-snake-case
`
`
> yarn prisma-lint -o filepath
example/invalid.prisma ✖
example/valid.prisma ✔
`
> yarn prisma-lint -o none
No output, for when you just want to use the status code.
`
> yarn prisma-lint -o json
Outputs a serialized JSON object with list of violations. Useful for editor plugins.
Pull requests are welcome. Please see DEVELOPMENT.md.