gitattribute foundry #3439
gitattribute foundry #3439
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe changes made in the Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.gitattributes (2)
28-29: LGTM! Consider documenting the vendored status.The pattern correctly marks Foundry deployment artifacts as vendored. This is appropriate as these files are typically generated during the deployment process.
Consider adding a comment in the project's README or documentation explaining that deployment artifacts are marked as vendored and what this means for contributors (e.g., these files won't affect repository language statistics and should be treated as external dependencies).
Additional patterns needed for generated files
Based on the scan results, there are several types of generated files that should be covered in
.gitattributes:
*_string.gofiles (generated by stringer)*.pb.go,*.pb.gw.gofiles (generated by protobuf)*.easyjson.gofiles (generated by easyjson)models_gen.go,client.gen.gofiles (generated by GraphQL)mocks/*.gofiles (generated mock files)Here's the updated
.gitattributesentry:# don't count abigen files in linguist as go *.abigen.go linguist-generated # ignore multicopier files *_gen.go linguist-generated # ignore ifacemaker files *_string.go linguist-generated # ignore protobuf generated files *.pb.go linguist-generated *.pb.gw.go linguist-generated # ignore easyjson generated files *.easyjson.go linguist-generated # ignore mock files mocks/*.go linguist-generated🔗 Analysis chain
Line range hint
10-16: LGTM! Verify coverage of generated files.The patterns for marking generated files are well-defined and appropriate for excluding auto-generated code from language statistics.
Let's verify if all generated files are properly covered:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for any potentially missed generated files # Look for common generated file patterns that might not be covered # Check for any files that might be generated but not marked rg -l "THIS FILE IS GENERATED|DO NOT EDIT|Generated by|Auto-generated" | \ while read -r file; do echo "Potential generated file: $file" done # List all Go files matching the patterns to verify coverage fd -e go -x echo "Found generated Go file: {}" \; \ -E "*.abigen.go" \ -E "*_gen.go" \ -E "*_generated.go"Length of output: 94342
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
.gitattributes(1 hunks)
🔇 Additional comments (1)
.gitattributes (1)
Line range hint 19-22: LGTM! Proper file type specifications.
The specifications are correct:
- SVG as binary prevents line-ending issues
- Solidity language identification enables proper syntax highlighting
- JSONC is appropriate for VS Code config files
Description
vendor deployment metadata
Summary by CodeRabbit