-
Notifications
You must be signed in to change notification settings - Fork 294
fix(style): support windows line endings and paths in copyright check #344
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @Aditya4ever, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the robustness of the copyright header style check by introducing Windows compatibility. It specifically addresses issues related to line ending variations and path separator differences, ensuring the test functions correctly across different operating systems without producing erroneous failures. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly addresses issues with the copyright header check failing on Windows environments by normalizing both file paths and line endings. The use of filepath.ToSlash is appropriate for handling path separators, and normalizing line endings for the comparison is a robust solution. I have one suggestion to improve the performance of the line ending normalization by computing the normalized header string only once, outside of the function that is called for every file.
| header := strings.ReplaceAll(copyrightHeader, "\r\n", "\n") | ||
| return strings.HasPrefix(fileContent, header), nil |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The normalization of copyrightHeader is performed on every call to hasCopyrightHeader. Since copyrightHeader is a constant, this computation is redundant. To improve performance, this can be done once at the package level.
You could define a package-level variable:
var normalizedCopyrightHeader = strings.ReplaceAll(copyrightHeader, "\r\n", "\n")And then use it in this function, which would simplify these lines:
// ...
fileContent := strings.ReplaceAll(string(content), "\r\n", "\n")
return strings.HasPrefix(fileContent, normalizedCopyrightHeader), nil|
@googlebot I signed it. |
95c46b8 to
5a123e6
Compare
|
@googlebot I signed it |
Description
Fixes TestCopyrightHeader failures on Windows environments.
The style_test.go was failing on Windows due to two issues:
filepath.Walkreturns paths with backslashes (\) on Windows, but the ignore map used forward slashes (/), causing ignored directories likeinternal/httprrto be checked erroneously.Changes
filepath.ToSlashbefore checking against the ignore list.Testing Plan
Ran
go test -v ./internalon a Windows machine.Before Fix: