Add a flutter pub add action (flutter#7924)

Opening in case we are interesting in actually upstreaming this - I
mostly just did it to get familiar with how actions are set up and
plumbed through.

Using the action opens a dialog like this:

<img width="413" alt="Screenshot 2025-02-04 at 1 16 26 PM"
src="https://github.com/user-attachments/assets/62e642a1-0a5c-48bd-9350-2d8768a66b75"
/>

It does do some validation that a non-empty package name was input, but
that is it today:

<img width="413" alt="Screenshot 2025-02-04 at 1 16 59 PM"
src="https://github.com/user-attachments/assets/ba062554-6b3a-4074-aead-2d3f4e3ed101"
/>

And it does ensure you actually clicked "OK" before actually running any
commands.

Author: jakemac53

flutter-idea/src/io/flutter/actions/FlutterPackagesAddAction.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 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.
+ */
+package io.flutter.actions;
+
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.project.Project;
+import io.flutter.FlutterMessages;
+import io.flutter.pub.PubRoot;
+import io.flutter.sdk.FlutterSdk;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class FlutterPackagesAddAction extends FlutterSdkAction {
+  @Override
+  public void startCommand(@NotNull Project project, @NotNull FlutterSdk sdk, @Nullable PubRoot root, @NotNull DataContext context) {
+    if (root == null) {
+      FlutterMessages.showError(
+        "Cannot Find Pub Root",
+        "Flutter pub add can only be run within a directory with a pubspec.yaml file",
+        project);
+      return;
+    }
+    PackageDialogWrapper dialog  = new PackageDialogWrapper();
+    if (dialog.showAndGet()) {
+      sdk.startPubAdd(root, project, dialog.getPackageName(), dialog.getDevOnly());
+    }
+  }
+}
+

flutter-idea/src/io/flutter/actions/PackageDialogWrapper.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright 2025 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.
+ */
+package io.flutter.actions;
+
+import com.intellij.openapi.ui.DialogWrapper;
+import com.intellij.openapi.ui.ValidationInfo;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.swing.*;
+import java.awt.*;
+
+public class PackageDialogWrapper extends DialogWrapper {
+
+  @NotNull
+  private JTextField packageInput = new JTextField("", 16);
+
+  @NotNull
+  private JCheckBox devOnlyCheckBox = new JCheckBox();
+
+  public PackageDialogWrapper() {
+    super(true); // use current window as parent
+    setTitle("Add Package");
+    init();
+  }
+
+  @Nullable
+  @Override
+  protected JComponent createCenterPanel() {
+    JPanel dialogPanel = new JPanel();
+
+    JLabel packageNameLabel = new JLabel("Package name:");
+    dialogPanel.add(packageNameLabel, BorderLayout.LINE_START);
+    dialogPanel.add(packageInput, BorderLayout.CENTER);
+
+    dialogPanel.add(new JSeparator());
+
+    JLabel devOnlyLabel = new JLabel("Dev only:");
+    dialogPanel.add(devOnlyLabel, BorderLayout.LINE_START);
+    dialogPanel.add(devOnlyCheckBox, BorderLayout.CENTER);
+
+    return dialogPanel;
+  }
+
+  @Nullable
+  @Override
+  protected ValidationInfo doValidate() {
+    if (getPackageName().isEmpty()) {
+      return new ValidationInfo("A package name is required", packageInput);
+    }
+    return null;
+  }
+
+  @Override
+  public JComponent getPreferredFocusedComponent() {
+    return packageInput;
+  }
+
+  @NotNull
+  public String getPackageName() {
+    String text = packageInput.getText();
+    return text == null ? "" : text;
+  }
+
+  public boolean getDevOnly() {
+    Object[] selectedObjects = devOnlyCheckBox.getSelectedObjects();
+    if (selectedObjects == null) return false;
+    return selectedObjects.length > 0;
+  }
+}

flutter-idea/src/io/flutter/sdk/FlutterCommand.java

@@ -272,6 +272,7 @@ enum Type {
     CONFIG("Flutter config", "config"),
     CREATE("Flutter create", "create"),
     DOCTOR("Flutter doctor", "doctor", "--verbose"),
+    PUB_ADD("Flutter pub add", "pub", "add"),
     PUB_GET("Flutter pub get", "pub", "get"),
     PUB_UPGRADE("Flutter pub upgrade", "pub", "upgrade"),
     PUB_OUTDATED("Flutter pub outdated", "pub", "outdated"),

flutter-idea/src/io/flutter/sdk/FlutterSdk.java

@@ -236,6 +236,11 @@ public FlutterCommand flutterCreate(@NotNull VirtualFile appDir, @Nullable Flutt
     return new FlutterCommand(this, appDir.getParent(), FlutterCommand.Type.CREATE, vargs);
   }
 
+  public FlutterCommand flutterPackagesAdd(@NotNull PubRoot root, @NotNull String name, boolean devOnly) {
+    if (devOnly) name = "dev:" + name;
+    return new FlutterCommand(this, root.getRoot(), FlutterCommand.Type.PUB_ADD, name);
+  }
+
   public FlutterCommand flutterPackagesGet(@NotNull PubRoot root) {
     return new FlutterCommand(this, root.getRoot(), FlutterCommand.Type.PUB_GET);
   }
@@ -441,6 +446,22 @@ public PubRoot createFiles(@NotNull VirtualFile baseDir, @Nullable Module module
     return PubRoot.forDirectory(baseDir);
   }
 
+  /**
+   * Starts running 'flutter pub add' on the given pub root provided it's in one of this project's modules.
+   * <p>
+   * Shows output in the console associated with the given module.
+   * <p>
+   * Returns the process if successfully started.
+   */
+  public Process startPubAdd(@NotNull PubRoot root, @NotNull Project project, @NotNull String pkg, boolean devOnly) {
+    final Module module = root.getModule(project);
+    if (module == null) return null;
+    // Ensure pubspec is saved.
+    FileDocumentManager.getInstance().saveAllDocuments();
+    // Refresh afterwards to ensure Dart Plugin doesn't mistakenly nag to run pub.
+    return flutterPackagesAdd(root, pkg, devOnly).startInModuleConsole(module, root::refresh, null);
+  }
+
   /**
    * Starts running 'flutter pub get' on the given pub root provided it's in one of this project's modules.
    * <p>

resources/META-INF/plugin.xml

@@ -147,6 +147,9 @@
               text="Flutter Doctor"
               description="Run 'flutter doctor'"/>
       <separator/>
+      <action id="flutter.pub.add" class="io.flutter.actions.FlutterPackagesAddAction"
+              text="Flutter Pub Add"
+              description="Run 'flutter pub add'"/>
       <action id="flutter.pub.get" class="io.flutter.actions.FlutterPackagesGetAction"
               text="Flutter Pub Get"
               description="Run 'flutter pub get'"/>

resources/META-INF/plugin_template.xml

@@ -84,6 +84,9 @@
               text="Flutter Doctor"
               description="Run 'flutter doctor'"/>
       <separator/>
+      <action id="flutter.pub.add" class="io.flutter.actions.FlutterPackagesAddAction"
+              text="Flutter Pub Add"
+              description="Run 'flutter pub add'"/>
       <action id="flutter.pub.get" class="io.flutter.actions.FlutterPackagesGetAction"
               text="Flutter Pub Get"
               description="Run 'flutter pub get'"/>