scripts: add make command to lint submodules #10452
Conversation
Summary of ChangesHello @ziggie1984, 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 introduces a new Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request introduces a new "make lint-module" command and a corresponding "scripts/lint_modules.sh" script. This is a valuable addition for developers working on individual submodules, as it streamlines the linting process outside of the main CI pipeline. The script correctly handles both specific module linting and iterating through all submodules, and intelligently uses Docker caching for performance.
scripts/lint_modules.sh
Outdated
| # Accept optional module parameter | ||
| TARGET_MODULE=$1 | ||
|
|
||
| IGNORE="tools" |
There was a problem hiding this comment.
The "IGNORE" variable is hardcoded to "tools". This reduces the flexibility of the script, as any changes to the list of ignored modules would require direct modification of this file. Consider making this configurable via an environment variable to improve maintainability.
| IGNORE="tools" | |
| IGNORE="${LINT_IGNORE_MODULES:-tools}" |
| SUBMODULES="$TARGET_MODULE" | ||
| else | ||
| # Otherwise, lint all submodules | ||
| SUBMODULES=$(find . -mindepth 2 -name "go.mod" | cut -d'/' -f2 | grep -v "$IGNORE") |
There was a problem hiding this comment.
This line exceeds the 80-character limit specified in the Repository Style Guide (Line 11). Please wrap the command to adhere to this limit for better readability and consistency.
| SUBMODULES=$(find . -mindepth 2 -name "go.mod" | cut -d'/' -f2 | grep -v "$IGNORE") | |
| SUBMODULES=$(find . -mindepth 2 -name "go.mod" | \ | |
| cut -d'/' -f2 | grep -v "$IGNORE") |
References
- The line length MUST NOT exceed 80 characters. Tabs are 8 spaces. (link)
This make command does not run in the CI but can make it easier to resolve all linter issues when developing on a separate module which only in followup PRs will be used in the main line. Usage for example: make lint-module module=kvdb
ziggie1984
force-pushed
the
add-submodule-linter-option
branch
from
84eee75 to
2349732
Compare
|
@Roasbeef: review reminder |
2 participants
This make command does not run in the CI but can make it easier
to resolve all linter issues when developing on a separate module
which only in followup PRs will be used in the main line.
Usage for example:
make lint-module module=kvdb