Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSON Schema for the static analyzer configuration file. #241

Merged
merged 3 commits into from
Mar 4, 2024

Conversation

jacobotb
Copy link
Contributor

@jacobotb jacobotb commented Mar 4, 2024

What problem are you trying to solve?

The IDE plugins need to be able to parse the static analyzer configuration file. Therefore, there needs to be a definition they can use to build their parser.

What is your solution?

A schema definition, with its tests, that defines the format.

Alternatives considered

What the reviewer should know

@jacobotb jacobotb requested a review from juli1 March 4, 2024 18:35
@jacobotb jacobotb force-pushed the jacobotb/STAL-1373/config_schema branch from ae92722 to 52e12d7 Compare March 4, 2024 18:37
@jacobotb jacobotb marked this pull request as ready for review March 4, 2024 18:38
Copy link
Collaborator

@juli1 juli1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Two asks

  1. Can we put the content of the README.md into the main README.md?
  2. Can we have at least a description of the PR and explain the motivation?
  3. Can we also integrate the tests (e.g. at least testing the schema) in the CI workflow to ensure that a change of the schema will be tested to avoid/prevent regression? No need to do anything fancy here, something similar to this

schema/README.md Show resolved Hide resolved
@jacobotb jacobotb requested a review from a team as a code owner March 4, 2024 20:46
@jacobotb jacobotb requested review from modernplumbing and removed request for modernplumbing March 4, 2024 20:46
@jacobotb
Copy link
Contributor Author

jacobotb commented Mar 4, 2024

Added integration schema test, moved documentation to main README.md, updated PR description.

@jacobotb jacobotb merged commit f805427 into main Mar 4, 2024
28 checks passed
@jacobotb jacobotb deleted the jacobotb/STAL-1373/config_schema branch March 4, 2024 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants