Allow making the plugin from multiple platforms

tool/plugin/lib/build_spec.dart

@@ -1,8 +1,6 @@
 // Copyright 2017 The Chromium Authors. All rights reserved. Use of this source
 // code is governed by a BSD-style license that can be found in the LICENSE file.
 
-// @dart = 2.12
-
 import 'dart:async';
 import 'dart:io';
 

tool/plugin/lib/edit.dart

@@ -14,122 +14,102 @@ Set<EditCommand> appliedEditCommands = {};
 
 void checkAndClearAppliedEditCommands() {
   if (appliedEditCommands.length != editCommands.length) {
-    var commands = <EditCommand>{};
+    final commands = <EditCommand>{};
     commands.addAll(editCommands);
     commands.removeAll(appliedEditCommands);
     separator("UNUSED EditCommand");
-    for (var cmd in commands) {
+    for (final cmd in commands) {
       log(cmd.toString());
     }
   }
   appliedEditCommands.clear();
 }
 
+const String _actionThreadEditContent = '''
+
+  public @NotNull ActionUpdateThread getActionUpdateThread() {
+    return ActionUpdateThread.BGT;
+  }
+''';
+
 List<EditCommand> editCommands = [
   // When using LATEST-EAP-SNAPSHOT, also set baseVersion to LATEST-EAP-SNAPSHOT in the build spec.
-  Subst(
+  EditCommand(
     path: 'build.gradle.kts',
-    initial: 'version.set(ideVersion)',
-    replacement: 'version.set("LATEST-EAP-SNAPSHOT")',
-    version: '2023.1',
+    initials: ['version.set(ideVersion)'],
+    replacements: ['version.set("LATEST-EAP-SNAPSHOT")'],
+    versions: ['2023.1'],
   ),
-  Subst(
+  EditCommand(
     path: 'flutter-idea/build.gradle.kts',
-    initial: 'version.set(ideVersion)',
-    replacement: 'version.set("LATEST-EAP-SNAPSHOT")',
-    version: '2023.1',
+    initials: ['version.set(ideVersion)'],
+    replacements: ['version.set("LATEST-EAP-SNAPSHOT")'],
+    versions: ['2023.1'],
   ),
-  MultiSubst(
+  EditCommand(
     path:
         'flutter-studio/src/io/flutter/android/AndroidModuleLibraryManager.java',
     initials: ['//import ', 'extends ProjectImpl '],
     replacements: ['import ', 'extends ProjectExImpl '],
     versions: ['2022.1', '2022.2', '2031.1'],
   ),
-  Subst(
+  EditCommand(
     path: 'flutter-idea/src/io/flutter/vmService/frame/DartVmServiceValue.java',
-    initial: '@NotNull',
-    replacement: '',
+    initials: ['@NotNull'],
+    replacements: [''],
     versions: ['2022.1', '2022.2'],
   ),
-  Subst(
+  EditCommand(
     path:
         'flutter-idea/src/io/flutter/analytics/FlutterAnalysisServerListener.java',
-    initial: '@NotNull',
-    replacement: '',
+    initials: ['@NotNull'],
+    replacements: [''],
     versions: ['2022.1', '2022.2'],
   ),
-  Subst(
+  EditCommand(
     path: 'resources/META-INF/plugin_template.xml',
-    initial: '<add-to-group group-id="MainToolbarRight" />',
-    replacement: '',
+    initials: ['<add-to-group group-id="MainToolbarRight" />'],
+    replacements: [''],
     versions: ['2022.1', '2022.2'],
   ),
-  Subst(
+  EditCommand(
     path: 'flutter-idea/src/io/flutter/actions/AttachDebuggerAction.java',
-    initial: '''
-  public @NotNull ActionUpdateThread getActionUpdateThread() {
-    return ActionUpdateThread.BGT;
-  }
-''',
-    replacement: '',
-    version: '2022.1',
+    initials: [_actionThreadEditContent],
+    replacements: [''],
+    versions: ['2022.1'],
   ),
-  Subst(
+  EditCommand(
     path: 'flutter-idea/src/io/flutter/actions/DeviceSelectorAction.java',
-    initial: '''
-  public @NotNull ActionUpdateThread getActionUpdateThread() {
-    return ActionUpdateThread.BGT;
-  }
-''',
-    replacement: '',
-    version: '2022.1',
+    initials: [_actionThreadEditContent],
+    replacements: [''],
+    versions: ['2022.1'],
   ),
-  Subst(
+  EditCommand(
     path:
-    'flutter-idea/src/io/flutter/actions/DeviceSelectorRefresherAction.java',
-    initial: '''
-  public @NotNull ActionUpdateThread getActionUpdateThread() {
-    return ActionUpdateThread.BGT;
-  }
-''',
-    replacement: '',
-    version: '2022.1',
+        'flutter-idea/src/io/flutter/actions/DeviceSelectorRefresherAction.java',
+    initials: [_actionThreadEditContent],
+    replacements: [''],
+    versions: ['2022.1'],
   ),
-  Subst(
+  EditCommand(
     path: 'flutter-idea/src/io/flutter/actions/FlutterRetargetAppAction.java',
-    initial: '''
-  public @NotNull ActionUpdateThread getActionUpdateThread() {
-    return ActionUpdateThread.BGT;
-  }
-''',
-    replacement: '',
-    version: '2022.1',
+    initials: [_actionThreadEditContent],
+    replacements: [''],
+    versions: ['2022.1'],
   ),
 ];
 
-// Used to test checkAndClearAppliedEditCommands()
-class Unused extends EditCommand {
-  @override
-  String get path => 'unused';
-
-  @override
-  String? convert(BuildSpec spec) {
-    return null;
-  }
-}
-
 /// Apply all the editCommands applicable to a given BuildSpec.
 Future<int> applyEdits(BuildSpec spec, Function compileFn) async {
   // Handle skipped files.
   for (String file in spec.filesToSkip) {
-    var entity =
+    final entity =
         FileSystemEntity.isFileSync(file) ? File(file) : Directory(file);
     if (entity.existsSync()) {
       await entity.rename('$file~');
       log('renamed $file');
       if (entity is File) {
-        var stubFile = File('${file}_stub');
+        final stubFile = File('${file}_stub');
         if (stubFile.existsSync()) {
           await stubFile.copy(file);
           log('copied ${file}_stub');
@@ -138,10 +118,10 @@ Future<int> applyEdits(BuildSpec spec, Function compileFn) async {
     }
   }
 
-  var edited = <EditCommand, String>{};
+  final edited = <EditCommand, String>{};
   try {
-    for (var edit in editCommands) {
-      var source = edit.convert(spec);
+    for (final edit in editCommands) {
+      final source = edit.convert(spec);
       if (source != null) {
         edited[edit] = source;
         appliedEditCommands.add(edit);
@@ -157,9 +137,9 @@ Future<int> applyEdits(BuildSpec spec, Function compileFn) async {
     });
 
     // Restore skipped files.
-    for (var file in spec.filesToSkip) {
-      var name = '$file~';
-      var entity =
+    for (final file in spec.filesToSkip) {
+      final name = '$file~';
+      final entity =
           FileSystemEntity.isFileSync(name) ? File(name) : Directory(name);
       if (entity.existsSync()) {
         await entity.rename(file);
@@ -169,101 +149,61 @@ Future<int> applyEdits(BuildSpec spec, Function compileFn) async {
 }
 
 /// Make some changes to a source file prior to compiling for a specific IDE.
-abstract class EditCommand {
-  String? convert(BuildSpec spec);
-
-  void restore(String source) {
-    var processedFile = File(path);
-    processedFile.writeAsStringSync(source);
-  }
+class EditCommand {
+  EditCommand({
+    required this.path,
+    required List<String> initials,
+    required List<String> replacements,
+    this.versions = const [],
+  })  : assert(initials.length == replacements.length),
+        assert(initials.isNotEmpty),
+        assert(versions.isNotEmpty),
+        initials = initials.map(_platformAdaptiveString).toList(),
+        replacements = replacements.map(_platformAdaptiveString).toList();
 
-  String get path;
-}
+  /// The target file path.
+  final String path;
 
-/// Single substitution in a file for one or more IDE versions.
-class Subst extends EditCommand {
-  @override
-  String path;
-  String initial;
-  String replacement;
+  final List<String> initials;
+  final List<String> replacements;
 
   /// The list of platform versions to perform the substitution for.
-  List<String> versions;
-
-  Subst(
-      {this.versions = const [''],
-      required this.initial,
-      required this.replacement,
-      required this.path,
-      String? version}) {
-    if (version != null) {
-      // Disallow both version and versions keywords.
-      versions = [version];
-    }
-  }
+  final List<String> versions;
 
-  @override
   String? convert(BuildSpec spec) {
     if (versionMatches(spec)) {
-      var processedFile = File(path);
-      var source = processedFile.readAsStringSync();
-      var original = source;
-      source = source.replaceAll(initial, replacement);
+      final processedFile = File(path);
+      String source = processedFile.readAsStringSync();
+      final original = source;
+      for (int i = 0; i < initials.length; i++) {
+        source = source.replaceAll(initials[i], replacements[i]);
+      }
       processedFile.writeAsStringSync(source);
-      log('edited $path');
       return original;
     } else {
       return null;
     }
   }
 
-  @override
-  String toString() => "Subst(path: $path, versions: $versions)";
-
   bool versionMatches(BuildSpec spec) {
     return versions.any((v) => spec.version.startsWith(v));
   }
-}
-
-// TODO Unify Subst and MultiSubst, and find a better name.
-class MultiSubst extends EditCommand {
-  @override
-  String path;
-  List<String> initials;
-  List<String> replacements;
-  List<String> versions;
-
-  MultiSubst({
-    required this.versions,
-    required this.initials,
-    required this.replacements,
-    required this.path,
-  }) {
-    assert(initials.length == replacements.length);
-    assert(versions.isNotEmpty);
-    assert(initials.isNotEmpty);
-  }
 
-  @override
-  String? convert(BuildSpec spec) {
-    if (versionMatches(spec)) {
-      var processedFile = File(path);
-      var source = processedFile.readAsStringSync();
-      var original = source;
-      for (var i = 0; i < initials.length; i++) {
-        source = source.replaceAll(initials[i], replacements[i]);
-      }
-      processedFile.writeAsStringSync(source);
-      return original;
-    } else {
-      return null;
-    }
+  void restore(String source) {
+    final processedFile = File(path);
+    processedFile.writeAsStringSync(source);
   }
 
   @override
-  String toString() => "Subst(path: $path, versions: $versions)";
+  String toString() => "EditCommand(path: $path, versions: $versions)";
+}
 
-  bool versionMatches(BuildSpec spec) {
-    return versions.any((v) => spec.version.startsWith(v));
+String _platformAdaptiveString(String value) {
+  if (value.isEmpty) {
+    return value;
+  } else if (Platform.isWindows) {
+    return value.replaceAll('\n', '\r\n');
+  } else {
+    return value.replaceAll('\r\n', '\n');
   }
 }