refactor: reduce cognitive complexity of generateToolDoc (40 → ~5) - #143
Open
devin-ai-integration[bot] wants to merge 2 commits into
Open
devin-ai-integration[bot] wants to merge 2 commits into
devin-ai-integration[bot] wants to merge 2 commits into
Conversation
Extract helper functions from generateToolDoc to reduce cognitive complexity from 40 to well within the allowed threshold of 15. Extracted functions: - extractPropertyType: determines type string from schema property map - extractPropertyDescription: extracts description from property map - formatParamLine: formats a single parameter documentation line Fixes SonarQube issue go:S3776 on generate_docs.go:220 Co-Authored-By: Vedant Khanna <vedantkhanna@gmail.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
When items map exists but items["type"] is not a string, return "unknown" (matching original behavior) instead of "array". Co-Authored-By: Vedant Khanna <vedantkhanna@gmail.com>
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes: SonarQube issue
go:S3776oncmd/github-mcp-server/generate_docs.go:220Summary
The
generateToolDocfunction had a cognitive complexity of 40 (allowed: 15) due to deeply nested type assertions for schema property inspection. This PR extracts focused helper functions.Extracted Functions
extractPropertyTypeextractPropertyDescriptionformatParamLineTradeoffs
Alternatives
map[string]interface{}schema makes that overly verbose for this use case.Link to Devin session: https://app.devin.ai/sessions/dc69091bf9e24bd2871c88e47fa1cb98
Requested by: @VedantKh
Devin Review