-
-
Notifications
You must be signed in to change notification settings - Fork 369
chore: Add .coderabbit.yaml #1570
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ysknsid25
wants to merge
7
commits into
main
Choose a base branch
from
chore/coderabbit-yaml
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+129
−0
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6b72651
chore: Add `.coderabbit.yaml`
ysknsid25 38e1110
chore: Add `.coderabbit.yaml`
ysknsid25 5cef9b1
chore: Add `.coderabbit.yaml`
ysknsid25 dc3e172
Potential fix for pull request finding
ysknsid25 a1d5ddd
Potential fix for pull request finding
ysknsid25 f5ae828
Potential fix for pull request finding
ysknsid25 dd0b670
Merge branch 'main' into chore/coderabbit-yaml
ysknsid25 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json | ||
|
|
||
| reviews: | ||
| profile: chill | ||
| collapse_walkthrough: false | ||
| changed_files_summary: false | ||
| sequence_diagrams: false | ||
| estimate_code_review_effort: false | ||
| suggested_labels: false | ||
| in_progress_fortune: false | ||
|
|
||
| finishing_touches: | ||
| docstrings: | ||
| enabled: false | ||
| unit_tests: | ||
| enabled: false | ||
|
|
||
| tools: | ||
| fbinfer: | ||
| enabled: false | ||
| presidio: | ||
| enabled: false | ||
|
|
||
| path_filters: | ||
| - "!**/dist/**" | ||
| - "!**/coverage/**" | ||
| - "!**/node_modules/**" | ||
| - "!pnpm-lock.yaml" | ||
| - "!**/*.snap" | ||
|
|
||
| # Path-specific review directives. The underlying guideline content (AGENTS.md | ||
| # and the /.agents/skills/*/SKILL.md files) is loaded via knowledge_base.code_guidelines | ||
| # below, so these instructions tell the reviewer *what to check*, not repeat the rules. | ||
| path_instructions: | ||
| - path: "library/src/**/*.ts" | ||
| instructions: >- | ||
| Review against AGENTS.md and the repo-source-code-review / | ||
| repo-source-code-document skills. Specifically check: (1) `interface` is | ||
| used for object shapes, `type` only for unions/aliases; (2) all relative | ||
| imports use the `.ts` extension; (3) `// @__NO_SIDE_EFFECTS__` immediately | ||
| precedes every pure factory function (schema/action/method creators) and is | ||
| absent from functions that mutate arguments or perform I/O; (4) every | ||
| exported function/interface has complete JSDoc — first overload only for | ||
| overload sets, `@param`/`@returns` documented, first line matches the kind | ||
| (`Creates a ... schema.` / `Creates a ... validation action.` / | ||
| `Creates a ... transformation action.`); (5) each schema/action/method lives | ||
| in its own folder with `name.ts`, `name.test.ts`, `name.test-d.ts`, and | ||
| `index.ts`; (6) no new runtime dependency is introduced. Flag any deviation | ||
| as a required change, not a nitpick. | ||
| - path: "library/src/**/*.test.ts" | ||
| instructions: >- | ||
| Verify runtime test coverage per the repo-source-code-review skill: success | ||
| cases, failure cases, and edge cases are all covered, and assertions check | ||
| the exact issue structure/messages produced, not just that validation | ||
| failed. | ||
| - path: "library/src/**/*.test-d.ts" | ||
| instructions: >- | ||
| Verify type-level coverage per the repo-source-code-review skill: tests use | ||
| `expectTypeOf` to validate inferred input/output/issue types for every | ||
| overload, including generic constraint edge cases. | ||
| - path: "website/src/routes/api/**/*.mdx" | ||
| instructions: >- | ||
| Review against the repo-website-api-create / repo-website-api-update | ||
| skills. Check: frontmatter has title/description/source/contributors (type | ||
| pages omit `source`); the signature and generics match `/library/src/` | ||
| exactly; every generic and parameter is documented via the `Property` | ||
| component; the `## Related` section lists only genuinely related APIs | ||
| (usable together in a `pipe`, or as each other's argument) ordered Schemas → | ||
| Methods → Actions → Utils; error-message examples are friendly and | ||
| actionable, never "Invalid"/"Error"; `menu.md` is updated alphabetically for | ||
| new pages. | ||
| - path: "website/src/routes/api/**/properties.ts" | ||
| instructions: >- | ||
| Verify property definitions match the corresponding source file in | ||
| `/library/src/` exactly, including generic constraints. Optional object | ||
| keys (`key?: T`) must keep the plain key name and be modeled as a union | ||
| with `undefined` as the last option — never append `?` to the key. | ||
| - path: "website/src/routes/guides/**/*.mdx" | ||
| instructions: >- | ||
| Review against the repo-website-guide-create skill. Check: frontmatter has | ||
| title/description/contributors; prose is conversational, first-person | ||
| plural ("we recommend"), not terse reference style; bold is not used as an | ||
| inline section label (e.g. no `**Note:** ...`) — a subheading or plain `>` | ||
| blockquote is used instead; internal links use the `Link` component; code | ||
| examples import as `import * as v from 'valibot';`; the page is added to | ||
| `menu.md`. | ||
| - path: "**/*.ts" | ||
| instructions: >- | ||
| Confirm ESM import style: all relative imports, including type-only | ||
| imports, include the `.ts` extension, as required by AGENTS.md and | ||
| enforced by ESLint. | ||
|
|
||
| auto_review: | ||
| enabled: true | ||
| drafts: false | ||
|
|
||
| knowledge_base: | ||
| opt_out: false | ||
|
|
||
| # Feed the repo's own coding standards into every review instead of duplicating | ||
| # them in path_instructions. AGENTS.md is the canonical guideline file for this repository. | ||
| code_guidelines: | ||
| enabled: true | ||
| filePatterns: | ||
| - "AGENTS.md" | ||
| - "CONTRIBUTING.md" | ||
| - files: | ||
| - ".agents/skills/repo-source-code-document/SKILL.md" | ||
| - ".agents/skills/repo-source-code-review/SKILL.md" | ||
| - ".agents/skills/repo-structure-navigate/SKILL.md" | ||
| applyTo: | ||
| - "library/src/**" | ||
| - "packages/*/src/**" | ||
| - files: ".agents/skills/repo-website-api-create/SKILL.md,.agents/skills/repo-website-api-update/SKILL.md" | ||
| applyTo: "website/src/routes/api/**" | ||
| - files: ".agents/skills/repo-website-guide-create/SKILL.md" | ||
| applyTo: "website/src/routes/guides/**" | ||
|
|
||
| # Actively use this repo's history as review context. | ||
| learnings: | ||
| scope: auto | ||
| approval_delay: 0 | ||
| issues: | ||
| scope: auto | ||
| pull_requests: | ||
| scope: auto | ||
|
|
||
| chat: | ||
| art: false | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.