feat: replace relative path in reporters output with absolute to support IDE clicks (#966)

* feat: replace relative path in reporters output with absolute to support IDE clicks

* test: update test

* test: update test

Author: incendial

CHANGELOG.md

@@ -14,6 +14,7 @@
 
 * chore: restrict `analyzer` version to `>=4.1.0 <4.5.0`.
 * chore: restrict `analyzer_plugin` version to `>=0.11.0 <0.12.0`.
+* feat: replace relative path in reporters output with absolute to support IDE clicks.
 
 ## 4.17.1
 

lib/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter.dart

@@ -36,7 +36,7 @@ class LintConsoleReporter extends ConsoleReporter<LintFileReport,
         ..._reportMetrics('', file.file),
         ..._reportIssues(
           [...file.issues, ...file.antiPatternCases],
-          file.relativePath,
+          file.path,
         ),
         ..._reportEntityMetrics({...file.classes, ...file.functions}),
       ];
@@ -57,11 +57,11 @@ class LintConsoleReporter extends ConsoleReporter<LintFileReport,
     }
   }
 
-  Iterable<String> _reportIssues(Iterable<Issue> issues, String relativePath) =>
+  Iterable<String> _reportIssues(Iterable<Issue> issues, String absolutePath) =>
       (issues.toList()
             ..sort((a, b) =>
                 a.location.start.offset.compareTo(b.location.start.offset)))
-          .map((issue) => _helper.getIssueMessage(issue, relativePath))
+          .map((issue) => _helper.getIssueMessage(issue, absolutePath))
           .expand((lines) => lines);
 
   Iterable<String> _reportEntityMetrics(Map<String, Report> reports) =>

lib/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter_helper.dart

@@ -30,17 +30,17 @@ class LintConsoleReporterHelper {
   };
 
   /// Converts an [issue] to the issue message string.
-  Iterable<String> getIssueMessage(Issue issue, String relativePath) {
+  Iterable<String> getIssueMessage(Issue issue, String absolutePath) {
     final severity = _getSeverity(issue.severity);
     final locationStart = issue.location.start;
     final location = _linkPen(
-      '$relativePath:${locationStart.line}:${locationStart.column}',
+      '$absolutePath:${locationStart.line}:${locationStart.column}',
     );
     final tabulation = _normalize('');
 
     return [
       '$severity${issue.message}',
-      '$tabulation$location',
+      '${tabulation}at $location',
       '$tabulation${issue.ruleId} : ${issue.documentation}',
       '',
     ];

lib/src/analyzers/unnecessary_nullable_analyzer/reporters/reporters_list/console/unnecessary_nullable_console_reporter.dart

@@ -37,7 +37,7 @@ class UnnecessaryNullableConsoleReporter extends ConsoleReporter<
       for (final issue in analysisRecord.issues) {
         final line = issue.location.line;
         final column = issue.location.column;
-        final path = analysisRecord.relativePath;
+        final path = analysisRecord.path;
 
         final offset = ''.padRight(3);
         final pathOffset = offset.padRight(5);

lib/src/analyzers/unused_code_analyzer/reporters/reporters_list/console/unused_code_console_reporter.dart

@@ -36,7 +36,7 @@ class UnusedCodeConsoleReporter extends ConsoleReporter<UnusedCodeFileReport,
       for (final issue in analysisRecord.issues) {
         final line = issue.location.line;
         final column = issue.location.column;
-        final path = analysisRecord.relativePath;
+        final path = analysisRecord.path;
 
         final offset = ''.padRight(3);
         final pathOffset = offset.padRight(5);

lib/src/analyzers/unused_files_analyzer/reporters/reporters_list/console/unused_files_console_reporter.dart

@@ -30,7 +30,7 @@ class UnusedFilesConsoleReporter extends ConsoleReporter<UnusedFilesFileReport,
 
     for (final analysisRecord in sortedRecords) {
       output.writeln(
-        '${warningPen('⚠')} unused file: ${analysisRecord.relativePath}',
+        '${warningPen('⚠')} unused file: ${analysisRecord.path}',
       );
     }
 

lib/src/analyzers/unused_l10n_analyzer/reporters/reporters_list/console/unused_l10n_console_reporter.dart

@@ -36,7 +36,7 @@ class UnusedL10nConsoleReporter extends ConsoleReporter<UnusedL10nFileReport,
       for (final issue in analysisRecord.issues) {
         final line = issue.location.line;
         final column = issue.location.column;
-        final path = analysisRecord.relativePath;
+        final path = analysisRecord.path;
 
         final offset = ''.padRight(3);
         final pathOffset = offset.padRight(5);

test/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter_helper_test.dart

@@ -39,7 +39,7 @@ void main() {
         ),
         equals([
           '\x1B[38;5;180mWARNING \x1B[0mIssue message',
-          '        \x1B[38;5;39mlib/src/my_source.dart:1:2\x1B[0m',
+          '        at \x1B[38;5;39mlib/src/my_source.dart:1:2\x1B[0m',
           '        rule : https://dartcodemetrics/rules/rule',
           '',
         ]),
@@ -59,7 +59,7 @@ void main() {
         ),
         equals([
           '\x1B[38;5;7m        \x1B[0mIssue message',
-          '        \x1B[38;5;39mlib/src/my_source.dart:1:2\x1B[0m',
+          '        at \x1B[38;5;39mlib/src/my_source.dart:1:2\x1B[0m',
           '        rule : https://dartcodemetrics/rules/rule',
           '',
         ]),

test/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter_test.dart

@@ -81,11 +81,11 @@ void main() {
             '',
             'test/resources/class_with_factory_constructors.dart:',
             '\x1B[38;5;180mWARNING \x1B[0msimple message',
-            '        \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
+            '        at \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
             '        id : https://documentation.com',
             '',
             '\x1B[38;5;20mSTYLE   \x1B[0msimple design message',
-            '        \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
+            '        at \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
             '        designId : https://documentation.com',
             '',
             '\x1B[38;5;180mWARNING \x1B[0mfunction',
@@ -118,11 +118,11 @@ void main() {
             '        metric2: \x1B[38;5;7m1\x1B[0m',
             '',
             '\x1B[38;5;180mWARNING \x1B[0msimple message',
-            '        \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
+            '        at \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
             '        id : https://documentation.com',
             '',
             '\x1B[38;5;20mSTYLE   \x1B[0msimple design message',
-            '        \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
+            '        at \x1B[38;5;39mtest/resources/class_with_factory_constructors.dart:0:0\x1B[0m',
             '        designId : https://documentation.com',
             '',
             '\x1B[38;5;180mWARNING \x1B[0mfunction',

test/src/analyzers/unused_code_analyzer/reporters/reporters_list/console/unused_code_console_reporter_test.dart

@@ -72,7 +72,7 @@ void main() {
         equals([
           'example.dart:',
           '    \x1B[38;5;180m⚠\x1B[0m unused class SomeClass',
-          '      at example.dart:5:3',
+          '      at $fullPath:5:3',
           '',
           '\x1B[38;5;167m✖\x1B[0m total unused code (classes, functions, variables, extensions, enums, mixins and type aliases) - \x1B[38;5;167m1\x1B[0m',
         ]),