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

Add common flags and options #40

Merged
merged 8 commits into from
Oct 22, 2024
Merged

Add common flags and options #40

merged 8 commits into from
Oct 22, 2024

Conversation

rsore
Copy link
Owner

@rsore rsore commented Oct 22, 2024

Description

A lot of programs support the same basic flags and options, for exampe "--help", "--verbose" and "--input ". It makes sense for the library to offer a set of these basic flags and options ready for use so users don't necessarily have to create custom flags and options for everything. They can simply be added to the parser builder and used directly:

auto parser = CLArgs::ParserBuilder{}
    .add_flag<CLArgs::CommonFlags::Verbose>()
    .add_option<CLArgs::CommonOptions::Input>()
    .add_option<UserDefinedCustomOption>()
    .build();

...

if (parser.has_flag<CLArgs::CommonFlags::Verbose>())
{
    // Enable verbose output
}

Related Issues

Closes #32.

How Has This Been Tested?

I implemented tests for all common flags and options I added. The tests themselves do not check behavior in cases like ill-formed values or unknown arguments, these are already handled in other tests. Instead, these simply focus on verifying that the flag and option types can be used with the parser, and that the values are properly set for any of their supported identifiers.

@rsore rsore added the improvement Improvement to existing feature label Oct 22, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

clang-tidy made some suggestions

tests/common_flags_tests.cpp Show resolved Hide resolved
tests/common_flags_tests.cpp Show resolved Hide resolved
tests/common_flags_tests.cpp Show resolved Hide resolved
tests/common_flags_tests.cpp Show resolved Hide resolved
tests/common_options_tests.cpp Show resolved Hide resolved
tests/common_options_tests.cpp Show resolved Hide resolved
tests/common_options_tests.cpp Show resolved Hide resolved
tests/common_options_tests.cpp Show resolved Hide resolved
@rsore rsore force-pushed the common-parameters branch from 5bbb3c5 to e23f506 Compare October 22, 2024 19:59
Copy link

clang-tidy review says "All clean, LGTM! 👍"

@rsore rsore merged commit 2f64f94 into main Oct 22, 2024
5 checks passed
@rsore rsore deleted the common-parameters branch October 22, 2024 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement to existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement common flags and options
1 participant