Create wrapper runCliJson#3981
Open
mario-campos wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Warning
- Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.
Pull request overview
This PR introduces a runCliJson helper in src/codeql.ts to standardize “run CLI command + parse JSON output” behavior, reducing duplicated JSON.parse logic across CodeQL CLI wrapper methods.
Changes:
- Add a generic
runCliJson<T>wrapper aroundrunClithat parses JSON output. - Refactor several CodeQL wrapper methods (e.g.,
resolve languages,resolve build-environment,resolve queries,resolve database,version) to userunCliJsoninstead of inlined parsing.
Show a summary per file
| File | Description |
|---|---|
| src/codeql.ts | Adds runCliJson and refactors multiple CLI wrapper methods to centralize JSON parsing. |
| lib/entry-points.js | Generated JS output update (content excluded from diff; also not generally reviewed for lib/). |
Review details
Files excluded by content exclusion policy (1)
- lib/entry-points.js
- Files reviewed: 1/2 changed files
- Comments generated: 2
- Review effort level: Low
3f66d8e to
6cdc606
Compare
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.
Summary
A few of the CLI commands emit JSON. This PR creates a
runCliwrapper function calledrunCliJsonthat expects JSON output from the CLI command. This change centralizes and reduces the number of JSON-parsing call sites incodeql.ts, making the code more readable and D.R.Y.er.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
dynamicworkflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.upload-sarifaction.Environments:
github.comand/or GitHub Enterprise Cloud with Data Residency.How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist