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

feat: Generate config descriptions #1842

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from

Conversation

PeterChen13579
Copy link
Collaborator

Fixes #1460

Copy link

codecov bot commented Jan 21, 2025

Codecov Report

Attention: Patch coverage is 84.84848% with 15 lines in your changes missing coverage. Please review.

Project coverage is 72.79%. Comparing base (fbedeff) to head (bc16c43).
Report is 18 commits behind head on develop.

Files with missing lines Patch % Lines
src/util/newconfig/ConfigDescription.hpp 80.76% 3 Missing and 2 partials ⚠️
src/util/newconfig/Types.cpp 85.18% 2 Missing and 2 partials ⚠️
src/util/newconfig/ConfigConstraints.hpp 88.88% 0 Missing and 2 partials ⚠️
src/util/newconfig/ConfigValue.hpp 77.77% 0 Missing and 2 partials ⚠️
src/util/newconfig/Array.hpp 66.66% 0 Missing and 1 partial ⚠️
src/util/newconfig/ValueView.hpp 66.66% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1842      +/-   ##
===========================================
+ Coverage    71.75%   72.79%   +1.04%     
===========================================
  Files          324      335      +11     
  Lines        13265    13620     +355     
  Branches      6742     6915     +173     
===========================================
+ Hits          9518     9915     +397     
+ Misses        1907     1790     -117     
- Partials      1840     1915      +75     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/app/CliArgs.cpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
tests/unit/app/CliArgsTests.cpp Outdated Show resolved Hide resolved
Copy link
Collaborator

@godexsoft godexsoft left a comment

Choose a reason for hiding this comment

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

No real blockers but a few things to consider and a few questions to answer 👍

src/app/CliArgs.cpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ValueView.hpp Show resolved Hide resolved
Copy link
Collaborator

@cindyyan317 cindyyan317 left a comment

Choose a reason for hiding this comment

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

Good work!
Please check if we need to handle empty path input.

src/util/newconfig/ConfigValue.hpp Outdated Show resolved Hide resolved
cindyyan317
cindyyan317 previously approved these changes Jan 30, 2025
Copy link
Collaborator

@cindyyan317 cindyyan317 left a comment

Choose a reason for hiding this comment

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

👍 LGTM

src/app/CliArgs.cpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/Types.hpp Outdated Show resolved Hide resolved
tests/unit/app/CliArgsTests.cpp Outdated Show resolved Hide resolved
tests/unit/app/CliArgsTests.cpp Outdated Show resolved Hide resolved
Copy link
Collaborator

@godexsoft godexsoft left a comment

Choose a reason for hiding this comment

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

Few small things can be improved 👍

src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
src/util/newconfig/ConfigDescription.hpp Outdated Show resolved Hide resolved
tests/unit/app/CliArgsTests.cpp Outdated Show resolved Hide resolved
tests/unit/app/CliArgsTests.cpp Outdated Show resolved Hide resolved
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.

Add descriptive info about various fields of Clio config.
5 participants