Support SARIF as output for redocly lint command.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
Describe the solution you'd like
The Static Analysis Results Interchange Format (SARIF) aims to be an industry standard for the output of static code analysis tools. Therefore it would be very usefull to have the redocly-cli support this format when linting an Open API specification.
CI/CD tools like Azure DevOps support the loading of SARIF reports and as such could easily report the findings of the linting command to an end-user.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the redocly lint command's output handling and trace how findings from an OpenAPI specification are currently formatted. Define the SARIF report shape needed by CI/CD consumers such as Azure DevOps, then verify that lint results can be emitted as valid SARIF.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, devops
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100