Update Dart formatter message (#937)

Author: mit-mit

CONTRIBUTING.md

@@ -38,6 +38,9 @@ new tests, use the existing tests as a guideline for what they should look like.
 Before you send your pull request, make sure all the tests pass! Just run 
 `dart test`.
 
+When updating UI messages, the golden test files in `test/goldens` -- which
+contain the expected UI output -- need to be updated. To do that, simply delete the outdated golden test file, and it will be regenerated when `dart test` is run.
+
 ### File headers
 
 All files in the project must start with the following header.

lib/src/messages.dart

@@ -2,31 +2,9 @@
 // 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.
 
-class _MsgDict {
-  final String dartanalyzerShortName;
-  final String dartanalyzerShortCmd;
-  final String dartfmtShortName;
-  final String dartfmtShortCmd;
-
-  _MsgDict._({
-    this.dartanalyzerShortName = 'dart analyze',
-    this.dartanalyzerShortCmd = 'dart analyze .',
-    this.dartfmtShortName = 'dartfmt',
-    this.dartfmtShortCmd = 'dartfmt -n .',
-  });
-
-  static _MsgDict defaultDict = _MsgDict._();
-
-  static _MsgDict flutterDict = _MsgDict._(
-    dartanalyzerShortName: 'flutter analyze',
-    dartanalyzerShortCmd: 'flutter analyze',
-    dartfmtShortName: 'flutter format',
-    dartfmtShortCmd: 'flutter format',
-  );
-}
-
 String runningDartanalyzerFailed(bool usesFlutter, errorMsg) {
-  final dict = usesFlutter ? _MsgDict.flutterDict : _MsgDict.defaultDict;
-  return 'Running `${dict.dartanalyzerShortCmd}` failed with the following output:\n\n'
+  final message = usesFlutter ? 'flutter analyze' : 'dart analyze .';
+
+  return 'Running `$message` failed with the following output:\n\n'
       '```\n$errorMsg\n```\n';
 }

lib/src/report/static_analysis.dart

@@ -14,7 +14,6 @@ import '../model.dart';
 import '../package_context.dart';
 import '../sdk_env.dart';
 import '../utils.dart';
-
 import '_common.dart';
 
 Future<ReportSection> staticAnalysis(PackageContext context) async {
@@ -153,8 +152,12 @@ Future<List<Issue>> _formatPackage(
       lineLength: lineLength,
     );
     return unformattedFiles
-        .map((f) => Issue('$f is not formatted according to dartfmt',
-            suggestion: 'To format your files run: `dartfmt -w .`'))
+        .map((f) => Issue(
+              '$f doesn\'t match the Dart formatter.',
+              suggestion: usesFlutter
+                  ? 'To format your files run: `flutter format .`'
+                  : 'To format your files run: `dart format .`',
+            ))
         .toList();
   } on ToolException catch (e) {
     return [

test/goldens/end2end/sdp_transform-0.2.0.json

@@ -76,7 +76,7 @@
         "grantedPoints": 20,
         "maxPoints": 30,
         "status": "partial",
-        "summary": "### [~] 20/30 points: code has no errors, warnings, lints, or formatting issues\n\n<details>\n<summary>\nlib/src/grammar.dart is not formatted according to dartfmt\n</summary>\n\nTo format your files run: `dartfmt -w .`\n</details>\n<details>\n<summary>\nlib/src/parser.dart is not formatted according to dartfmt\n</summary>\n\nTo format your files run: `dartfmt -w .`\n</details>"
+        "summary": "### [~] 20/30 points: code has no errors, warnings, lints, or formatting issues\n\n<details>\n<summary>\nlib/src/grammar.dart doesn't match the Dart formatter.\n</summary>\n\nTo format your files run: `dart format .`\n</details>\n<details>\n<summary>\nlib/src/parser.dart doesn't match the Dart formatter.\n</summary>\n\nTo format your files run: `dart format .`\n</details>"
       },
       {
         "id": "dependency",

test/goldens/end2end/sdp_transform-0.2.0.json_report.md

@@ -39,17 +39,17 @@ See [package layout](https://dart.dev/tools/pub/package-layout#examples) guideli
 
 <details>
 <summary>
-lib/src/grammar.dart is not formatted according to dartfmt
+lib/src/grammar.dart doesn't match the Dart formatter.
 </summary>
 
-To format your files run: `dartfmt -w .`
+To format your files run: `dart format .`
 </details>
 <details>
 <summary>
-lib/src/parser.dart is not formatted according to dartfmt
+lib/src/parser.dart doesn't match the Dart formatter.
 </summary>
 
-To format your files run: `dartfmt -w .`
+To format your files run: `dart format .`
 </details>
 
 ## 10/20 Support up-to-date dependencies

test/goldens/end2end/skiplist-0.1.0.json

@@ -57,7 +57,7 @@
         "grantedPoints": 20,
         "maxPoints": 30,
         "status": "partial",
-        "summary": "### [~] 20/30 points: code has no errors, warnings, lints, or formatting issues\n\n<details>\n<summary>\nlib/skiplist.dart is not formatted according to dartfmt\n</summary>\n\nTo format your files run: `dartfmt -w .`\n</details>"
+        "summary": "### [~] 20/30 points: code has no errors, warnings, lints, or formatting issues\n\n<details>\n<summary>\nlib/skiplist.dart doesn't match the Dart formatter.\n</summary>\n\nTo format your files run: `dart format .`\n</details>"
       },
       {
         "id": "dependency",

test/goldens/end2end/skiplist-0.1.0.json_report.md

@@ -47,10 +47,10 @@ Run `dart pub get` for more information.
 
 <details>
 <summary>
-lib/skiplist.dart is not formatted according to dartfmt
+lib/skiplist.dart doesn't match the Dart formatter.
 </summary>
 
-To format your files run: `dartfmt -w .`
+To format your files run: `dart format .`
 </details>
 
 ## 0/20 Support up-to-date dependencies