Skip to content

Commit 46026f7

Browse files
Rename avoid_using_debug_print -> avoid_debug_print (#138)
* Rename `avoid_using_debug_print` -> `avoid_debug_print` * sort imports
1 parent 5b9e56f commit 46026f7

9 files changed

Lines changed: 32 additions & 32 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 0.1.5
22

3-
- Added `avoid_using_debug_print` rule
3+
- Added `avoid_debug_print` rule
44
- Fixed an issue with no_magic_number lint
55

66
## 0.1.4

example/analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ custom_lint:
1919
- avoid_unnecessary_setstate
2020
- double_literal_format
2121
- avoid_unnecessary_type_assertions
22-
- avoid_using_debug_print
22+
- avoid_debug_print
2323
- avoid_using_api:
2424
severity: info
2525
entries:

lib/analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ custom_lint:
5050
- avoid_unnecessary_type_casts
5151
- avoid_unrelated_type_assertions
5252
- avoid_unused_parameters
53-
- avoid_using_debug_print
53+
- avoid_debug_print
5454

5555
- cyclomatic_complexity:
5656
max_complexity: 10

lib/solid_lints.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
library solid_metrics;
22

33
import 'package:custom_lint_builder/custom_lint_builder.dart';
4+
import 'package:solid_lints/src/lints/avoid_debug_print/avoid_debug_print_rule.dart';
45
import 'package:solid_lints/src/lints/avoid_global_state/avoid_global_state_rule.dart';
56
import 'package:solid_lints/src/lints/avoid_late_keyword/avoid_late_keyword_rule.dart';
67
import 'package:solid_lints/src/lints/avoid_non_null_assertion/avoid_non_null_assertion_rule.dart';
@@ -11,7 +12,6 @@ import 'package:solid_lints/src/lints/avoid_unnecessary_type_casts/avoid_unneces
1112
import 'package:solid_lints/src/lints/avoid_unrelated_type_assertions/avoid_unrelated_type_assertions_rule.dart';
1213
import 'package:solid_lints/src/lints/avoid_unused_parameters/avoid_unused_parameters_rule.dart';
1314
import 'package:solid_lints/src/lints/avoid_using_api/avoid_using_api_rule.dart';
14-
import 'package:solid_lints/src/lints/avoid_using_debug_print/avoid_using_debug_print_rule.dart';
1515
import 'package:solid_lints/src/lints/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
1616
import 'package:solid_lints/src/lints/double_literal_format/double_literal_format_rule.dart';
1717
import 'package:solid_lints/src/lints/function_lines_of_code/function_lines_of_code_metric.dart';
@@ -60,7 +60,7 @@ class _SolidLints extends PluginBase {
6060
PreferLastRule.createRule(configs),
6161
PreferMatchFileNameRule.createRule(configs),
6262
ProperSuperCallsRule.createRule(configs),
63-
AvoidUsingDebugPrint.createRule(configs),
63+
AvoidDebugPrint.createRule(configs),
6464
];
6565

6666
// Return only enabled rules

lib/src/lints/avoid_using_debug_print/avoid_using_debug_print_rule.dart renamed to lib/src/lints/avoid_debug_print/avoid_debug_print_rule.dart

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ import 'package:analyzer/dart/ast/ast.dart';
22
import 'package:analyzer/dart/ast/syntactic_entity.dart';
33
import 'package:analyzer/error/listener.dart';
44
import 'package:custom_lint_builder/custom_lint_builder.dart';
5-
import 'package:solid_lints/src/lints/avoid_using_debug_print/models/avoid_using_debug_print_func_model.dart';
5+
import 'package:solid_lints/src/lints/avoid_debug_print/models/avoid_debug_print_func_model.dart';
66
import 'package:solid_lints/src/models/rule_config.dart';
77
import 'package:solid_lints/src/models/solid_lint_rule.dart';
88

9-
/// A `avoid_using_debug_print` rule which forbids calling or referencing
9+
/// A `avoid_debug_print` rule which forbids calling or referencing
1010
/// debugPrint function from flutter/foundation.
1111
///
1212
/// ### Example
@@ -25,23 +25,23 @@ import 'package:solid_lints/src/models/solid_lint_rule.dart';
2525
/// ```dart
2626
/// log('');
2727
/// ```
28-
class AvoidUsingDebugPrint extends SolidLintRule {
28+
class AvoidDebugPrint extends SolidLintRule {
2929
/// The [LintCode] of this lint rule that represents
3030
/// the error when debugPrint is called
31-
static const lintName = 'avoid_using_debug_print';
31+
static const lintName = 'avoid_debug_print';
3232

33-
AvoidUsingDebugPrint._(super.config);
33+
AvoidDebugPrint._(super.config);
3434

35-
/// Creates a new instance of [AvoidUsingDebugPrint]
35+
/// Creates a new instance of [AvoidDebugPrint]
3636
/// based on the lint configuration.
37-
factory AvoidUsingDebugPrint.createRule(CustomLintConfigs configs) {
37+
factory AvoidDebugPrint.createRule(CustomLintConfigs configs) {
3838
final rule = RuleConfig(
3939
configs: configs,
4040
name: lintName,
4141
problemMessage: (_) => "Avoid using 'debugPrint'",
4242
);
4343

44-
return AvoidUsingDebugPrint._(rule);
44+
return AvoidDebugPrint._(rule);
4545
}
4646

4747
@override
@@ -89,7 +89,7 @@ class AvoidUsingDebugPrint extends SolidLintRule {
8989
required AstNode node,
9090
required ErrorReporter reporter,
9191
}) {
92-
final funcModel = AvoidUsingDebugPrintFuncModel.parseExpression(identifier);
92+
final funcModel = AvoidDebugPrintFuncModel.parseExpression(identifier);
9393

9494
if (funcModel.hasSameName && funcModel.hasTheSameSource) {
9595
reporter.reportErrorForNode(code, node);

lib/src/lints/avoid_using_debug_print/models/avoid_using_debug_print_func_model.dart renamed to lib/src/lints/avoid_debug_print/models/avoid_debug_print_func_model.dart

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
import 'package:analyzer/dart/ast/ast.dart';
22

33
/// A class used to parse function expression
4-
class AvoidUsingDebugPrintFuncModel {
4+
class AvoidDebugPrintFuncModel {
55
/// Function name
66
final String name;
77

88
/// Function's source path
99
final String sourcePath;
1010

1111
/// A class used to parse function expression
12-
const AvoidUsingDebugPrintFuncModel({
12+
const AvoidDebugPrintFuncModel({
1313
required this.name,
1414
required this.sourcePath,
1515
});
1616

1717
/// A constructor that parses identifier into [name] and [sourcePath]
18-
factory AvoidUsingDebugPrintFuncModel.parseExpression(
18+
factory AvoidDebugPrintFuncModel.parseExpression(
1919
Identifier identifier,
2020
) {
2121
switch (identifier) {
2222
case PrefixedIdentifier():
2323
final prefix = identifier.prefix.name;
24-
return AvoidUsingDebugPrintFuncModel(
24+
return AvoidDebugPrintFuncModel(
2525
name: identifier.name.replaceAll('$prefix.', ''),
2626
sourcePath:
2727
identifier.staticElement?.librarySource?.uri.toString() ?? '',
2828
);
2929
case SimpleIdentifier():
30-
return AvoidUsingDebugPrintFuncModel(
30+
return AvoidDebugPrintFuncModel(
3131
name: identifier.name,
3232
sourcePath:
3333
identifier.staticElement?.librarySource?.uri.toString() ?? '',
3434
);
3535
default:
36-
return AvoidUsingDebugPrintFuncModel._empty();
36+
return AvoidDebugPrintFuncModel._empty();
3737
}
3838
}
3939

40-
factory AvoidUsingDebugPrintFuncModel._empty() {
41-
return const AvoidUsingDebugPrintFuncModel(
40+
factory AvoidDebugPrintFuncModel._empty() {
41+
return const AvoidDebugPrintFuncModel(
4242
name: '',
4343
sourcePath: '',
4444
);

lint_test/analysis_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ custom_lint:
2727
- newline_before_return
2828
- no_empty_block
2929
- no_equal_then_else
30-
- avoid_using_debug_print
30+
- avoid_debug_print
3131
- member_ordering:
3232
alphabetize: true
3333
order:

lint_test/avoid_using_debug_print_test.dart/avoid_using_debug_print_prefix_test.dart renamed to lint_test/avoid_debug_print_test.dart/avoid_debug_print_prefix_test.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
import 'package:flutter/foundation.dart' as f;
44

5-
/// Test the avoid_using_debug_print
5+
/// Test the avoid_debug_print
66
void avoidDebugPrintTest() {
7-
// expect_lint: avoid_using_debug_print
7+
// expect_lint: avoid_debug_print
88
f.debugPrint('');
99

10-
// expect_lint: avoid_using_debug_print
10+
// expect_lint: avoid_debug_print
1111
final test = f.debugPrint;
1212

1313
test('test');
1414

15-
// expect_lint: avoid_using_debug_print
15+
// expect_lint: avoid_debug_print
1616
final test2 = f.debugPrint('');
1717

1818
debugPrint();

lint_test/avoid_using_debug_print_test.dart/avoid_using_debug_print_test.dart renamed to lint_test/avoid_debug_print_test.dart/avoid_debug_print_test.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
import 'package:flutter/foundation.dart';
44

5-
/// Test the avoid_using_debug_print
5+
/// Test the avoid_debug_print
66
void avoidDebugPrintTest() {
7-
// expect_lint: avoid_using_debug_print
7+
// expect_lint: avoid_debug_print
88
debugPrint('');
99

10-
// expect_lint: avoid_using_debug_print
10+
// expect_lint: avoid_debug_print
1111
final test = debugPrint;
1212

1313
var test2;
1414

15-
// expect_lint: avoid_using_debug_print
15+
// expect_lint: avoid_debug_print
1616
test2 = debugPrint;
1717

1818
test.call('test');
1919

20-
// expect_lint: avoid_using_debug_print
20+
// expect_lint: avoid_debug_print
2121
final test3 = debugPrint('');
2222

2323
someOtherFunction();

0 commit comments

Comments
 (0)