Lint to test for private/implementation imports.

Background here: https://github.com/dart-lang/linter/issues/36

[email protected], [email protected]

Review URL: https://codereview.chromium.org//1425293002 .

Author: pq

lib/src/rules.dart

@@ -12,6 +12,7 @@ import 'package:linter/src/rules/always_specify_types.dart';
 import 'package:linter/src/rules/camel_case_types.dart';
 import 'package:linter/src/rules/constant_identifier_names.dart';
 import 'package:linter/src/rules/empty_constructor_bodies.dart';
+import 'package:linter/src/rules/implementation_imports.dart';
 import 'package:linter/src/rules/library_names.dart';
 import 'package:linter/src/rules/library_prefixes.dart';
 import 'package:linter/src/rules/non_constant_identifier_names.dart';
@@ -30,6 +31,7 @@ final Registry ruleRegistry = new Registry()
   ..register(new CamelCaseTypes())
   ..register(new ConstantIdentifierNames())
   ..register(new EmptyConstructorBodies())
+  ..register(new ImplementationImports())
   ..register(new LibraryNames())
   ..register(new LibraryPrefixes())
   ..register(new NonConstantIdentifierNames())

lib/src/rules/implementation_imports.dart

@@ -0,0 +1,95 @@
+// Copyright (c) 2015, 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.
+
+library linter.src.rules.implementation_imports;
+
+import 'package:analyzer/src/generated/ast.dart'
+    show AstVisitor, ImportDirective, SimpleAstVisitor;
+import 'package:linter/src/linter.dart';
+
+const desc = "Don't import implementation files from another package.";
+
+const details = '''
+**DON'T** import implementation files from another package.
+
+From the the [pub package layout doc]
+(https://www.dartlang.org/tools/pub/package-layout.html#implementation-files):
+
+The libraries inside `lib` are publicly visible: other packages are free to
+import them. But much of a package's code is internal implementation libraries
+that should only be imported and used by the package itself. Those go inside a
+subdirectory of `lib` called `src`. You can create subdirectories in there if
+it helps you organize things.
+
+You are free to import libraries that live in `lib/src` from within other Dart
+code in the same package (like other libraries in `lib`, scripts in `bin`,
+and tests) but you should never import from another package's `lib/src`
+directory. Those files are not part of the package’s public API, and they
+might change in ways that could break your code.
+
+**Bad:**
+
+```
+// In 'road_runner'
+import 'package:acme/lib/src/internals.dart;
+```
+''';
+
+bool isImplementation(Uri uri) {
+  List<String> segments = uri?.pathSegments ?? const [];
+  if (segments.length > 2) {
+    if (segments[1] == 'src') {
+      return true;
+    }
+  }
+  return false;
+}
+
+bool isPackage(Uri uri) => uri?.scheme == 'package';
+
+bool samePackage(Uri uri1, Uri uri2) {
+  var segments1 = uri1.pathSegments;
+  var segments2 = uri2.pathSegments;
+  if (segments1.length < 1 || segments2.length < 1) {
+    return false;
+  }
+  return segments1[0] == segments2[0];
+}
+
+class ImplementationImports extends LintRule {
+  ImplementationImports()
+      : super(
+            name: 'implementation_imports',
+            description: desc,
+            details: details,
+            group: Group.style);
+
+  @override
+  AstVisitor getVisitor() => new Visitor(this);
+}
+
+class Visitor extends SimpleAstVisitor {
+  final LintRule rule;
+  Visitor(this.rule);
+
+  @override
+  visitImportDirective(ImportDirective node) {
+    Uri importUri = node?.source?.uri;
+    Uri sourceUri = node?.element?.source?.uri;
+
+    // Test for 'package:*/src/'.
+    if (!isImplementation(importUri)) {
+      return;
+    }
+
+    // If the source URI is not a `package` URI bail out.
+    if (!isPackage(sourceUri)) {
+      return;
+    }
+
+    if (!samePackage(importUri, sourceUri)) {
+      rule.reportLint(node.uri);
+    }
+  }
+}

test/rule_test.dart

@@ -14,6 +14,7 @@ import 'package:linter/src/io.dart';
 import 'package:linter/src/linter.dart';
 import 'package:linter/src/rules.dart';
 import 'package:linter/src/rules/camel_case_types.dart';
+import 'package:linter/src/rules/implementation_imports.dart';
 import 'package:linter/src/rules/package_prefixed_library_names.dart';
 import 'package:linter/src/util.dart';
 import 'package:path/path.dart' as p;
@@ -55,6 +56,66 @@ defineRuleTests() {
 }
 
 defineRuleUnitTests() {
+  group('uris', () {
+    group('isPackage', () {
+      var uris = [
+        Uri.parse('package:foo/src/bar.dart'),
+        Uri.parse('package:foo/src/baz/bar.dart')
+      ];
+      uris.forEach((uri) {
+        test(uri.toString(), () {
+          expect(isPackage(uri), isTrue);
+        });
+      });
+      var uris2 = [
+        Uri.parse('foo/bar.dart'),
+        Uri.parse('src/bar.dart'),
+        Uri.parse('dart:async')
+      ];
+      uris2.forEach((uri) {
+        test(uri.toString(), () {
+          expect(isPackage(uri), isFalse);
+        });
+      });
+    });
+
+    group('samePackage', () {
+      test('identity', () {
+        expect(
+            samePackage(Uri.parse('package:foo/src/bar.dart'),
+                Uri.parse('package:foo/src/bar.dart')),
+            isTrue);
+      });
+      test('foo/bar.dart', () {
+        expect(
+            samePackage(Uri.parse('package:foo/src/bar.dart'),
+                Uri.parse('package:foo/bar.dart')),
+            isTrue);
+      });
+    });
+
+    group('implementation', () {
+      var uris = [
+        Uri.parse('package:foo/src/bar.dart'),
+        Uri.parse('package:foo/src/baz/bar.dart')
+      ];
+      uris.forEach((uri) {
+        test(uri.toString(), () {
+          expect(isImplementation(uri), isTrue);
+        });
+      });
+      var uris2 = [
+        Uri.parse('package:foo/bar.dart'),
+        Uri.parse('src/bar.dart')
+      ];
+      uris2.forEach((uri) {
+        test(uri.toString(), () {
+          expect(isImplementation(uri), isFalse);
+        });
+      });
+    });
+  });
+
   group('names', () {
     group('keywords', () {
       var good = ['class', 'if', 'assert', 'catch', 'import'];