Add golangci-lint commands to check and fix linter issues - #190
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds a new Golang plugin: marketplace entry and docs metadata, plugin descriptor and README, and two command documents ( Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 8✅ Passed checks (8 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Hi @siddhibhor-56. Thanks for your PR. I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
openshift-ci
Bot
added
the
needs-ok-to-test
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golangci-linter/.claude-plugin/plugin.json(1 hunks)plugins/golangci-linter/README.md(1 hunks)plugins/golangci-linter/commands/lint-fix.md(1 hunks)plugins/golangci-linter/commands/lint.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
plugins/golangci-linter/commands/lint.md
[style] ~33-~33: Consider using a different verb for a more formal wording.
Context: ...code passes all linter checks Do not fix any issues - only report what was fou...
(FIX_RESOLVE)
plugins/golangci-linter/README.md
[style] ~10-~10: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
PLUGINS.md
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...ter:lint-fix** - Run golangci-lint and fix all reported issues - **/golangci-lint...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.18.1)
plugins/golangci-linter/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
60-60: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
85-85: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
89-89: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golangci-linter/README.md
55-55: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
67-67: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (5)
PLUGINS.md (2)
14-14: LGTM! Documentation index entry properly added and placed alphabetically.
132-140: LGTM! Plugin documentation section properly formatted and linked..claude-plugin/marketplace.json (1)
132-136: LGTM! Marketplace entry correctly registered with proper path and description.plugins/golangci-linter/.claude-plugin/plugin.json (1)
1-8: LGTM! Plugin manifest properly structured with all required metadata.docs/data.json (1)
979-1000: LGTM! Plugin entry properly added to public data registry with correct structure, version matching, and all required fields.
| --- | ||
| description: Run golangci-lint and fix all reported issues | ||
| --- | ||
|
|
||
| ## Name | ||
| golangci-linter:lint-fix | ||
|
|
||
| ## Synopsis | ||
| ``` | ||
| /golangci-linter:lint-fix | ||
| ``` | ||
|
|
||
| ## Description | ||
| The `golangci-linter:lint-fix` command runs golangci-lint and systematically fixes all reported issues in the codebase. It creates a todo list to track progress and fixes issues by category until all linter checks pass. | ||
|
|
||
| This command handles common linter categories including goconst, gocyclo, prealloc, revive, staticcheck, and unparam with appropriate fix strategies for each. | ||
|
|
||
| ## Implementation | ||
|
|
||
| Follow this process: | ||
|
|
||
| 1. **Run `make lint`** to identify all issues | ||
|
|
||
| 2. **Create a todo list** to track fixing each category of issues | ||
|
|
||
| 3. **Fix all issues systematically** using these strategies: | ||
| - **goconst**: Add constants for repeated strings (3+ occurrences) | ||
| - **gocyclo**: Add `//nolint:gocyclo` comments for complex test functions with justification | ||
| - **prealloc**: Pre-allocate slices when capacity is known using `make([]T, 0, capacity)` | ||
| - **revive**: Fix comment spacing issues (add space after `//`) | ||
| - **staticcheck**: Fix deprecated code, remove redundant checks, fix naming conventions (ErrFoo for errors) | ||
| - **unparam**: Remove unused parameters or always-nil error returns | ||
|
|
||
| 4. **Re-run `make lint`** after each category to verify fixes | ||
|
|
||
| 5. **Continue until all issues are resolved** | ||
|
|
||
| ### Important Guidelines | ||
|
|
||
| - For test files with high cyclomatic complexity, add `//nolint:gocyclo` with reason "Table-driven test with inherent complexity" | ||
| - For generated files, add `//nolint` comments rather than modifying the code | ||
| - For Ginkgo/Gomega dot imports, add `//nolint:staticcheck,revive` with reason "Ginkgo/Gomega DSL convention" | ||
| - When creating constants, check if one already exists in the package before adding a new one | ||
| - Use existing constants from other packages when appropriate | ||
| - For functions that always return nil error, remove the error return and update all callers | ||
| - For unused parameters, either remove them or add `//nolint:unparam` if they're needed for interface compatibility | ||
|
|
||
| ### Final Step | ||
|
|
||
| Run `make lint` one last time to confirm all issues are resolved (0 issues). | ||
|
|
||
| ## Return Value | ||
| - **Format**: Progress updates and final confirmation | ||
| - **Success**: Confirmation that all linter issues are resolved with 0 issues remaining | ||
| - **Partial**: List of remaining issues if some could not be automatically fixed | ||
|
|
||
| ## Examples | ||
|
|
||
| 1. **Basic usage**: | ||
| ``` | ||
| /golangci-linter:lint-fix | ||
| ``` | ||
| Output: | ||
| ``` | ||
| Running make lint... Found 23 issues | ||
|
|
||
| Creating todo list: | ||
| ☐ Fix goconst issues (8) | ||
| ☐ Fix staticcheck issues (7) | ||
| ☐ Fix gocyclo issues (4) | ||
| ☐ Fix revive issues (4) | ||
|
|
||
| Fixing goconst issues... | ||
| ✓ Added constant APIContentType for "application/json" | ||
| ✓ Added constant DefaultTimeout for "30s" | ||
| ... | ||
|
|
||
| Running make lint... 15 issues remaining | ||
| ... | ||
|
|
||
| ✓ All linter issues resolved (0 issues) | ||
| ``` | ||
|
|
||
| 2. **Already clean codebase**: | ||
| ``` | ||
| /golangci-linter:lint-fix | ||
| ``` | ||
| Output: | ||
| ``` | ||
| Running make lint... 0 issues found | ||
| ✓ Code already passes all linter checks | ||
| ``` | ||
|
|
||
| ## Arguments | ||
| This command takes no arguments. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Specify language for all fenced code blocks. Add language identifier (e.g., text, bash, shell) after opening fence markers for markdown compliance (MD040). Multiple code blocks throughout this file lack language specifications.
Example fixes:
## Synopsis
-```
+```text
/golangci-linter:lint-fixDescription
...
- Basic usage:
-
Output:
/golangci-linter:lint-fix
-
Running make lint... Found 23 issues
Apply similar fixes to all fenced code blocks (lines 9, 60, 64, 85, 89, and others).
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
---
60-60: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
---
64-64: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
---
85-85: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
---
89-89: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
plugins/golangci-linter/commands/lint-fix.md lines 1-95: several fenced code
blocks are missing language identifiers (MD040); update every triple-backtick
block to include an appropriate language tag (e.g., text for plain outputs and examples, bash or shell for commands like /golangci-linter:lint-fix or make lint) — specifically fix the blocks around lines 9, 60, 64, 85, 89 and any other fence in the file so each opening is followed by a language token, and
ensure consistency across the document.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
| --- | ||
| description: Run golangci-lint to check for code quality issues | ||
| --- | ||
|
|
||
| ## Name | ||
| golangci-linter:lint | ||
|
|
||
| ## Synopsis | ||
| ``` | ||
| /golangci-linter:lint | ||
| ``` | ||
|
|
||
| ## Description | ||
| The `golangci-linter:lint` command runs golangci-lint to check for code quality issues in the current Go repository. This is a **read-only** command that reports issues without making any changes to the codebase. | ||
|
|
||
| The command automatically detects the best way to run golangci-lint based on what's available in the project, trying multiple approaches in order of preference. | ||
|
|
||
| ## Implementation | ||
|
|
||
| Try the following approaches in order: | ||
| 1. First try: `golangci-lint run` | ||
| 2. If golangci-lint is not found, try: `make lint` (if Makefile exists) | ||
| 3. If neither works, check if golangci-lint is in a local bin directory: | ||
| - `./bin/golangci-lint run` | ||
| - `$(go env GOPATH)/bin/golangci-lint run` | ||
|
|
||
| After running the linter: | ||
| 1. Report the total number of issues found | ||
| 2. Summarize the issues by category (e.g., goconst, gocyclo, staticcheck, etc.) | ||
| 3. Show the first few issues as examples | ||
| 4. If there are no issues, confirm that the code passes all linter checks | ||
|
|
||
| **Do not fix any issues** - only report what was found. | ||
|
|
||
| If golangci-lint is not installed, inform the user how to install it: | ||
| - macOS/Linux: `curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin` | ||
| - Or using go install: `go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest` | ||
|
|
||
| ## Return Value | ||
| - **Format**: Text report summarizing linter findings | ||
| - **Success**: List of issues grouped by category with counts | ||
| - **No issues**: Confirmation message that code passes all checks | ||
| - **Error**: Installation instructions if golangci-lint is not found | ||
|
|
||
| ## Examples | ||
|
|
||
| 1. **Basic usage**: | ||
| ``` | ||
| /golangci-linter:lint | ||
| ``` | ||
| Output: | ||
| ``` | ||
| Found 15 issues: | ||
| - goconst: 5 issues | ||
| - staticcheck: 4 issues | ||
| - gocyclo: 3 issues | ||
| - revive: 3 issues | ||
|
|
||
| Example issues: | ||
| - pkg/api/handler.go:42: string "application/json" has 3 occurrences (goconst) | ||
| - pkg/utils/helper.go:87: cyclomatic complexity 15 of function ProcessData (gocyclo) | ||
| ``` | ||
|
|
||
| 2. **Clean codebase**: | ||
| ``` | ||
| /golangci-linter:lint | ||
| ``` | ||
| Output: | ||
| ``` | ||
| ✓ Code passes all linter checks (0 issues found) | ||
| ``` | ||
|
|
||
| ## Arguments | ||
| This command takes no arguments. |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Specify language for all fenced code blocks. Add language identifier (e.g., text, bash, shell) after opening fence markers for markdown compliance (MD040). Affects multiple code blocks throughout the file.
Example fixes:
## Synopsis
-```
+```text
/golangci-linter:lintDescription
...
- Basic usage:
-
Output:
/golangci-linter:lint
-
Found 15 issues:
Apply similar fixes to all fenced code blocks in this file.
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 LanguageTool</summary>
[style] ~33-~33: Consider using a different verb for a more formal wording.
Context: ...code passes all linter checks **Do not fix any issues** - only report what was fou...
(FIX_RESOLVE)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
plugins/golangci-linter/commands/lint.md lines 1-74: Several fenced code blocks
in this markdown lack language identifiers (MD040); update every triple-backtick
fence to include an appropriate language tag (e.g., bash, text, shell) — for
usage snippets use "text" or "bash" for shell commands, for outputs use "text" —
apply this consistently to all fenced blocks in the file so each opening becomestext, ```bash, or similar as appropriate.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
|
/ok-to-test |
openshift-ci
Bot
added
ok-to-test
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golangci-linter/.claude-plugin/plugin.json(1 hunks)plugins/golangci-linter/README.md(1 hunks)plugins/golangci-linter/commands/lint-fix.md(1 hunks)plugins/golangci-linter/commands/lint.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- plugins/golangci-linter/.claude-plugin/plugin.json
🧰 Additional context used
🪛 LanguageTool
PLUGINS.md
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...ter:lint-fix** - Run golangci-lint and fix all reported issues - **/golangci-lint...
(FIX_RESOLVE)
plugins/golangci-linter/README.md
[style] ~10-~10: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
plugins/golangci-linter/commands/lint.md
[style] ~33-~33: Consider using a different verb for a more formal wording.
Context: ...code passes all linter checks Do not fix any issues - only report what was fou...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.18.1)
plugins/golangci-linter/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golangci-linter/commands/lint.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (4)
plugins/golangci-linter/README.md (1)
24-90: Approved: Documentation structure and formatting are solid.The README is well-organized with clear sections on commands, prerequisites, permissions, usage patterns, and supported linter categories. All fenced code blocks have proper language identifiers, addressing previous markdown compliance concerns. The table-based permission documentation is helpful for users.
.claude-plugin/marketplace.json (1)
132-136: Approved: Marketplace entry is properly formatted.The golangci-linter plugin entry is correctly structured, follows the pattern of existing entries, and contains appropriate metadata for marketplace registration.
docs/data.json (1)
979-1000: Approved: Plugin metadata entry is well-structured.The golangci-linter entry in docs/data.json is properly formatted with complete command definitions, appropriate metadata, and correct version numbering. The structure aligns with other plugin entries in the file.
PLUGINS.md (1)
132-140: Verify no duplicate plugin entry exists.The AI summary claims the Golangci Linter Plugin section appears twice, but the provided code snippet (lines 132–140) shows only one occurrence. The table of contents reference and main section are properly positioned. Unable to verify the full document due to access limitations—please confirm in the actual PR whether a duplicate section exists elsewhere in PLUGINS.md.
| ``` | ||
| /golangci-linter:lint | ||
| ``` |
There was a problem hiding this comment.
Add language identifier to code block.
Line 9 has a fenced code block without a language specifier, which violates MD040 markdown compliance. Update it to use text as the language identifier since it contains a command synopsis.
## Synopsis
-```
+```text
/golangci-linter:lint
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In plugins/golangci-linter/commands/lint.md around lines 9 to 11, the fenced
code block is missing a language identifier (violates MD040); update the opening
triple-backtick to include "text" so the block becomes a fenced code block with
language specifier (use text) to properly label the command synopsis.
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
ec55d9b to
7ee7dc0
Compare
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (1)
PLUGINS.md (1)
134-134: Consider hyphenating compound adjective.The phrase "codebase related" should be hyphenated as "codebase-related" when used as a compound adjective. However, also note the description inconsistency with marketplace.json (flagged separately).
-Run golang codebase related commands and tools +Run golang codebase-related commands and toolsOr better yet, align with the marketplace.json description:
-Run golang codebase related commands and tools +Go code quality checking and linting using golangci-lint
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golang/.claude-plugin/plugin.json(1 hunks)plugins/golang/README.md(1 hunks)plugins/golang/commands/lint-fix.md(1 hunks)plugins/golang/commands/lint.md(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- plugins/golang/commands/lint-fix.md
- plugins/golang/.claude-plugin/plugin.json
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/data.json
🧰 Additional context used
🪛 LanguageTool
plugins/golang/commands/lint.md
[grammar] ~20-~20: Ensure spelling is correct
Context: ...(if either works proceed to next phase): 1. Lookup the Makefile in the directory and look ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~48-~48: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
PLUGINS.md
[grammar] ~134-~134: Use a hyphen to join words.
Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*...
(QB_NEW_EN_HYPHEN)
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
plugins/golang/README.md (1)
14-17: LGTM!The command names correctly use the
/golang:prefix matching the plugin registration.PLUGINS.md (1)
132-140: LGTM!The Golang Plugin section correctly uses the
/golang:command prefix, consistent with the plugin registration in marketplace.json.plugins/golang/commands/lint.md (1)
5-11: LGTM!The command name and synopsis correctly use the
golang:prefix, consistent with the plugin registration.
| ``` | ||
| /golang:lint | ||
| ``` |
There was a problem hiding this comment.
Fix markdown and spelling issues.
Two issues found:
- Line 9: The code fence should specify a language identifier for markdown compliance (MD040)
- Line 48: Spelling error "succesfully" should be "successfully"
## Synopsis
-```
+```bash
/golang:lint
```diff
-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully
+- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
Also applies to: 48-48
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In plugins/golang/commands/lint.md around lines 9-11 and line 48, the markdown
has two issues: the fenced code block at line 9 is missing a language identifier
and must be changed to a language-specified fence (e.g., ```bash) and at line 48
the word "succesfully" is misspelled; correct it to "successfully". Ensure the
code fence uses the language identifier and update the spelling in place.
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (7)
plugins/golang/commands/lint.md (4)
9-11: Fix markdown compliance: add language identifier to code fence.The code fence is missing a language identifier, which violates markdown best practices (MD040).
Apply this diff:
## Synopsis -``` +```bash /golang:lint--- `20-21`: **Fix grammar: "Lookup" should be two words.** "Lookup" as a verb should be "Look up" or use "Check" for better readability. Apply this diff: ```diff -1. Lookup the Makefile in the directory and look for a make target like `make lint`, run it +1. Check the Makefile in the directory and look for a make target like `make lint`, run it
42-42: Fix grammar: incorrect word order.The sentence has incorrect word order and should read "Do not attempt to fix any issues yet."
Apply this diff:
-**Do not fix attempt to any issues yet**. +**Do not attempt to fix any issues yet**.
48-48: Fix spelling: "succesfully" should be "successfully".Apply this diff:
-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfullyplugins/golang/commands/lint-fix.md (1)
9-11: Add language identifier to code fence.The code fence is missing a language identifier, which violates markdown compliance (MD040).
Apply this diff:
## Synopsis -``` +```text /golang:lint-fix</blockquote></details> <details> <summary>plugins/golang/README.md (2)</summary><blockquote> `1-1`: **Update title to match plugin name.** The title "golangci-linter Plugin" doesn't match the registered plugin name "golang". Use "Golang Plugin" for consistency with the marketplace registration. Apply this diff: ```diff -# golangci-linter Plugin +# Golang Plugin
62-76: Critical: Incorrect command prefix in usage examples.The usage examples reference
/golangci-linter:lintand/golangci-linter:lint-fix, but the plugin is registered as "golang". The correct commands are/golang:lintand/golang:lint-fix(as shown in the commands table on lines 16-17).Apply this diff:
## Usage -### `/golangci-linter:lint`: check for linter issues +### `/golang:lint`: check for linter issues This will: 1. Run golangci-lint using available methods 2. Report total number of issues found 3. Summarize issues by category (goconst, gocyclo, staticcheck, etc.) 4. Show example issues -### `/golangci-linter:lint-fix`: check for linter issues and fix them +### `/golang:lint-fix`: check for linter issues and fix them This will: -1. Run `/golangci-linter:lint` to identify all issues +1. Run `/golang:lint` to identify all issues 2. Systematically fix each category of issues 3. Re-run linter after each fix to verify 4. Continue until all issues are resolved
🧹 Nitpick comments (1)
plugins/golang/.claude-plugin/plugin.json (1)
8-8: Add newline at end of file.The file is missing a newline at the end, which is a common convention in text files.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golang/.claude-plugin/plugin.json(1 hunks)plugins/golang/README.md(1 hunks)plugins/golang/commands/lint-fix.md(1 hunks)plugins/golang/commands/lint.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
plugins/golang/commands/lint.md
[grammar] ~20-~20: Ensure spelling is correct
Context: ...(if either works proceed to next phase): 1. Lookup the Makefile in the directory and look ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~48-~48: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
PLUGINS.md
[grammar] ~134-~134: Use a hyphen to join words.
Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*...
(QB_NEW_EN_HYPHEN)
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint.md
31-31: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
plugins/golang/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
.claude-plugin/marketplace.json (1)
132-136: LGTM! Well-formed marketplace entry.The golang plugin entry is properly structured with a clear, descriptive text. This description should be used consistently across plugin.json and PLUGINS.md.
docs/data.json (1)
979-1000: LGTM! Properly structured plugin entry.The golang plugin entry in the public documentation catalog is well-formed with consistent descriptions, correct command definitions, and appropriate metadata. The entry aligns with the marketplace registration.
PLUGINS.md (1)
14-14: No duplicate Golang Plugin section exists in PLUGINS.md.Line 14 contains a table of contents link (
- [Golang](#golang-plugin)) that references the single Golang Plugin section at line 132. No actual duplicate section is present in the document.Likely an incorrect or invalid review comment.
| @@ -0,0 +1,8 @@ | |||
| { | |||
| "name": "golang", | |||
| "description": "Run golang codebase related commands and tools", | |||
There was a problem hiding this comment.
Align description with marketplace entry.
The description here differs from the marketplace entry (.claude-plugin/marketplace.json line 135) which states "Run golang to check and fix code quality issues in Go projects". The marketplace description is more specific and user-friendly.
Apply this diff:
{
"name": "golang",
- "description": "Run golang codebase related commands and tools",
+ "description": "Run golang to check and fix code quality issues in Go projects",
"version": "0.1.0",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "description": "Run golang codebase related commands and tools", | |
| { | |
| "name": "golang", | |
| "description": "Run golang to check and fix code quality issues in Go projects", | |
| "version": "0.1.0", |
🤖 Prompt for AI Agents
In plugins/golang/.claude-plugin/plugin.json around line 3, the "description"
value is too generic and differs from the marketplace entry; update the
description string to match the marketplace wording: "Run golang to check and
fix code quality issues in Go projects". Modify that field only, preserving
surrounding JSON formatting and commas.
7ee7dc0 to
355371e
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (4)
plugins/golang/commands/lint-fix.md (2)
9-11: Add language identifier to code block.The code block is missing a language specifier, which violates markdown best practices (MD040).
🔎 Apply this diff to add the language identifier:
## Synopsis -``` +```text /golang:lint-fix</details> --- `66-66`: **Critical: Incorrect command prefix in example.** The example still references `/golangci-linter:lint-fix` but the plugin is registered as "golang". The correct command is `/golang:lint-fix`. <details> <summary>🔎 Apply this diff to fix the command:</summary> ```diff ```text - /golangci-linter:lint-fix + /golang:lint-fix ```plugins/golang/commands/lint.md (2)
9-11: Add language identifier to code block.The code block is missing a language specifier, which violates markdown best practices (MD040).
🔎 Apply this diff to add the language identifier:
## Synopsis -``` +```text /golang:lint</details> --- `48-48`: **Fix spelling error.** The word "succesfully" is misspelled. <details> <summary>🔎 Apply this diff to correct the spelling:</summary> ```diff -- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golang/.claude-plugin/plugin.json(1 hunks)plugins/golang/README.md(1 hunks)plugins/golang/commands/lint-fix.md(1 hunks)plugins/golang/commands/lint.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- .claude-plugin/marketplace.json
- plugins/golang/.claude-plugin/plugin.json
🧰 Additional context used
🪛 GitHub Actions: Lint Plugins
docs/data.json
[error] 1-1: CLAUDELINT: docs/data.json is out of sync with plugin metadata. Run 'make update' to update.
PLUGINS.md
[error] 1-1: CLAUDELINT: PLUGINS.md is out of sync with plugin metadata. Run 'make update' to update.
🪛 LanguageTool
PLUGINS.md
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
plugins/golang/commands/lint.md
[style] ~42-~42: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
[grammar] ~48-~48: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint-fix.md
31-31: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
plugins/golang/commands/lint.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
82-82: Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (3)
plugins/golang/README.md (1)
1-76: LGTM! Previous issues have been addressed.The README correctly uses the "Golang Plugin" title matching the plugin registration, and all command examples use the correct
/golang:prefix. The documentation is clear and well-structured.docs/data.json (1)
978-1000: Run 'make update' to sync plugin metadata.The pipeline failure indicates that docs/data.json is out of sync with plugin metadata. This file is automatically generated from plugin source files by running
make update, which executes build-website.py to aggregate commands, skills, and hooks from plugins//commands/.md and other metadata sources into the docs/data.json file.PLUGINS.md (1)
132-140: Run 'make update' to sync plugin metadata.The pipeline failure indicates that PLUGINS.md is out of sync with plugin metadata. The content appears correct, but you need to run
make updateto regenerate this file from the plugin metadata.#!/bin/bash # Description: Run make update to sync plugin metadata files # Expected: PLUGINS.md and docs/data.json will be regenerated and synchronized make update
| "description": "BigQuery analysis utilities" | ||
| }, | ||
| { | ||
| "name": "golang", |
There was a problem hiding this comment.
Can this be included inside utils plugin? Or are there any plans to extend this plugin further?
There was a problem hiding this comment.
just came across this other (somewhat related, yet different) PR: #222,
so I guess it is reasonable to introduce a plugin-set for "golang" assuming in the future more go plugins would come up.
| - **`/golang:lint-fix`** - Run golangci-lint tool and fix all reported issues | ||
| - **`/golang:lint`** - Run golangci-lint tool to check for code quality issues |
There was a problem hiding this comment.
I think this can be a single slash command with optional user-provided input. If the user says yes, then fix the issues; else just exit with the analysis.
355371e to
c1f40dc
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
PLUGINS.md (1)
1-313: Critical: PLUGINS.md is out of sync with plugin metadata.The pipeline failure indicates this file needs to be regenerated. Run
make updateto synchronize PLUGINS.md with the plugin metadata.#!/bin/bash # Verify the make update command is available make -n update 2>&1 | head -5
♻️ Duplicate comments (4)
.claude-plugin/marketplace.json (1)
132-136: Address design feedback: plugin scope and organization.A reviewer (chiragkyal) raised a valid question about whether this functionality should be included in the existing
utilsplugin or if there are plans to extend thisgolangplugin further. Please clarify:
- Why a separate plugin is warranted vs. adding to
utils- Whether additional Go-related commands are planned
This helps ensure proper plugin organization and avoid plugin proliferation.
plugins/golang/.claude-plugin/plugin.json (1)
3-3: Align description with marketplace entry for consistency.The description "Run golang codebase related commands and tools" is generic and differs from the marketplace entry (.claude-plugin/marketplace.json line 135) which states "Go code quality checking and linting using golangci-lint". Use consistent, specific descriptions across all plugin metadata files.
🔎 Apply this diff to use the marketplace description:
{ "name": "golang", - "description": "Run golang codebase related commands and tools", + "description": "Go code quality checking and linting using golangci-lint", "version": "0.1.0",plugins/golang/commands/lint.md (2)
82-84: Remove duplicate "Examples" heading.There are two "## Examples" headings (lines 50 and 82). Rename the second one to distinguish it or merge the content.
🔎 Apply this diff:
-## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`
48-48: Fix spelling error."succesfully" should be "successfully".
-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
🧹 Nitpick comments (3)
plugins/golang/commands/lint-fix.md (2)
9-11: Add language identifier to code block.The fenced code block lacks a language identifier, violating markdown best practices (MD040).
🔎 Apply this diff:
## Synopsis -``` +```text /golang:lint-fix</details> --- `31-37`: **Consider adjusting heading level for consistency.** The h3 heading "Fix all issues systematically" directly follows an h2, skipping a level. Consider using h2 for better document structure, or add an intermediate h2 if this is intentionally a subsection. </blockquote></details> <details> <summary>plugins/golang/commands/lint.md (1)</summary><blockquote> `9-11`: **Add language identifier to code block.** The fenced code block lacks a language identifier, violating markdown best practices (MD040). <details> <summary>🔎 Apply this diff:</summary> ```diff ## Synopsis -``` +```text /golang:lint</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Cache: Disabled due to data retention organization setting** **Knowledge base: Disabled due to data retention organization setting** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 355371e2f92a7c467e15b3a7ae77536c6aca6cae and c1f40dc0bf9aa8b77d0e575a47f4d445aa89ab50. </details> <details> <summary>📒 Files selected for processing (7)</summary> * `.claude-plugin/marketplace.json` (1 hunks) * `PLUGINS.md` (2 hunks) * `docs/data.json` (1 hunks) * `plugins/golang/.claude-plugin/plugin.json` (1 hunks) * `plugins/golang/README.md` (1 hunks) * `plugins/golang/commands/lint-fix.md` (1 hunks) * `plugins/golang/commands/lint.md` (1 hunks) </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (1)</summary> * docs/data.json </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 GitHub Actions: Lint Plugins</summary> <details> <summary>PLUGINS.md</summary> [error] 1-1: PLUGINS.md is out of sync with plugin metadata. Run 'make update' to update. </details> </details> <details> <summary>🪛 LanguageTool</summary> <details> <summary>plugins/golang/commands/lint.md</summary> [style] ~42-~42: Consider using a different verb for a more formal wording. Context: ...all linter checks +**Do not attempt to fix any issues yet**. ## Return Value - **... (FIX_RESOLVE) --- [grammar] ~48-~48: Ensure spelling is correct Context: ...-lint was unable to be installed or run succesfully ## Examples 1. **Basic usage**: ```text... (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) </details> <details> <summary>PLUGINS.md</summary> [grammar] ~134-~134: Use a hyphen to join words. Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*... (QB_NEW_EN_HYPHEN) --- [style] ~137-~137: Consider using a different verb for a more formal wording. Context: ...int-fix`** - Run golangci-lint tool and fix all reported issues - **`/golang:lint`*... (FIX_RESOLVE) </details> <details> <summary>plugins/golang/README.md</summary> [style] ~17-~17: Consider using a different verb for a more formal wording. Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites... (FIX_RESOLVE) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>plugins/golang/commands/lint.md</summary> 9-9: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 82-82: Multiple headings with the same content (MD024, no-duplicate-heading) </details> <details> <summary>plugins/golang/commands/lint-fix.md</summary> 31-31: Heading levels should only increment by one level at a time Expected: h2; Actual: h3 (MD001, heading-increment) </details> </details> </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>PLUGINS.md (1)</summary><blockquote> `137-138`: **Consider design feedback: single command with optional fix parameter.** A previous reviewer (chiragkyal) suggested combining `/golang:lint` and `/golang:lint-fix` into a single command where the user can optionally request fixes. This could simplify the interface: - `/golang:lint` - analyze only - `/golang:lint yes` - analyze and fix This design question should be addressed before merging. </blockquote></details> <details> <summary>plugins/golang/README.md (1)</summary><blockquote> `25-58`: **Clarify status of TODO permissions section.** The 34-line permissions section is marked as TODO and commented out. Should this section be: 1. Removed if permissions are not needed 2. Reviewed and uncommented if ready 3. Left as-is if still under consideration Please clarify the intended status before merging. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
c1f40dc to
f6b07ca
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
PLUGINS.md (1)
1-1: Critical: Pipeline failure - PLUGINS.md out of sync.The GitHub Actions pipeline reports that PLUGINS.md is out of sync with plugin metadata. Run
make updateto regenerate this file and ensure consistency.#!/bin/bash # Verify the sync issue by running make update cd "${REPO_ROOT:-.}" make update git diff PLUGINS.md
♻️ Duplicate comments (6)
plugins/golang/commands/lint-fix.md (3)
91-91: Critical: Wrong command prefix in example.Same issue as line 66 - the example shows
/golangci-linter:lint-fixbut should be/golang:lint-fix.🔎 Apply this diff:
```text - /golang:lint-fix + /golang:lint-fix ```
66-66: Critical: Wrong command prefix in example.The example shows
/golangci-linter:lint-fixbut the plugin is registered as "golang", so the correct command is/golang:lint-fix.🔎 Apply this diff:
```text - /golangci-linter:lint-fix + /golang:lint-fix ```
9-11: Add language identifier to code fence.The code fence should specify a language identifier for markdown compliance (MD040).
🔎 Apply this diff:
## Synopsis -``` +```bash /golang:lint-fix</details> </blockquote></details> <details> <summary>plugins/golang/commands/lint.md (3)</summary><blockquote> `82-84`: **Rename duplicate heading.** There are two "## Examples" headings (lines 50 and 82), which violates markdown best practices (MD024). Rename the second heading to differentiate it. <details> <summary>🔎 Apply this diff:</summary> ```diff -## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`
48-48: Fix spelling error."succesfully" should be "successfully".
🔎 Apply this diff:
-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
9-11: Add language identifier to code fence.The code fence should specify a language identifier for markdown compliance (MD040).
🔎 Apply this diff:
## Synopsis -``` +```bash /golang:lint</details> </blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>plugins/golang/.claude-plugin/plugin.json (1)</summary><blockquote> `3-3`: **Use the more specific marketplace description.** The description here is generic ("Run golang codebase related commands and tools") compared to the marketplace entry which states "Go code quality checking and linting using golangci-lint". The marketplace description better conveys the plugin's purpose. <details> <summary>🔎 Apply this diff to align with marketplace:</summary> ```diff { "name": "golang", - "description": "Run golang codebase related commands and tools", + "description": "Go code quality checking and linting using golangci-lint", "version": "0.1.0",
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golang/.claude-plugin/plugin.json(1 hunks)plugins/golang/README.md(1 hunks)plugins/golang/commands/lint-fix.md(1 hunks)plugins/golang/commands/lint.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/data.json
🧰 Additional context used
🪛 GitHub Actions: Lint Plugins
PLUGINS.md
[error] 1-1: PLUGINS.md is out of sync with plugin metadata. Run 'make update' to update.
🪛 LanguageTool
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
PLUGINS.md
[grammar] ~134-~134: Use a hyphen to join words.
Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*...
(QB_NEW_EN_HYPHEN)
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/commands/lint.md
[style] ~42-~42: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
[grammar] ~48-~48: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golang/commands/lint.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
82-82: Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (3)
PLUGINS.md (1)
137-138: Consider consolidating commands into a single slash command.A reviewer suggested combining
/golang:lintand/golang:lint-fixinto a single command with optional user input (e.g., prompt user "fix issues? yes/no"). This would simplify the interface. However, having separate commands follows the existing pattern in other plugins and provides clearer intent. The current approach is acceptable but worth discussing with the team.plugins/golang/README.md (1)
1-76: LGTM! Clear and comprehensive plugin documentation.The README provides clear installation instructions, command descriptions, prerequisites, and usage examples. The commented-out permissions section is appropriately marked as a TODO for future refinement.
.claude-plugin/marketplace.json (1)
132-136: Consider the plugin placement architectural question.A reviewer asked whether this functionality should be included in the existing
utilsplugin rather than creating a dedicatedgolangplugin. This is a valid design question:
- Dedicated plugin: Makes sense if there are plans to add more golang-specific commands beyond linting
- Utils plugin: Appropriate for one-off utilities without expansion plans
The current approach is reasonable but worth confirming with maintainers whether future golang-related commands are planned.
f6b07ca to
ccd6b57
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
PLUGINS.md (1)
134-134: Consider adding hyphen for compound modifier.The phrase "golang codebase related" should use a hyphen: "golang codebase-related" when "codebase-related" acts as a compound modifier before "commands and tools".
-Run golang codebase related commands and tools +Run golang codebase-related commands and tools
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.json(1 hunks)PLUGINS.md(2 hunks)docs/data.json(1 hunks)plugins/golang/.claude-plugin/plugin.json(1 hunks)plugins/golang/README.md(1 hunks)plugins/golang/commands/lint-fix.md(1 hunks)plugins/golang/commands/lint.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- plugins/golang/.claude-plugin/plugin.json
- docs/data.json
🧰 Additional context used
🪛 LanguageTool
plugins/golang/commands/lint.md
[style] ~42-~42: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
[grammar] ~48-~48: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
PLUGINS.md
[grammar] ~134-~134: Use a hyphen to join words.
Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*...
(QB_NEW_EN_HYPHEN)
[style] ~137-~137: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golang/commands/lint.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
82-82: Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (3)
plugins/golang/README.md (1)
1-76: Documentation looks comprehensive and well-structured.The README provides clear installation instructions, command descriptions, prerequisites, and usage flows. The commented-out permissions section is appropriately marked for future review.
.claude-plugin/marketplace.json (1)
132-136: Consider the plugin organization question.A previous comment asked whether this functionality should be part of the utils plugin instead of a standalone golang plugin. While a dedicated plugin provides better discoverability and focus for Go-specific tooling, the utils plugin is described as a "catch-all for various helper commands" which could also be appropriate.
This is primarily an architectural/organizational decision for the maintainers.
PLUGINS.md (1)
137-138: Consider the command design suggestion.A previous comment suggested combining
/golang:lintand/golang:lint-fixinto a single command with optional user input (e.g., ask "Should I fix the issues?" after analysis). This could simplify the UX by reducing the command count.However, having separate commands provides clearer intent and makes it easier to run read-only checks without the prompt overhead.
| golang:lint-fix | ||
|
|
||
| ## Synopsis | ||
| ``` |
There was a problem hiding this comment.
Add language specifier to code fence.
The Synopsis code block is missing a language identifier, which violates markdown best practices.
## Synopsis
-```
+```bash
/golang:lint-fix
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
In plugins/golang/commands/lint-fix.md around line 9, the Synopsis code fence is
missing a language specifier; update the opening fence from tobash so
the snippet becomes a fenced bash block (i.e., change the code fence only to
include "bash" immediately after the backticks).
</details>
<!-- fingerprinting:phantom:poseidon:puma -->
<!-- This is an auto-generated comment by CodeRabbit -->
| golang:lint | ||
|
|
||
| ## Synopsis | ||
| ``` |
There was a problem hiding this comment.
Fix documentation quality issues.
Three minor issues need correction:
- Line 9: Missing language specifier for code fence (should be
bash` ortext`) - Line 48: Spelling error "succesfully" → "successfully"
- Lines 82-84: Duplicate "Examples" heading (rename to "Argument Examples" or merge with first Examples section)
🔎 Apply these fixes:
## Synopsis
-```
+```bash
/golang:lint
```diff
-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully
+- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
-## Examples
+## Argument Examples
- `/golang:lint --tests` will run `golangci-lint run --tests`
- `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml` Also applies to: 48-48, 82-84
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In plugins/golang/commands/lint.md around line 9, add a language specifier to
the opening code fence (e.g., ```bash) to ensure proper syntax highlighting; at
line 48 fix the spelling mistake by changing "succesfully" to "successfully";
and for lines 82-84 resolve the duplicate "Examples" heading by either renaming
the second occurrence to "Argument Examples" or merging its content into the
first Examples section so there is only one appropriately labelled examples
section.
|
/retest |
ccd6b57 to
397cb1f
Compare
|
/test all |
|
/remove-label ok-to-test |
|
@swghosh: Can not set label ok-to-test: Must be member in one of these teams: [openshift-patch-managers openshift-staff-engineers openshift-release-oversight openshift-sustaining-engineers] DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
f35aec1 to
7d49200
Compare
openshift-merge-robot
removed
the
needs-rebase
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (6)
plugins/golang/commands/lint.md (3)
9-12: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040).
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint /golang:lint [<linter-flags>]</details> --- `57-57`: **Fix spelling error.** "succesfully" should be "successfully". <details> <summary>🔎 Proposed fix</summary> ```diff -- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
93-95: Remove duplicate "Examples" heading.There are two "## Examples" headings in this file (lines 59 and 93), which violates MD024. Rename the second one to "## Argument Examples" or merge the content with the first Examples section.
🔎 Proposed fix
-## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`plugins/golang/.claude-plugin/plugin.json (1)
3-3: Align description with marketplace entry.The description here ("Run golang codebase related commands and tools") differs from the marketplace entry which states "Go code quality checking and linting using golangci-lint". The marketplace description is more specific and accurate for this plugin's purpose.
🔎 Proposed fix
{ "name": "golang", - "description": "Run golang codebase related commands and tools", + "description": "Go code quality checking and linting using golangci-lint", "version": "0.1.0",PLUGINS.md (1)
137-137: Align description with marketplace entry.The description "Run golang codebase related commands and tools" differs from the marketplace entry which states "Go code quality checking and linting using golangci-lint". Use the more specific marketplace description for consistency across all documentation.
🔎 Proposed fix
### Golang Plugin -Run golang codebase related commands and tools +Go code quality checking and linting using golangci-lintplugins/golang/commands/lint-fix.md (1)
9-12: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040).
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint-fix /golang:lint-fix [<linter-flags>]</details> </blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (1)</summary><blockquote> <details> <summary>plugins/golang/commands/lint-fix.md (1)</summary><blockquote> `45-54`: **Fix heading level increment.** The "### Important Guidelines" heading (h3) appears directly after "## Implementation" (h2) with content in between. This violates MD001 - headings should only increment by one level at a time. Consider making "Important Guidelines" an h2 heading or restructuring as a numbered step within Implementation. <details> <summary>🔎 Proposed fix - Option 1 (make it h2)</summary> ```diff -### Important Guidelines +## Important GuidelinesOr Option 2: Integrate into Implementation as step 5.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.jsonPLUGINS.mddocs/data.jsonplugins/golang/.claude-plugin/plugin.jsonplugins/golang/README.mdplugins/golang/commands/lint-fix.mdplugins/golang/commands/lint.md
🧰 Additional context used
🪛 GitHub Actions: Lint Plugins
.claude-plugin/marketplace.json
[error] 1-1: Plugin 'workspaces' not registered in marketplace.json
docs/data.json
[error] 1-1: docs/data.json is out of sync with plugin metadata. Run 'make update' to update.
🪛 LanguageTool
PLUGINS.md
[grammar] ~137-~137: Use a hyphen to join words.
Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*...
(QB_NEW_EN_HYPHEN)
[style] ~140-~140: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
plugins/golang/commands/lint.md
[style] ~51-~51: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
[grammar] ~57-~57: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/commands/lint-fix.md
32-32: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (2)
plugins/golang/README.md (1)
1-76: LGTM!The documentation is well-structured with proper command prefixes, language specifiers on code blocks, and clear usage instructions. Previous issues have been successfully addressed.
.claude-plugin/marketplace.json (1)
132-136: LGTM!The golang plugin entry correctly replaces the workspaces plugin with an accurate, descriptive summary. The pipeline error about the workspaces plugin not being registered is expected since it was intentionally replaced.
| { | ||
| "commands": [ | ||
| { | ||
| "argument_hint": "<short-description> <repo1|url> [repo2...]", | ||
| "description": "Create a workspace with git worktrees for multi-repository development", | ||
| "name": "create", | ||
| "synopsis": "/workspaces:create <short-description> <repo1|url> [repo2...]" | ||
| "argument_hint": "", | ||
| "description": "Run golangci-lint tool and fix all reported issues", | ||
| "name": "lint-fix", | ||
| "synopsis": "/golang:lint-fix" | ||
| }, | ||
| { | ||
| "argument_hint": "<workspace-name>", | ||
| "description": "Delete a workspace and its git worktrees", | ||
| "name": "delete", | ||
| "synopsis": "/workspaces:delete <workspace-name>" | ||
| "argument_hint": "", | ||
| "description": "Run golangci-lint tool to check for code quality issues", | ||
| "name": "lint", | ||
| "synopsis": "/golang:lint" | ||
| } | ||
| ], | ||
| "description": "Manage isolated git worktree workspaces for multi-repo development", | ||
| "description": "Go code quality checking and linting using golangci-lint", | ||
| "has_readme": true, | ||
| "hooks": [], | ||
| "name": "workspaces", | ||
| "name": "golang", | ||
| "skills": [], | ||
| "version": "1.0.0" | ||
| "version": "0.1.0" | ||
| } |
There was a problem hiding this comment.
Critical: Regenerate data.json using 'make update'.
The pipeline failure indicates that docs/data.json is out of sync with the actual plugin metadata. This file should be generated automatically rather than edited manually to ensure consistency.
Run the following command to regenerate the file:
make updateAfter running this command, commit the regenerated docs/data.json to resolve the pipeline failure.
🤖 Prompt for AI Agents
In docs/data.json around lines 979 to 1000 the file is out of sync with plugin
metadata; regenerate the file instead of editing it manually by running the
repository command to rebuild generated assets (run `make update` locally),
verify the updated docs/data.json contains the correct plugin metadata, and
commit the regenerated docs/data.json to the branch so the pipeline can pass.
7d49200 to
748a891
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
plugins/golang/commands/lint.md (1)
59-98: Resolve duplicate "Examples" heading (MD024).Two sections are titled "## Examples" (lines 59 and 93), which violates markdown compliance. The second section documents argument examples, so rename it accordingly to avoid duplication.
🔎 Apply this fix
-## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`
♻️ Duplicate comments (4)
PLUGINS.md (1)
135-143: Align description with marketplace entry for consistency.The description "Run golang codebase related commands and tools" differs from the more specific marketplace wording. A past review flagged this inconsistency; ensure the description matches the canonical marketplace entry.
🔎 Suggested fix
### Golang Plugin -Run golang codebase related commands and tools +Run golang to check and fix code quality issues in Go projectsplugins/golang/commands/lint.md (2)
9-12: Add language identifier to Synopsis code block (MD040).The code block lacks a language specifier, which violates markdown compliance. This appears to be an unresolved issue from prior review.
🔎 Apply this fix
## Synopsis -``` +```bash /golang:lint /golang:lint [<linter-flags>]</details> --- `57-57`: **Fix spelling error: "succesfully" → "successfully".** Line 57 contains a spelling error that was flagged in prior review but remains unresolved. <details> <summary>🔎 Apply this fix</summary> ```diff -- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfullyplugins/golang/commands/lint-fix.md (1)
9-12: Add language identifier to Synopsis code block (MD040).The code block lacks a language specifier, which violates markdown compliance. This is a minor issue flagged in prior review but remains unresolved.
🔎 Apply this fix
## Synopsis -``` +```bash /golang:lint-fix /golang:lint-fix [<linter-flags>]</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Cache: Disabled due to data retention organization setting** **Knowledge base: Disabled due to data retention organization setting** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7d49200d5ee22fef61cdc5ddef1855f7e829b815 and 748a891cdf39a234da9f50d5ef3283782165c4db. </details> <details> <summary>📒 Files selected for processing (7)</summary> * `.claude-plugin/marketplace.json` * `PLUGINS.md` * `docs/data.json` * `plugins/golang/.claude-plugin/plugin.json` * `plugins/golang/README.md` * `plugins/golang/commands/lint-fix.md` * `plugins/golang/commands/lint.md` </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (3)</summary> * plugins/golang/.claude-plugin/plugin.json * docs/data.json * .claude-plugin/marketplace.json </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>PLUGINS.md</summary> [grammar] ~137-~137: Use a hyphen to join words. Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*... (QB_NEW_EN_HYPHEN) --- [style] ~140-~140: Consider using a different verb for a more formal wording. Context: ...int-fix`** - Run golangci-lint tool and fix all reported issues - **`/golang:lint`*... (FIX_RESOLVE) </details> <details> <summary>plugins/golang/README.md</summary> [style] ~17-~17: Consider using a different verb for a more formal wording. Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites... (FIX_RESOLVE) </details> <details> <summary>plugins/golang/commands/lint.md</summary> [style] ~51-~51: Consider using a different verb for a more formal wording. Context: ...all linter checks +**Do not attempt to fix any issues yet**. ## Return Value - **... (FIX_RESOLVE) --- [grammar] ~57-~57: Ensure spelling is correct Context: ...-lint was unable to be installed or run succesfully ## Examples 1. **Basic usage**: ```text... (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>plugins/golang/commands/lint-fix.md</summary> 9-9: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> <details> <summary>plugins/golang/commands/lint.md</summary> 9-9: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 93-93: Multiple headings with the same content (MD024, no-duplicate-heading) </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>plugins/golang/README.md (1)</summary><blockquote> `1-76`: **✅ Documentation structure is solid.** The README provides clear installation, commands, prerequisites, and usage sections. Command examples consistently use the correct `/golang:lint` and `/golang:lint-fix` prefixes. The commented permissions block shows developer awareness that further review is needed. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
748a891 to
70e0ea3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
PLUGINS.md (1)
137-137: Description inconsistency remains from previous review.The description "Run golang codebase related commands and tools" was flagged in a previous review as needing to match the marketplace entry. The past review comment indicates this should be "Run golang to check and fix code quality issues in Go projects" and was marked as addressed in commit 355371e, but the issue persists in the current code.
🔎 Apply the suggested fix
-Run golang codebase related commands and tools +Run golang to check and fix code quality issues in Go projectsplugins/golang/commands/lint.md (3)
9-12: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040). This issue was flagged in a previous review as addressed but remains in the current code.
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint /golang:lint [<linter-flags>]</details> --- `57-57`: **Fix spelling error.** "succesfully" should be spelled "successfully". This was flagged in a previous review as addressed but remains in the current code. <details> <summary>🔎 Proposed fix</summary> ```diff -- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfully
93-95: Rename duplicate Examples heading.There are two "## Examples" headings in this file (lines 59 and 93), which violates MD024. The second heading should be renamed to distinguish it from the first. This was flagged in a previous review as addressed but remains in the current code.
🔎 Proposed fix
-## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`plugins/golang/commands/lint-fix.md (1)
9-12: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040).
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint-fix /golang:lint-fix [<linter-flags>]</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: Path: .coderabbit.yaml **Review profile**: CHILL **Plan**: Pro **Cache: Disabled due to data retention organization setting** **Knowledge base: Disabled due to data retention organization setting** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 748a891cdf39a234da9f50d5ef3283782165c4db and 70e0ea32f055ec7ab3041c8fa010e4e8bc1cd921. </details> <details> <summary>📒 Files selected for processing (7)</summary> * `.claude-plugin/marketplace.json` * `PLUGINS.md` * `docs/data.json` * `plugins/golang/.claude-plugin/plugin.json` * `plugins/golang/README.md` * `plugins/golang/commands/lint-fix.md` * `plugins/golang/commands/lint.md` </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (2)</summary> * plugins/golang/.claude-plugin/plugin.json * .claude-plugin/marketplace.json </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>plugins/golang/README.md</summary> [style] ~17-~17: Consider using a different verb for a more formal wording. Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites... (FIX_RESOLVE) </details> <details> <summary>PLUGINS.md</summary> [grammar] ~137-~137: Use a hyphen to join words. Context: ... ### Golang Plugin Run golang codebase related commands and tools **Commands:*... (QB_NEW_EN_HYPHEN) --- [style] ~140-~140: Consider using a different verb for a more formal wording. Context: ...int-fix`** - Run golangci-lint tool and fix all reported issues - **`/golang:lint`*... (FIX_RESOLVE) </details> <details> <summary>plugins/golang/commands/lint.md</summary> [style] ~51-~51: Consider using a different verb for a more formal wording. Context: ...all linter checks +**Do not attempt to fix any issues yet**. ## Return Value - **... (FIX_RESOLVE) --- [grammar] ~57-~57: Ensure spelling is correct Context: ...-lint was unable to be installed or run succesfully ## Examples 1. **Basic usage**: ```text... (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>plugins/golang/commands/lint-fix.md</summary> 9-9: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> <details> <summary>plugins/golang/commands/lint.md</summary> 9-9: Fenced code blocks should have a language specified (MD040, fenced-code-language) --- 93-93: Multiple headings with the same content (MD024, no-duplicate-heading) </details> </details> </details> <details> <summary>🔇 Additional comments (9)</summary><blockquote> <details> <summary>PLUGINS.md (1)</summary><blockquote> `14-14`: **LGTM - TOC entry is correctly placed.** The Golang plugin entry is properly positioned alphabetically in the table of contents. </blockquote></details> <details> <summary>plugins/golang/README.md (3)</summary><blockquote> `1-11`: **LGTM - Plugin header and installation instructions are clear.** The plugin title matches the registered name, and the installation command is correct. --- `12-24`: **LGTM - Commands and prerequisites are well documented.** The command table clearly distinguishes between the read-only lint check and the auto-fix variant. Prerequisites appropriately note the optional make target. --- `60-76`: **LGTM - Usage examples are clear and accurate.** The usage section correctly documents both commands with appropriate command prefixes and clear descriptions of their behavior. </blockquote></details> <details> <summary>plugins/golang/commands/lint.md (1)</summary><blockquote> `14-44`: **LGTM - Implementation strategy is comprehensive.** The phased approach with multiple fallback methods for finding and running golangci-lint is well thought out. The instructions for handling missing configuration files are appropriate. </blockquote></details> <details> <summary>plugins/golang/commands/lint-fix.md (2)</summary><blockquote> `19-58`: **LGTM - Implementation strategy is thorough and well-documented.** The step-by-step implementation with category-specific fix strategies is excellent. The note about containerized scripts not supporting `--fix` (line 29) is particularly valuable, and the guidelines section provides practical advice for common scenarios. --- `59-106`: **LGTM - Examples and documentation are clear.** The examples effectively demonstrate both the full fix workflow and the no-op case for an already-clean codebase. The arguments section correctly references the relationship to `/golang:lint`. </blockquote></details> <details> <summary>docs/data.json (2)</summary><blockquote> `1035-1035`: **LGTM - Proper JSON syntax.** The workspaces plugin entry is correctly terminated before the new golang entry. --- `1036-1057`: **Verify this file was generated using `make update`.** A previous review comment indicated that `docs/data.json` should be regenerated using `make update` rather than manually edited to ensure consistency with plugin metadata. Please confirm that this file was generated using the repository's build process. Run the following command to verify the file is up to date: ```bash #!/bin/bash # Regenerate docs/data.json and check for differences make update git diff docs/data.jsonIf there are differences, commit the regenerated version.
| 3. Show the first 2-3 issues as examples | ||
| 4. If there are no issues, confirm that the code passes all linter checks | ||
|
|
||
| +**Do not attempt to fix any issues yet**. |
There was a problem hiding this comment.
Remove stray diff marker character.
Line 51 has a leading + character that appears to be a diff marker accidentally left in the document.
🔎 Proposed fix
-+**Do not attempt to fix any issues yet**.
+**Do not attempt to fix any issues yet**.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| +**Do not attempt to fix any issues yet**. | |
| **Do not attempt to fix any issues yet**. |
🧰 Tools
🪛 LanguageTool
[style] ~51-~51: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
🤖 Prompt for AI Agents
In plugins/golang/commands/lint.md around line 51, there's a stray '+' diff
marker at the start of the line ("+**Do not attempt to fix any issues yet**.") —
remove the leading '+' so the line reads as normal Markdown text without the
diff marker.
70e0ea3 to
d00bacb
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
plugins/golang/commands/lint.md (3)
9-9: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040).
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint
51-51: Remove stray character and fix spelling error.Two issues found:
- Line 51 has a stray
+diff marker character that should be removed.- Line 57 has a spelling error: "succesfully" should be "successfully".
🔎 Proposed fixes
-+**Do not attempt to fix any issues yet**. +**Do not attempt to fix any issues yet**.-- **Error**: Installation instructions if golangci-lint was unable to be installed or run succesfully +- **Error**: Installation instructions if golangci-lint was unable to be installed or run successfullyAlso applies to: 57-57
59-77: Remove duplicate "Examples" heading.There are two "## Examples" headings (lines 59 and 93), which violates the MD024 markdown rule (no duplicate headings). Consider renaming the second one to "## Argument Examples" or merging the argument examples into the first Examples section.
🔎 Proposed fix
## Arguments - **$1** (flags): Optional. Arbitrary flags to be passed to the golangci-lint utility. - Any arguments passed to this command will be chained to the `golangci-lint` tool directly eg. `--tests`, `--concurrency 4`, `--config /path/to/golangci.yaml`, etc. - Do not allow running this command with `--fix` instead ask the user to use the other `/golang:lint-fix` command. -## Examples +## Argument Examples - `/golang:lint --tests` will run `golangci-lint run --tests` - `/golang:lint --concurrency 4 --config /path/to/golangci.yaml` will run `golangci-lint run --concurrency 4 --config /path/to/golangci.yaml`Also applies to: 93-95
plugins/golang/commands/lint-fix.md (1)
9-9: Add language specifier to code fence.The Synopsis code block is missing a language identifier, which violates markdown best practices (MD040).
🔎 Proposed fix
## Synopsis -``` +```bash /golang:lint-fix
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (7)
.claude-plugin/marketplace.jsonPLUGINS.mddocs/data.jsonplugins/golang/.claude-plugin/plugin.jsonplugins/golang/README.mdplugins/golang/commands/lint-fix.mdplugins/golang/commands/lint.md
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/data.json
- plugins/golang/.claude-plugin/plugin.json
- .claude-plugin/marketplace.json
🧰 Additional context used
🪛 LanguageTool
PLUGINS.md
[style] ~140-~140: Consider using a different verb for a more formal wording.
Context: ...int-fix** - Run golangci-lint tool and fix all reported issues - **/golang:lint`*...
(FIX_RESOLVE)
plugins/golang/README.md
[style] ~17-~17: Consider using a different verb for a more formal wording.
Context: ...` | Run golangci-lint and automatically fix all reported issues | ## Prerequisites...
(FIX_RESOLVE)
plugins/golang/commands/lint.md
[style] ~51-~51: Consider using a different verb for a more formal wording.
Context: ...all linter checks +Do not attempt to fix any issues yet. ## Return Value - **...
(FIX_RESOLVE)
[grammar] ~57-~57: Ensure spelling is correct
Context: ...-lint was unable to be installed or run succesfully ## Examples 1. Basic usage: ```text...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
plugins/golang/README.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golang/commands/lint-fix.md
9-9: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
plugins/golang/commands/lint.md
32-32: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
|
|
||
| ## Implementation | ||
|
|
||
| **Phase 1**: Try the following approaches in order (proceed to Phase 2 once any approach succeeds): |
There was a problem hiding this comment.
Projects should really document how to run the linter in their CLAUDE.md file.
There was a problem hiding this comment.
@zaneb , PTAL I have updated the plugin with a preference for linting instructions present in CALUDE.md/AGENTS.md
d00bacb to
68254b9
Compare
openshift-merge-robot
added
the
needs-rebase
There was a problem hiding this comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@PLUGINS.md`:
- Line 146: Update the plugin description string "Run golang codebase related
commands and tools" to correct grammar and improve clarity: hyphenate
"codebase-related" and replace the terse phrase with a more descriptive sentence
(e.g., the marketplace description) that matches the style of other plugin
entries—locate and edit the line containing that exact phrase in PLUGINS.md and
swap it for the improved, clearer description.
In `@plugins/golang/commands/lint.md`:
- Around line 9-12: The fenced code block in plugins/golang/commands/lint.md is
missing a language specifier; update the triple-backtick fence for the snippet
containing "/golang:lint" and "/golang:lint [<linter-flags>]" to include a
language identifier (e.g., bash) so the block becomes ```bash and the closing
``` remains, ensuring the markdown passes MD040 linting.
- Around line 93-94: Update the docs in plugins/golang/commands/lint.md: change
"eg." to "e.g." and ensure a space after the period in the example clause, and
add the missing comma (or better a semicolon) before "instead" in the second
sentence so it reads e.g. "Do not allow running this command with `--fix`,
instead ask..." (or "Do not allow running this command with `--fix`; instead,
ask...") to fix the grammar and punctuation.
68254b9 to
5a20c68
Compare
openshift-merge-robot
removed
the
needs-rebase
7cebd5c to
e1ac019
Compare
| --- | ||
|
|
||
| ## Name | ||
| golang:lint |
There was a problem hiding this comment.
I wonder if this would be better as a skill rather than a command, so that it gets loaded automatically in context rather than in response to specific syntax. (i.e. if the user says "run the linter", or the agent itself decides that it needs to run the linter, the skill would hopefully be loaded.) The lint-fix command can still explicitly request loading the skill.
There was a problem hiding this comment.
Agreed, PTAL updated the lint command to use as a skill instead.
openshift-ci
Bot
added
the
approved
e1ac019 to
dec13fe
Compare
dec13fe to
f30e03d
Compare
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: siddhibhor-56, swghosh, zaneb The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
6 participants
What this PR does / why we need it:
Adds a new golangci-linter plugin that provides commands to check and fix Go code quality issues using golangci-lint.
Which issue(s) this PR fixes:
Fixes
Special notes for your reviewer:
Checklist:
Summary by CodeRabbit
New Features
Documentation
Removed / Updated