Merge pull request #549 from Shopify/andyw8/add-formatter-status-item

Add formatter status item

Author: andyw8

README.md

@@ -212,6 +212,13 @@ vscode.commands.registerCommand(
 );
 ```
 
+## Formatting
+
+When `rubyLsp.formatter` is set to `auto`, Ruby LSP tries to determine which formatter to use.
+
+If the bundle has a **direct** dependency on a supported formatter, such as `rubocop` or `syntax_tree`, that will be used.
+Otherwise, formatting will be disabled and you will need add one to the bundle.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/vscode-ruby-lsp.

src/client.ts

@@ -40,6 +40,7 @@ export default class Client implements ClientInterface {
   #context: vscode.ExtensionContext;
   #ruby: Ruby;
   #state: ServerState = ServerState.Starting;
+  #formatter: string;
 
   constructor(
     context: vscode.ExtensionContext,
@@ -52,6 +53,7 @@ export default class Client implements ClientInterface {
     this.testController = testController;
     this.#context = context;
     this.#ruby = ruby;
+    this.#formatter = "";
     this.statusItems = new StatusItems(this);
     this.registerCommands();
     this.registerAutoRestarts();
@@ -207,6 +209,7 @@ export default class Client implements ClientInterface {
     );
 
     await this.client.start();
+    await this.determineFormatter();
 
     this.state = ServerState.Running;
   }
@@ -261,6 +264,27 @@ export default class Client implements ClientInterface {
     this.#ruby = ruby;
   }
 
+  get formatter(): string {
+    return this.#formatter;
+  }
+
+  async determineFormatter() {
+    const configuration = vscode.workspace.getConfiguration("rubyLsp");
+    const configuredFormatter: string = configuration.get("formatter")!;
+
+    if (configuredFormatter === "auto") {
+      if (await this.projectHasDependency(/^rubocop/)) {
+        this.#formatter = "rubocop";
+      } else if (await this.projectHasDependency(/^syntax_tree$/)) {
+        this.#formatter = "syntax_tree";
+      } else {
+        this.#formatter = "none";
+      }
+    } else {
+      this.#formatter = configuredFormatter;
+    }
+  }
+
   get context(): vscode.ExtensionContext {
     return this.#context;
   }
@@ -341,7 +365,7 @@ export default class Client implements ClientInterface {
       gemfile.push('eval_gemfile(File.expand_path("../Gemfile", __dir__))');
 
       // If the `ruby-lsp` exists in the bundle, add it to the custom Gemfile commented out
-      if (await this.projectHasDependency("ruby-lsp")) {
+      if (await this.projectHasDependency(/^ruby-lsp$/)) {
         // If it is already in the bundle, add the gem commented out to avoid conflicts
         gemfile.push(`# ${gemEntry}`);
       } else {
@@ -350,7 +374,7 @@ export default class Client implements ClientInterface {
       }
 
       // If debug is not in the bundle, add it to allow debugging
-      if (!(await this.projectHasDependency("debug"))) {
+      if (!(await this.projectHasDependency(/^debug$/))) {
         gemfile.push(debugEntry);
       }
     } else {
@@ -424,7 +448,7 @@ export default class Client implements ClientInterface {
     return Object.keys(features).filter((key) => features[key]);
   }
 
-  private async projectHasDependency(gemName: string): Promise<boolean> {
+  private async projectHasDependency(gemName: RegExp): Promise<boolean> {
     try {
       // We can't include `BUNDLE_GEMFILE` here, because we want to check if the project's bundle includes the
       // dependency and not our custom bundle
@@ -433,7 +457,7 @@ export default class Client implements ClientInterface {
       // exit with an error if gemName not a dependency or is a transitive dependency.
       // exit with success if gemName is a direct dependency.
       await asyncExec(
-        `ruby -rbundler -e "exit 1 unless Bundler.locked_gems.dependencies.key?('${gemName}')"`,
+        `ruby -rbundler -e "exit 1 unless Bundler.locked_gems.dependencies.keys.grep(${gemName}).any?"`,
         {
           cwd: this.workingFolder,
           env: withoutBundleGemfileEnv,

src/status.ts

@@ -20,6 +20,7 @@ export enum Command {
   ToggleYjit = "rubyLsp.toggleYjit",
   SelectVersionManager = "rubyLsp.selectRubyVersionManager",
   ToggleFeatures = "rubyLsp.toggleFeatures",
+  FormatterHelp = "rubyLsp.formatterHelp",
   RunTest = "rubyLsp.runTest",
   DebugTest = "rubyLsp.debugTest",
 }
@@ -38,6 +39,7 @@ export interface ClientInterface {
   context: vscode.ExtensionContext;
   ruby: Ruby;
   state: ServerState;
+  formatter: string;
 }
 
 export abstract class StatusItem {
@@ -340,6 +342,35 @@ export class FeaturesStatus extends StatusItem {
   }
 }
 
+export class FormatterStatus extends StatusItem {
+  constructor(client: ClientInterface) {
+    super("formatter", client);
+
+    this.item.name = "Formatter";
+    this.item.command = {
+      title: "Help",
+      command: Command.FormatterHelp,
+    };
+    this.refresh();
+  }
+
+  refresh(): void {
+    this.item.text = `Using formatter: ${this.client.formatter}`;
+  }
+
+  registerCommand(): void {
+    this.context.subscriptions.push(
+      vscode.commands.registerCommand(Command.FormatterHelp, () => {
+        vscode.env.openExternal(
+          vscode.Uri.parse(
+            "https://github.com/Shopify/vscode-ruby-lsp#formatting"
+          )
+        );
+      })
+    );
+  }
+}
+
 export class StatusItems {
   private items: StatusItem[] = [];
 
@@ -350,6 +381,7 @@ export class StatusItems {
       new ExperimentalFeaturesStatus(client),
       new YjitStatus(client),
       new FeaturesStatus(client),
+      new FormatterStatus(client),
     ];
   }
 

src/test/suite/status.test.ts

@@ -14,13 +14,15 @@ import {
   ServerState,
   ClientInterface,
   FeaturesStatus,
+  FormatterStatus,
 } from "../../status";
 
 suite("StatusItems", () => {
   let ruby: Ruby;
   let context: vscode.ExtensionContext;
   let status: StatusItem;
   let client: ClientInterface;
+  let formatter: string;
 
   beforeEach(() => {
     context = { subscriptions: [] } as unknown as vscode.ExtensionContext;
@@ -40,6 +42,7 @@ suite("StatusItems", () => {
         context,
         ruby,
         state: ServerState.Running,
+        formatter: "none",
       };
       status = new RubyVersionStatus(client);
     });
@@ -67,7 +70,7 @@ suite("StatusItems", () => {
   suite("ServerStatus", () => {
     beforeEach(() => {
       ruby = {} as Ruby;
-      client = { context, ruby, state: ServerState.Running };
+      client = { context, ruby, state: ServerState.Running, formatter: "none" };
       status = new ServerStatus(client);
     });
 
@@ -130,6 +133,7 @@ suite("StatusItems", () => {
       client = {
         context,
         ruby,
+        formatter,
         state: ServerState.Running,
       };
       status = new ExperimentalFeaturesStatus(client);
@@ -150,7 +154,7 @@ suite("StatusItems", () => {
   suite("YjitStatus when Ruby supports it", () => {
     beforeEach(() => {
       ruby = { supportsYjit: true } as Ruby;
-      client = { context, ruby, state: ServerState.Running };
+      client = { context, ruby, state: ServerState.Running, formatter: "none" };
       status = new YjitStatus(client);
     });
 
@@ -174,7 +178,7 @@ suite("StatusItems", () => {
   suite("YjitStatus when Ruby does not support it", () => {
     beforeEach(() => {
       ruby = { supportsYjit: false } as Ruby;
-      client = { context, ruby, state: ServerState.Running };
+      client = { context, ruby, state: ServerState.Running, formatter: "none" };
       status = new YjitStatus(client);
     });
 
@@ -206,6 +210,7 @@ suite("StatusItems", () => {
       status = new FeaturesStatus({
         context,
         ruby,
+        formatter,
         state: ServerState.Running,
       });
     });
@@ -253,4 +258,25 @@ suite("StatusItems", () => {
         });
     });
   });
+
+  suite("FormatterStatus", () => {
+    beforeEach(() => {
+      ruby = {} as Ruby;
+      client = {
+        context,
+        ruby,
+        state: ServerState.Running,
+        formatter: "auto",
+      };
+      status = new FormatterStatus(client);
+    });
+
+    test("Status is initialized with the right values", async () => {
+      assert.strictEqual(status.item.text, "Using formatter: auto");
+      assert.strictEqual(status.item.name, "Formatter");
+      assert.strictEqual(status.item.command?.title, "Help");
+      assert.strictEqual(status.item.command?.command, Command.FormatterHelp);
+      assert.strictEqual(context.subscriptions.length, 1);
+    });
+  });
 });