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

Remove YAML configuration files #97

Merged
merged 21 commits into from
Apr 22, 2024

Conversation

Pennycook
Copy link
Contributor

Related issues

Part of the fix for #87.

Proposed changes

  • Remove --config option and checks for an implicit YAML configuration file.
  • Remove all functionality related to YAML files.
  • Rewrite tests that were previously driven by YAML files.

Note that although the test diffs look big, in many cases this is because touching them triggered the CI checks. Some of the changes to each test are purely formatting. To try and make things simpler to review, I've put all the tests in separate commits.

I also want to draw your attention to the significant amount of bloat that now exists in the tests, with the setup for the codebase and configuration dictionaries that gets repeated in a few places. This was the most expedient way to rewrite the tests to remove the dependency on YAML functionality.

The long-term fix that I have planned here is to introduce a new CodeBase object representing the files in the code base, and to replace the configuration objects entirely by driving things directly from a CompilationDatabase instance. This is a first step towards that, to make sure that everything still works before the refactoring begins.

Previously deprecated in 1.2.0.

Signed-off-by: John Pennycook <[email protected]>
Previously, an analysis file was optional because legacy behavior allowed for
an implicit YAML configuration file called "config.yaml" in the current
directory.

Signed-off-by: John Pennycook <[email protected]>
This was only used to determine a project name from the YAML configuration
file. Output file names for TOML configuration files are derived differently.

Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
@Pennycook Pennycook added the enhancement New feature or request label Apr 4, 2024
@Pennycook Pennycook added this to the 2.0.0 milestone Apr 4, 2024
Copy link
Contributor

@laserkelvin laserkelvin left a comment

Choose a reason for hiding this comment

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

LGTM for the most part, just left two comments

bin/codebasin Show resolved Hide resolved
codebasin/schema/config.schema Outdated Show resolved Hide resolved
@Pennycook Pennycook merged commit e003bc3 into intel:main Apr 22, 2024
3 checks passed
@Pennycook Pennycook deleted the remove-yaml-config-files branch April 22, 2024 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants