feat(score): add --suggestions for hotspot LLM prompts#2754
Draft
adamaltman wants to merge 1 commit into
Draft
Conversation
Made-with: Cursor
|
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
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.
What/Why/How?
What: Adds optional
--suggestionsto the experimentalscorecommand. Hotspot detection now produces structuredissues(stable codes plus the same human messages as before). When the flag is set, the CLI prints copy-paste LLM prompts per hotspot (stylish) and addshotspots[].suggestionin JSON.Why: Brings the score command closer to agent-readiness workflows where users paste actionable prompts into an assistant to improve their OpenAPI description.
How:
getHotspotIssuesinhotspots.tsis the single source of truth;reasonsremainsissues.map((i) => i.message). Newsuggestions.tsimplementsbuildHotspotAgentPrompt. JSON stripsissuesand only attachessuggestionwhen--suggestionsis true so default JSON stays stable.Reference
OpenAPI 3.x
scorecommand; hotspot thresholds unchanged.Testing
packages/cli/src/commands/score/__tests__/(hotspots, suggestions, index).tests/e2e/score/score.test.tsandtests/e2e/score/score-suggestions/snapshot.txt.Screenshots (optional)
Check yourself
Security