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

chore(coverde): proper inline doc directives #83

Merged
merged 1 commit into from
Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/coverde_cli/lib/src/commands/check/check.dart
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/// {@template check_cmd}
/// A command to check the minimum coverage value from a trace file.
/// {@endtemplate check_cmd}
/// {@endtemplate}
class CheckCommand extends Command<void> {
/// {@macro check_cmd}
CheckCommand({Stdout? out}) : _out = out ?? stdout {
Expand Down Expand Up @@ -44,26 +44,26 @@
static const verboseFlag = 'verbose';

@override
String get description => '''

Check notice on line 47 in packages/coverde_cli/lib/src/commands/check/check.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/check/check.dart#L47

Missing documentation for a public member. (public_member_api_docs)
Check the coverage value (%) computed from a trace file.

The unique argument should be an integer between 0 and 100.
This parameter indicates the minimum value for the coverage to be accepted.''';

@override
String get name => 'check';

Check notice on line 54 in packages/coverde_cli/lib/src/commands/check/check.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/check/check.dart#L54

Missing documentation for a public member. (public_member_api_docs)

@override
List<String> get aliases => [name[0]];

Check notice on line 57 in packages/coverde_cli/lib/src/commands/check/check.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/check/check.dart#L57

Missing documentation for a public member. (public_member_api_docs)

@override
String get invocation => super.invocation.replaceAll(

Check notice on line 60 in packages/coverde_cli/lib/src/commands/check/check.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/check/check.dart#L60

Missing documentation for a public member. (public_member_api_docs)
'[arguments]',
'[min-coverage]',
);

@override
Future<void> run() async {

Check notice on line 66 in packages/coverde_cli/lib/src/commands/check/check.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/check/check.dart#L66

Missing documentation for a public member. (public_member_api_docs)
// Retrieve arguments and validate their value and the state they represent.
final filePath = checkOption(
optionKey: inputOption,
Expand Down
4 changes: 2 additions & 2 deletions packages/coverde_cli/lib/src/commands/filter/filter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

/// {@template filter_cmd}
/// A command to filter coverage info files.
/// {@endtemplate filter_cmd}
/// {@endtemplate}
class FilterCommand extends Command<void> {
/// {@template filter_cmd}
/// {@macro filter_cmd}
FilterCommand({Stdout? out}) : _out = out ?? stdout {
argParser
..addOption(
Expand Down Expand Up @@ -92,7 +92,7 @@
static const modeOption = 'mode';

@override
String get description => '''

Check notice on line 95 in packages/coverde_cli/lib/src/commands/filter/filter.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/filter/filter.dart#L95

Missing documentation for a public member. (public_member_api_docs)
Filter a coverage trace file.

Filter the coverage info by ignoring data related to files with paths that matches the given $_filtersHelpValue.
Expand All @@ -102,16 +102,16 @@
If an absolute path is found in the coverage trace file, the process will fail.''';

@override
String get name => 'filter';

Check notice on line 105 in packages/coverde_cli/lib/src/commands/filter/filter.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/filter/filter.dart#L105

Missing documentation for a public member. (public_member_api_docs)

@override
List<String> get aliases => [name[0]];

Check notice on line 108 in packages/coverde_cli/lib/src/commands/filter/filter.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/filter/filter.dart#L108

Missing documentation for a public member. (public_member_api_docs)

@override
bool get takesArguments => false;

Check notice on line 111 in packages/coverde_cli/lib/src/commands/filter/filter.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/filter/filter.dart#L111

Missing documentation for a public member. (public_member_api_docs)

@override
Future<void> run() async {

Check notice on line 114 in packages/coverde_cli/lib/src/commands/filter/filter.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/filter/filter.dart#L114

Missing documentation for a public member. (public_member_api_docs)
// Retrieve arguments and validate their value and the state they represent.
final originPath = checkOption(
optionKey: inputOption,
Expand Down
4 changes: 2 additions & 2 deletions packages/coverde_cli/lib/src/commands/value/value.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

/// {@template value_cmd}
/// A command to compute the coverage of a given info file.
/// {@endtemplate filter_cmd}
/// {@endtemplate}
class ValueCommand extends Command<void> {
/// {@template filter_cmd}
/// {@macro filter_cmd}
ValueCommand({Stdout? out}) : _out = out ?? stdout {
argParser
..addOption(
Expand Down Expand Up @@ -43,22 +43,22 @@
static const verboseFlag = 'verbose';

@override
String get description => '''

Check notice on line 46 in packages/coverde_cli/lib/src/commands/value/value.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/value/value.dart#L46

Missing documentation for a public member. (public_member_api_docs)
Compute the coverage value (%) of an info file.

Compute the coverage value of the $_inputHelpValue info file.''';

@override
String get name => 'value';

Check notice on line 52 in packages/coverde_cli/lib/src/commands/value/value.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/value/value.dart#L52

Missing documentation for a public member. (public_member_api_docs)

@override
List<String> get aliases => [name[0]];

Check notice on line 55 in packages/coverde_cli/lib/src/commands/value/value.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/value/value.dart#L55

Missing documentation for a public member. (public_member_api_docs)

@override
bool get takesArguments => false;

Check notice on line 58 in packages/coverde_cli/lib/src/commands/value/value.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/value/value.dart#L58

Missing documentation for a public member. (public_member_api_docs)

@override
Future<void> run() async {

Check notice on line 61 in packages/coverde_cli/lib/src/commands/value/value.dart

View check run for this annotation

codefactor.io / CodeFactor

packages/coverde_cli/lib/src/commands/value/value.dart#L61

Missing documentation for a public member. (public_member_api_docs)
// Retrieve arguments and validate their value and the state they represent.
final filePath = checkOption(
optionKey: inputOption,
Expand Down