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

Refactor configuration dict into CompilationDatabase #100

Open
2 of 3 tasks
Pennycook opened this issue Aug 26, 2024 · 0 comments
Open
2 of 3 tasks

Refactor configuration dict into CompilationDatabase #100

Pennycook opened this issue Aug 26, 2024 · 0 comments
Labels
enhancement New feature or request refactor Improvements to code structure

Comments

@Pennycook
Copy link
Contributor

Feature/behavior summary

The configuration dictionary used by Code Base Investigator 1.x stores a subset of the information available in a compilation database. Rather than maintain support for two data formats and move back and forth between them, we should adopt compilation databases as the only representation of a compilation.

Request attributes

  • Would this be a refactor of existing code?
  • Does this proposal require new package dependencies?
  • Would this change break backwards compatibility?

Related issues

No response

Solution description

  • Introduce a CompilationDatabase class that stores CompileCommand objects and is interoperable with JSON.
  • Rewrite external interface(s) to use a CompilationDatabase and update the tests.
  • Rewrite internal interface(s) to use a CompilationDatabase (replacing functionality from config.py).

Additional notes

No response

@Pennycook Pennycook added the enhancement New feature or request label Aug 26, 2024
@Pennycook Pennycook added this to the 2.0.0 milestone Aug 26, 2024
@Pennycook Pennycook self-assigned this Aug 26, 2024
@intel intel deleted a comment Aug 26, 2024
@Pennycook Pennycook removed this from the 2.0.0 milestone Jan 15, 2025
@Pennycook Pennycook added the refactor Improvements to code structure label Jan 17, 2025
@Pennycook Pennycook removed their assignment Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refactor Improvements to code structure
Projects
None yet
Development

No branches or pull requests

4 participants
@Pennycook and others