prisma lint (#263)

alexcoderabbitai · web-flow · commit 83ca790f3426 · 2025-04-02T13:29:13.000-04:00
* lint

* dont show rules direct to docs
diff --git a/docs/tools/prisma-lint.md b/docs/tools/prisma-lint.md
@@ -0,0 +1,46 @@
+---
+title: Prisma Lint
+sidebar_label: Prisma Lint
+description: CodeRabbit's guide to Prisma Lint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[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.
+
+## Files
+
+Prisma Lint will run on files with the following extensions:
+
+- `.prisma`
+
+## Configuration
+
+Prisma Lint supports the following config files:
+
+- `.prismalintrc.json`
+- `.prismalintrc`
+- `.prismalintrc.js`
+- `.prismalintrc.yaml`
+- `.prismalintrc.yml`
+- `prismalint.config.js`
+- 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.
+
+:::note
+
+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.
+
+:::
+
+## Rule Configuration
+
+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.
+
+## Links
+
+- [Prisma Lint GitHub Repository](https://github.com/loop-payments/prisma-lint)
+- [Prisma Lint Rules Documentation](https://github.com/loop-payments/prisma-lint/blob/main/RULES.md)
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
@@ -76,6 +76,7 @@ Remove extraneous f prefix
 | TSX                         | [Biome][Biome]                                             | Code Quality                                        |
 | Typescript                  | [Biome][Biome]                                             | Code Quality                                        |
 | YAML                        | [YAMLlint][YAMLlint]                                       | Code Quality                                        |
+| Prisma                      | [Prisma Lint][PrismaLint]                                  | Code Quality                                        |
 
 [ShellCheck]: ./shellcheck.md
 [SQLFluff]: ./sqlfluff.md
@@ -100,3 +101,4 @@ Remove extraneous f prefix
 [CircleCI]: ./circleci.md
 [Semgrep]: ./semgrep.md
 [Pipeline]: ./pipeline-remediation.md
+[PrismaLint]: ./prisma-lint.md
