[CFE] Add interactive mode to spell checker

Change-Id: Ieec964b99d1c19c58e100b64f68e091178261172
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/132644
Commit-Queue: Jens Johansen <jensj@google.com>
Reviewed-by: Johnni Winther <johnniwinther@google.com>

Author: jensjoha

pkg/front_end/test/spell_checking_list_blacklist.txt

@@ -6,6 +6,9 @@
 # Comments can also be inline like 'correct # this is ok'.
 # Note that at least one space before the hash is required.
 
+# Comments on a line by itself will be considered a header of the file and
+# automatic tools might move it to the top of the file.
+
 alread
 chnage
 clonable

pkg/front_end/test/spell_checking_list_code.txt

@@ -6,6 +6,9 @@
 # Comments can also be inline like 'correct # this is ok'.
 # Note that at least one space before the hash is required.
 
+# Comments on a line by itself will be considered a header of the file and
+# automatic tools might move it to the top of the file.
+
 a+b
 abbreviate
 abcdef
@@ -503,7 +506,6 @@ json
 juxtaposition
 juxtapositions
 k
-k’s
 kallentu
 kernel
 kernel's
@@ -512,6 +514,7 @@ klass
 kmillikin
 kustermann
 kv
+k’s
 l
 lacks
 lang
@@ -564,6 +567,8 @@ md
 me
 merely
 meta
+method10a
+method10b
 method1a
 method1b
 method2a
@@ -586,8 +591,6 @@ method8a
 method8b
 method9a
 method9b
-method10a
-method10b
 mi
 migration
 mime
@@ -743,13 +746,13 @@ quick
 quiver
 quoted
 r
+r'$creation
 r'\f
 r'\r
 r'\s
 r'\t
 r'\u
 r'\v
-r'$creation
 r0i
 r1i
 r2i

pkg/front_end/test/spell_checking_list_common.txt

@@ -6,6 +6,9 @@
 # Comments can also be inline like 'correct # this is ok'.
 # Note that at least one space before the hash is required.
 
+# Comments on a line by itself will be considered a header of the file and
+# automatic tools might move it to the top of the file.
+
 a
 abbreviations
 ability

pkg/front_end/test/spell_checking_list_messages.txt

@@ -6,6 +6,9 @@
 # Comments can also be inline like 'correct # this is ok'.
 # Note that at least one space before the hash is required.
 
+# Comments on a line by itself will be considered a header of the file and
+# automatic tools might move it to the top of the file.
+
 argument(s)
 b
 c

pkg/front_end/test/spell_checking_list_tests.txt

@@ -6,6 +6,9 @@
 # Comments can also be inline like 'correct # this is ok'.
 # Note that at least one space before the hash is required.
 
+# Comments on a line by itself will be considered a header of the file and
+# automatic tools might move it to the top of the file.
+
 a0x
 a1x
 a2x
@@ -111,6 +114,7 @@ dictionary
 differs
 dillfile
 dills
+dinteractive
 dirname
 disagree
 disallowed
@@ -201,6 +205,7 @@ increments
 inspect
 insufficient
 intact
+interactive
 internet
 interpolate
 inv

pkg/front_end/test/spelling_test_base.dart

@@ -4,20 +4,20 @@
 
 import 'dart:async' show Future;
 
-import 'dart:io' show File;
+import 'dart:io' show File, Platform, stdin, stdout;
 
 import 'dart:typed_data' show Uint8List;
 
 import 'package:_fe_analyzer_shared/src/scanner/scanner.dart' show ErrorToken;
 
-import 'package:_fe_analyzer_shared/src/scanner/utf8_bytes_scanner.dart'
-    show Utf8BytesScanner;
-
 import 'package:_fe_analyzer_shared/src/scanner/token.dart'
     show Token, KeywordToken, BeginToken;
 
 import 'package:_fe_analyzer_shared/src/scanner/token.dart';
 
+import 'package:_fe_analyzer_shared/src/scanner/utf8_bytes_scanner.dart'
+    show Utf8BytesScanner;
+
 import 'package:front_end/src/fasta/command_line_reporting.dart'
     as command_line_reporting;
 
@@ -33,6 +33,10 @@ abstract class SpellContext extends ChainContext {
     const SpellTest(),
   ];
 
+  final bool interactive;
+
+  SpellContext({this.interactive});
+
   // Override special handling of negative tests.
   @override
   Result processTestResult(
@@ -64,15 +68,91 @@ abstract class SpellContext extends ChainContext {
       print("================");
       print("The following word(s) were reported as unknown:");
       print("----------------");
-      for (String s in reportedWords) {
-        print("$s");
-      }
-      if (dictionaries.isNotEmpty) {
-        print("----------------");
-        print("If the word(s) are correctly spelled please add it to one of "
-            "these files:");
+
+      spell.Dictionaries dictionaryToUse;
+      if (dictionaries.contains(spell.Dictionaries.cfeTests)) {
+        dictionaryToUse = spell.Dictionaries.cfeTests;
+      } else if (dictionaries.contains(spell.Dictionaries.cfeMessages)) {
+        dictionaryToUse = spell.Dictionaries.cfeMessages;
+      } else if (dictionaries.contains(spell.Dictionaries.cfeCode)) {
+        dictionaryToUse = spell.Dictionaries.cfeCode;
+      } else {
         for (spell.Dictionaries dictionary in dictionaries) {
-          print(" - ${spell.dictionaryToUri(dictionary)}");
+          if (dictionaryToUse == null ||
+              dictionary.index < dictionaryToUse.index) {
+            dictionaryToUse = dictionary;
+          }
+        }
+      }
+
+      if (interactive && dictionaryToUse != null) {
+        List<String> addedWords = new List<String>();
+        for (String s in reportedWords) {
+          print("- $s");
+          stdout.write("Do you want to add the word to the dictionary "
+              "$dictionaryToUse (y/n)? ");
+          String answer = stdin.readLineSync().trim().toLowerCase();
+          bool add;
+          switch (answer) {
+            case "y":
+            case "yes":
+            case "true":
+              add = true;
+              break;
+            case "n":
+            case "no":
+            case "false":
+              add = false;
+              break;
+            default:
+              throw "Didn't understand '$answer'";
+          }
+          if (add) {
+            addedWords.add(s);
+          }
+        }
+        if (addedWords.isNotEmpty) {
+          File dictionaryFile =
+              new File.fromUri(spell.dictionaryToUri(dictionaryToUse));
+          List<String> lines = dictionaryFile.readAsLinesSync();
+          List<String> header = new List<String>();
+          List<String> sortThis = new List<String>();
+          for (String line in lines) {
+            if (line.startsWith("#")) {
+              header.add(line);
+            } else if (line.trim().isEmpty && sortThis.isEmpty) {
+              header.add(line);
+            } else if (line.trim().isNotEmpty) {
+              sortThis.add(line);
+            }
+          }
+          sortThis.addAll(addedWords);
+          sortThis.sort();
+          lines = new List<String>();
+          lines.addAll(header);
+          if (header.isEmpty || header.last.isNotEmpty) {
+            lines.add("");
+          }
+          lines.addAll(sortThis);
+          lines.add("");
+          dictionaryFile.writeAsStringSync(lines.join("\n"));
+        }
+      } else {
+        for (String s in reportedWords) {
+          print("$s");
+        }
+        if (dictionaries.isNotEmpty) {
+          print("----------------");
+          print("If the word(s) are correctly spelled please add it to one of "
+              "these files:");
+          for (spell.Dictionaries dictionary in dictionaries) {
+            print(" - ${spell.dictionaryToUri(dictionary)}");
+          }
+
+          print("");
+          print("To add words easily, try to run this script in interactive "
+              "mode via the command");
+          print("dart ${Platform.script.toFilePath()} -Dinteractive=true");
         }
       }
       print("================");

pkg/front_end/test/spelling_test_external_targets.dart

@@ -18,10 +18,13 @@ main([List<String> arguments = const []]) =>
 
 Future<SpellContext> createContext(
     Chain suite, Map<String, String> environment) async {
-  return new SpellContextExternal();
+  bool interactive = environment["interactive"] == "true";
+  return new SpellContextExternal(interactive: interactive);
 }
 
 class SpellContextExternal extends SpellContext {
+  SpellContextExternal({bool interactive}) : super(interactive: interactive);
+
   @override
   List<spell.Dictionaries> get dictionaries => const <spell.Dictionaries>[];
 

pkg/front_end/test/spelling_test_not_src_suite.dart

@@ -15,10 +15,13 @@ main([List<String> arguments = const []]) =>
 
 Future<SpellContext> createContext(
     Chain suite, Map<String, String> environment) async {
-  return new SpellContextTest();
+  bool interactive = environment["interactive"] == "true";
+  return new SpellContextTest(interactive: interactive);
 }
 
 class SpellContextTest extends SpellContext {
+  SpellContextTest({bool interactive}) : super(interactive: interactive);
+
   @override
   List<spell.Dictionaries> get dictionaries => const <spell.Dictionaries>[
         spell.Dictionaries.common,

pkg/front_end/test/spelling_test_src_suite.dart

@@ -15,10 +15,13 @@ main([List<String> arguments = const []]) =>
 
 Future<SpellContext> createContext(
     Chain suite, Map<String, String> environment) async {
-  return new SpellContextSource();
+  bool interactive = environment["interactive"] == "true";
+  return new SpellContextSource(interactive: interactive);
 }
 
 class SpellContextSource extends SpellContext {
+  SpellContextSource({bool interactive}) : super(interactive: interactive);
+
   @override
   List<spell.Dictionaries> get dictionaries => const <spell.Dictionaries>[
         spell.Dictionaries.common,