Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

remove DartProject references #3397

Merged
merged 1 commit into from
May 13, 2022
Merged

remove DartProject references #3397

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
78 changes: 37 additions & 41 deletions lib/src/rules/directives_ordering.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,7 @@ bool _isPartDirective(Directive node) => node is PartDirective;
bool _isRelativeDirective(NamespaceDirective node) =>
!_isAbsoluteDirective(node);

class DirectivesOrdering extends LintRule
implements ProjectVisitor, NodeLintRule {
class DirectivesOrdering extends LintRule {
static const LintCode dartDirectiveGoFirst =
LintCode('directives_ordering', "Place 'dart:' {0}s before other {0}s.");

Expand All @@ -164,30 +163,20 @@ class DirectivesOrdering extends LintRule
static const LintCode packageDirectiveBeforeRelative = LintCode(
'directives_ordering', "Place 'package:' {0}s before relative {0}s.");

DartProject? project;

DirectivesOrdering()
: super(
name: 'directives_ordering',
description: _desc,
details: _details,
group: Group.style);

@override
ProjectVisitor getProjectVisitor() => this;

@override
void registerNodeProcessors(
NodeLintRegistry registry, LinterContext context) {
var visitor = _Visitor(this);
registry.addCompilationUnit(this, visitor);
}

@override
void visit(DartProject project) {
this.project = project;
}

void _reportLintWithDartDirectiveGoFirstMessage(AstNode node, String type) {
reportLint(node,
errorCode: DirectivesOrdering.dartDirectiveGoFirst, arguments: [type]);
Expand All @@ -212,11 +201,13 @@ class DirectivesOrdering extends LintRule
}
}

// ignore: unused_element
class _PackageBox {
final String _packageName;

_PackageBox(this._packageName);

// ignore: unused_element
bool _isNotOwnPackageDirective(NamespaceDirective node) =>
_isPackageDirective(node) && !_isOwnPackageDirective(node);

Expand All @@ -232,8 +223,6 @@ class _Visitor extends SimpleAstVisitor<void> {

_Visitor(this.rule);

DartProject? get project => rule.project;

@override
void visitCompilationUnit(CompilationUnit node) {
var lintedNodes = <AstNode>{};
Expand Down Expand Up @@ -285,33 +274,40 @@ class _Visitor extends SimpleAstVisitor<void> {
_checkSectionInOrder(lintedNodes, relativeImports);
_checkSectionInOrder(lintedNodes, relativeExports);

var projectName = project?.name;
if (projectName == null) {
// Not a pub package. Package directives should be sorted in one block.
var packageImports = importDirectives.where(_isPackageDirective);
var packageExports = exportDirectives.where(_isPackageDirective);

_checkSectionInOrder(lintedNodes, packageImports);
_checkSectionInOrder(lintedNodes, packageExports);
} else {
var packageBox = _PackageBox(projectName);

var thirdPartyPackageImports =
importDirectives.where(packageBox._isNotOwnPackageDirective);
var thirdPartyPackageExports =
exportDirectives.where(packageBox._isNotOwnPackageDirective);

var ownPackageImports =
importDirectives.where(packageBox._isOwnPackageDirective);
var ownPackageExports =
exportDirectives.where(packageBox._isOwnPackageDirective);

_checkSectionInOrder(lintedNodes, thirdPartyPackageImports);
_checkSectionInOrder(lintedNodes, thirdPartyPackageExports);

_checkSectionInOrder(lintedNodes, ownPackageImports);
_checkSectionInOrder(lintedNodes, ownPackageExports);
}
// See: https://github.com/dart-lang/linter/issues/3395
// (`DartProject` removal)
// The rub is that *all* projects are being treated as "not pub"
// packages. We'll want to be careful when fixing this since it
// will have ecosystem impact.

// Not a pub package. Package directives should be sorted in one block.
var packageImports = importDirectives.where(_isPackageDirective);
var packageExports = exportDirectives.where(_isPackageDirective);

_checkSectionInOrder(lintedNodes, packageImports);
_checkSectionInOrder(lintedNodes, packageExports);

// The following is relying on projectName which is meant to come from
// a `DartProject` instance (but was not since the project was always null)
// else {
// var packageBox = _PackageBox(projectName);
//
// var thirdPartyPackageImports =
// importDirectives.where(packageBox._isNotOwnPackageDirective);
// var thirdPartyPackageExports =
// exportDirectives.where(packageBox._isNotOwnPackageDirective);
//
// var ownPackageImports =
// importDirectives.where(packageBox._isOwnPackageDirective);
// var ownPackageExports =
// exportDirectives.where(packageBox._isOwnPackageDirective);
//
// _checkSectionInOrder(lintedNodes, thirdPartyPackageImports);
// _checkSectionInOrder(lintedNodes, thirdPartyPackageExports);
//
// _checkSectionInOrder(lintedNodes, ownPackageImports);
// _checkSectionInOrder(lintedNodes, ownPackageExports);
// }
}

void _checkExportDirectiveAfterImportDirective(
Expand Down