Skip to content

Commit 83ca790

Browse files
prisma lint (#263)
* lint * dont show rules direct to docs
1 parent c5d56fd commit 83ca790

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/tools/prisma-lint.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Prisma Lint
3+
sidebar_label: Prisma Lint
4+
description: CodeRabbit's guide to Prisma Lint.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
[Prisma Lint](https://github.com/loop-payments/prisma-lint) is a linter for Prisma schema files that helps enforce consistent conventions and best practices in your Prisma schemas.
14+
15+
## Files
16+
17+
Prisma Lint will run on files with the following extensions:
18+
19+
- `.prisma`
20+
21+
## Configuration
22+
23+
Prisma Lint supports the following config files:
24+
25+
- `.prismalintrc.json`
26+
- `.prismalintrc`
27+
- `.prismalintrc.js`
28+
- `.prismalintrc.yaml`
29+
- `.prismalintrc.yml`
30+
- `prismalint.config.js`
31+
- User-defined config file set at `reviews.tools.prismalint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Prisma Lint → Config File" field in CodeRabbit's settings page.
32+
33+
:::note
34+
35+
By default, Prisma Lint looks for schema files at `prisma/schema.prisma`. If you have a custom schema path specified in the `prisma.schema` field within `package.json`, that will be used instead.
36+
37+
:::
38+
39+
## Rule Configuration
40+
41+
Rules can be configured in your `.prismalintrc.json` file. See the [Prisma Lint Rules Documentation](https://github.com/loop-payments/prisma-lint/blob/main/RULES.md) for more information on the available rules and their configuration options.
42+
43+
## Links
44+
45+
- [Prisma Lint GitHub Repository](https://github.com/loop-payments/prisma-lint)
46+
- [Prisma Lint Rules Documentation](https://github.com/loop-payments/prisma-lint/blob/main/RULES.md)

docs/tools/tools.md

+2
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Remove extraneous f prefix
7676
| TSX | [Biome][Biome] | Code Quality |
7777
| Typescript | [Biome][Biome] | Code Quality |
7878
| YAML | [YAMLlint][YAMLlint] | Code Quality |
79+
| Prisma | [Prisma Lint][PrismaLint] | Code Quality |
7980

8081
[ShellCheck]: ./shellcheck.md
8182
[SQLFluff]: ./sqlfluff.md
@@ -100,3 +101,4 @@ Remove extraneous f prefix
100101
[CircleCI]: ./circleci.md
101102
[Semgrep]: ./semgrep.md
102103
[Pipeline]: ./pipeline-remediation.md
104+
[PrismaLint]: ./prisma-lint.md

0 commit comments

Comments
 (0)