add lint use_string_in_part_of_directives

Author: a14n

example/all.yaml

@@ -203,6 +203,7 @@ linter:
     - use_rethrow_when_possible
     - use_setters_to_change_properties
     - use_string_buffers
+    - use_string_in_part_of_directives
     - use_super_parameters
     - use_test_throws_matchers
     - use_to_and_as_if_applicable

lib/src/rules.dart

@@ -208,6 +208,7 @@ import 'rules/use_raw_strings.dart';
 import 'rules/use_rethrow_when_possible.dart';
 import 'rules/use_setters_to_change_properties.dart';
 import 'rules/use_string_buffers.dart';
+import 'rules/use_string_in_part_of_directives.dart';
 import 'rules/use_super_parameters.dart';
 import 'rules/use_test_throws_matchers.dart';
 import 'rules/use_to_and_as_if_applicable.dart';
@@ -424,6 +425,7 @@ void registerLintRules({bool inTestMode = false}) {
     ..register(UseRawStrings())
     ..register(UseSettersToChangeAProperty())
     ..register(UseStringBuffers())
+    ..register(UseStringInPartOfDirectives())
     ..register(UseSuperParameters())
     ..register(UseTestThrowsMatchers())
     ..register(UseToAndAsIfApplicable())

lib/src/rules/use_string_in_part_of_directives.dart

@@ -0,0 +1,62 @@
+// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/visitor.dart';
+
+import '../analyzer.dart';
+
+const _desc = r'Use string in part of directives.';
+
+const _details = r'''
+
+From [effective dart](https://dart.dev/guides/language/effective-dart/usage#do-use-strings-in-part-of-directives):
+
+**DO** use strings in `part of` directives.
+
+**BAD:**
+
+```dart
+part of my_library;
+```
+
+**GOOD:**
+
+```dart
+part of '../../my_library.dart';
+```
+
+''';
+
+class UseStringInPartOfDirectives extends LintRule {
+  UseStringInPartOfDirectives()
+      : super(
+          name: 'use_string_in_part_of_directives',
+          description: _desc,
+          details: _details,
+          group: Group.style,
+        );
+
+  @override
+  void registerNodeProcessors(
+    NodeLintRegistry registry,
+    LinterContext context,
+  ) {
+    var visitor = _Visitor(this);
+    registry.addPartOfDirective(this, visitor);
+  }
+}
+
+class _Visitor extends SimpleAstVisitor<void> {
+  _Visitor(this.rule);
+
+  final LintRule rule;
+
+  @override
+  void visitPartOfDirective(PartOfDirective node) {
+    if (node.libraryName != null) {
+      rule.reportLint(node);
+    }
+  }
+}

test/integration/use_string_in_part_of_directives.dart

@@ -0,0 +1,68 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'dart:io';
+
+import 'package:analyzer/src/lint/io.dart';
+import 'package:linter/src/analyzer.dart';
+import 'package:linter/src/cli.dart' as cli;
+import 'package:path/path.dart';
+import 'package:test/test.dart';
+
+import '../mocks.dart';
+import '../test_constants.dart';
+
+void main() {
+  group('use_string_in_part_of_directives', () {
+    var currentOut = outSink;
+    var collectingOut = CollectingSink();
+    setUp(() {
+      exitCode = 0;
+      outSink = collectingOut;
+    });
+    tearDown(() {
+      collectingOut.buffer.clear();
+      outSink = currentOut;
+      exitCode = 0;
+    });
+
+    test(timeout: Timeout.none, 'works correctly', () async {
+      await cli.runLinter([
+        '$integrationTestDir/use_string_in_part_of_directives',
+        '--rules=use_string_in_part_of_directives',
+      ], LinterOptions());
+      var files =
+          Directory('$integrationTestDir/use_string_in_part_of_directives')
+              .listSync()
+              .whereType<File>()
+              .toList();
+      var lintsByFile = <File, List<int>>{
+        for (var file in files)
+          file: file
+              .readAsLinesSync()
+              .asMap()
+              .entries
+              .where((e) => e.value.endsWith('// LINT'))
+              .map((e) => e.key + 1)
+              .toList()
+      };
+      var output = collectingOut.trim();
+      for (var entry in lintsByFile.entries) {
+        for (var line in entry.value) {
+          expect(output, contains('/${basename(entry.key.path)} $line:'));
+        }
+      }
+      var fileCount = lintsByFile.length;
+      var issueCount = lintsByFile.values.expand((e) => e).length;
+      expect(
+        output,
+        contains(
+          '$fileCount file${fileCount <= 1 ? '' : 's'} analyzed, '
+          '$issueCount issue${issueCount <= 1 ? '' : 's'} found, in',
+        ),
+      );
+      expect(exitCode, 1);
+    });
+  });
+}

test/integration_test.dart

@@ -49,6 +49,8 @@ import 'integration/unnecessary_string_escapes.dart'
     as unnecessary_string_escapes;
 import 'integration/use_build_context_synchronously.dart'
     as use_build_context_synchronously;
+import 'integration/use_string_in_part_of_directives.dart'
+    as use_string_in_part_of_directives;
 import 'mocks.dart';
 import 'test_constants.dart';
 
@@ -201,6 +203,7 @@ void ruleTests() {
     prefer_mixin.main();
     use_build_context_synchronously.main();
     prefer_const_constructors.main();
+    use_string_in_part_of_directives.main();
   });
 }
 

test_data/integration/use_string_in_part_of_directives/bad_part.dart

@@ -0,0 +1,7 @@
+// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// test w/ `dart test -N use_string_in_part_of_directives`
+
+part of lib; // LINT

test_data/integration/use_string_in_part_of_directives/good_part.dart

@@ -0,0 +1,7 @@
+// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// test w/ `dart test -N use_string_in_part_of_directives`
+
+part of 'lib.dart'; // OK

test_data/integration/use_string_in_part_of_directives/lib.dart

@@ -0,0 +1,10 @@
+// Copyright (c) 2022, the Dart project authors. Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+// test w/ `dart test -N use_string_in_part_of_directives`
+
+library lib;
+
+part 'good_part.dart';
+part 'bad_part.dart';