prisma lint

[alexcoderabbitai]

No description provided.

[coderabbitai]

Walkthrough

This pull request introduces comprehensive documentation for the Prisma Lint tool by adding a new file that details its configuration, usage, and examples. Additionally, the tools overview documentation has been updated to include an entry for Prisma, linking to the Prisma Lint guide. The changes focus solely on documentation enhancements with no modifications to runtime functionality.

Changes

File	Change Summary
docs/tools/prisma-lint.md	Added new documentation for Prisma Lint, outlining its purpose, configuration details (including default paths and custom configurations), linting rules, and examples.
docs/tools/tools.md	Added a new entry in the Supported Tools table for Prisma with a link to the Prisma Lint documentation along with a corresponding reference.

Possibly related PRs

• Add table for Supported Tools by languages #63: Both PRs update documentation related to Prisma Lint and the tools overview.
• buf docs #77: Similar modifications in docs/tools/tools.md by adding entries for linting tools.

Suggested labels

documentation

Suggested reviewers

• hasit

Poem

I’m a little rabbit with fur so bright,
Hopping through docs in pure delight.
Prisma Lint’s now in our code’s tale,
Guiding our schemas without fail.
In the garden of code, I cheer with glee—
Carrots and docs set our projects free!
🥕🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5a06e8e and cf0e65a.

📒 Files selected for processing (1)

• docs/tools/prisma-lint.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/tools/prisma-lint.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	cf0e65a
Status:	✅  Deploy successful!
Preview URL:	https://14a96cc0.coderabbit-docs.pages.dev
Branch Preview URL:	https://prisma-lint.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/tools/prisma-lint.md (1)

38-62: JSON Configuration Example – Replace Hard Tabs with Spaces
The JSON configuration sample is well structured; however, the static analysis hints indicate the use of hard tabs (MD010 errors) between lines 40 and 60. Please replace any hard tabs with spaces for better markdown compliance. For example:

-	"rules": {
+    "rules": {

This change should be applied uniformly throughout the JSON block.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

40-40: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

41-41: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

42-42: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

43-43: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

44-44: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

45-45: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

46-46: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

47-47: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

48-48: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

49-49: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

50-50: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

51-51: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

52-52: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

53-53: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

54-54: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

55-55: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

56-56: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

57-57: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

58-58: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

59-59: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

60-60: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🪛 GitHub Actions: Node.js CI

[error] 40-60: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 41-41: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 42-42: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 43-43: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 44-44: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 45-45: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 46-46: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 47-47: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 48-48: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 49-49: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 50-50: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 51-51: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 52-52: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 53-53: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 54-54: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 55-55: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 56-56: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 57-57: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 58-58: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 59-59: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 60-60: MD010/no-hard-tabs Hard tabs [Column: 1]

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5d56fd and 5a06e8e.

📒 Files selected for processing (2)

• docs/tools/prisma-lint.md (1 hunks)
• docs/tools/tools.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/tools/prisma-lint.md

40-40: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

41-41: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

42-42: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

43-43: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

44-44: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

45-45: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

46-46: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

47-47: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

48-48: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

49-49: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

50-50: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

51-51: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

52-52: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

53-53: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

54-54: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

55-55: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

56-56: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

57-57: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

58-58: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

59-59: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

60-60: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🪛 GitHub Actions: Node.js CI

docs/tools/prisma-lint.md

[error] 40-60: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 41-41: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 42-42: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 43-43: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 44-44: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 45-45: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 46-46: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 47-47: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 48-48: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 49-49: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 50-50: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 51-51: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 52-52: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 53-53: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 54-54: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 55-55: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 56-56: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 57-57: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 58-58: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 59-59: MD010/no-hard-tabs Hard tabs [Column: 1]

---

[error] 60-60: MD010/no-hard-tabs Hard tabs [Column: 1]

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Cloudflare Pages

🔇 Additional comments (6)

docs/tools/tools.md (2)

79-79: New Prisma Entry Added to Tools Table
The new row for Prisma is correctly formatted and consistent with the other entries in the table. The entry clearly lists the tool as "Prisma Lint" with an appropriate category.

---

104-105: Reference Link for Prisma Lint Documentation
The reference [PrismaLint]: ./prisma-lint.md is properly added at the end of the file, ensuring that the new entry in the table is correctly linked.

docs/tools/prisma-lint.md (4)

1-6: Metadata Block for Prisma Lint Documentation
The front matter with the title, sidebar label, and description is clear and descriptive. It sets the right expectations for this guide.

---

7-12: MDX Code Block Inclusion
The usage of the MDX code block to import and render the ProPlan notice is correctly implemented and follows the repository conventions.

---

68-78: Prisma Model Ignoring Rules Code Block
The example demonstrating how to ignore rules using triple-slash comments is clear and provides useful context. It follows documentation best practices.

---

80-84: Helpful Links Section
The links provided at the end, which direct users to the Prisma Lint GitHub repository and its rules documentation, are accurate and add value to the guide.