Add Recurse ML rules for naming and code patterns #780
+47
−0
Conversation
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
|
@ab-10 is attempting to deploy a commit to the Stack Team on Vercel. A member of the Team first needs to authorize it. |
|
✨ No files to analyze in this PR. Need help? Join our Discord for support! |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR introduces Recurse ML rules configuration to enforce consistent coding patterns and naming conventions across the stack-auth codebase. The changes include:
- Configuration in
.github/.recurseml.yamlto enable custom rules - New naming conventions for HTTP APIs, error IDs, and OAuth flows in
naming.mdc - Code pattern enforcement rules in
code_patterns.mdccovering async handling, JSON operations, and error handling
The rules aim to improve code quality, security, and maintainability by standardizing common patterns and preventing anti-patterns.
PR Description Notes:
- There is a typo 'guideleines' in naming.mdc that should be fixed
- The rules link in the PR description appears to be malformed (points to docs.recurse.ml/gh/configs/rules)
Confidence score: 4/5
- Safe to merge after addressing the typo and link issues
- The rules being added are well-thought-out and address important safety and consistency concerns
- Files needing attention:
.github/recurseml-rules/naming.mdc: Fix typo- PR description: Fix malformed link
3 files reviewed, 3 comments
Edit PR Review Bot Settings | Greptile
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
|
Thanks for your contribution! 😎 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds two custom Recurse ML rules to enforce naming and usage patterns
.github/recurseml-rules/naming.mdc:
snake_casefor anything that goes over HTTP in REST APIs,camelCasefor JavaScript elsewherecaptureError's first argument should be a machine-readable ID without whitespaces (e.g.,'user-sign-up-email'not'Email failed to send').github/recurseml-rules/code_patterns.mdc:
void asyncFunction()orasyncFunction().catch(console.error)- userunAsynchronously(asyncFunction)insteadparseJson/stringifyJsonfromstack-shared/utils/jsoninstead ofJSON.parse/JSON.stringifywaitUntil, userunAsynchronously(promise, { promiseCallback: waitUntil })/users/${userId}?? throwErr("message", { extraData })patternImportant
Add Recurse ML rules for naming conventions and code patterns in JavaScript/TypeScript.
rules: .github/recurseml-rules/to.github/.recurseml.yaml.naming.mdc):snake_casefor REST API HTTP elements,camelCasefor JavaScript.captureErrorIDs must be machine-readable without spaces.code_patterns.mdc):runAsynchronouslyinstead ofvoid asyncFunction()or.catch(console.error).parseJson/stringifyJsonfromstack-shared/utils/json.runAsynchronouslywithpromiseCallbackfor VercelwaitUntil.?? throwErrpattern.This description was created by
for 9dd35ab. You can customize this summary. It will automatically update as commits are pushed.