Merge #1434

1434: Introduce cargo-watch.check-command option for Code extension r=matklad a=alekseysidorov

By this option you can replace `check` command in `cargo watch` by the something else like `clippy`.

Co-authored-by: Aleksei Sidorov <[email protected]>
Co-authored-by: Aleksey Sidorov <[email protected]>

Author: 3 people

editors/code/package.json

@@ -201,11 +201,16 @@
                     ],
                     "description": "Whether to run `cargo watch` on startup"
                 },
-                "rust-analyzer.cargo-watch.check-arguments": {
+                "rust-analyzer.cargo-watch.arguments": {
                     "type": "string",
-                    "description": "`cargo-watch` check arguments. (e.g: `--features=\"shumway,pdf\"` will run as `cargo watch -x \"check --features=\"shumway,pdf\"\"` )",
+                    "description": "`cargo-watch` arguments. (e.g: `--features=\"shumway,pdf\"` will run as `cargo watch -x \"check --features=\"shumway,pdf\"\"` )",
                     "default": ""
                 },
+                "rust-analyzer.cargo-watch.command": {
+                    "type": "string",
+                    "description": "`cargo-watch` command. (e.g: `clippy` will run as `cargo watch -x clippy` )",
+                    "default": "check"
+                },
                 "rust-analyzer.trace.server": {
                     "type": "string",
                     "scope": "window",

editors/code/src/commands/cargo_watch.ts

@@ -43,7 +43,9 @@ export class CargoWatchProvider implements vscode.Disposable {
         this.diagnosticCollection = vscode.languages.createDiagnosticCollection(
             'rustc'
         );
-        this.statusDisplay = new StatusDisplay();
+        this.statusDisplay = new StatusDisplay(
+            Server.config.cargoWatchOptions.command
+        );
         this.outputChannel = vscode.window.createOutputChannel(
             'Cargo Watch Trace'
         );
@@ -57,10 +59,12 @@ export class CargoWatchProvider implements vscode.Disposable {
             return;
         }
 
-        let args = 'check --all-targets --message-format json';
-        if (Server.config.cargoWatchOptions.checkArguments.length > 0) {
+        let args =
+            Server.config.cargoWatchOptions.command +
+            ' --all-targets --message-format json';
+        if (Server.config.cargoWatchOptions.command.length > 0) {
             // Excape the double quote string:
-            args += ' ' + Server.config.cargoWatchOptions.checkArguments;
+            args += ' ' + Server.config.cargoWatchOptions.arguments;
         }
         // Windows handles arguments differently than the unix-likes, so we need to wrap the args in double quotes
         if (process.platform === 'win32') {

editors/code/src/commands/watch_status.ts

@@ -7,13 +7,15 @@ export class StatusDisplay implements vscode.Disposable {
 
     private i = 0;
     private statusBarItem: vscode.StatusBarItem;
+    private command: string;
     private timer?: NodeJS.Timeout;
 
-    constructor() {
+    constructor(command: string) {
         this.statusBarItem = vscode.window.createStatusBarItem(
             vscode.StatusBarAlignment.Left,
             10
         );
+        this.command = command;
         this.statusBarItem.hide();
     }
 
@@ -24,11 +26,13 @@ export class StatusDisplay implements vscode.Disposable {
             this.timer ||
             setInterval(() => {
                 if (this.packageName) {
-                    this.statusBarItem!.text = `cargo check [${
+                    this.statusBarItem!.text = `cargo ${this.command} [${
                         this.packageName
                     }] ${this.frame()}`;
                 } else {
-                    this.statusBarItem!.text = `cargo check ${this.frame()}`;
+                    this.statusBarItem!.text = `cargo ${
+                        this.command
+                    } ${this.frame()}`;
                 }
             }, 300);
 

editors/code/src/config.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 
+import { strict } from 'assert';
 import { Server } from './server';
 
 const RA_LSP_DEBUG = process.env.__RA_LSP_SERVER_DEBUG;
@@ -9,7 +10,8 @@ export type CargoWatchTraceOptions = 'off' | 'error' | 'verbose';
 
 export interface CargoWatchOptions {
     enableOnStartup: CargoWatchStartupOptions;
-    checkArguments: string;
+    arguments: string;
+    command: string;
     trace: CargoWatchTraceOptions;
 }
 
@@ -23,7 +25,8 @@ export class Config {
     public cargoWatchOptions: CargoWatchOptions = {
         enableOnStartup: 'ask',
         trace: 'off',
-        checkArguments: ''
+        arguments: '',
+        command: ''
     };
 
     private prevEnhancedTyping: null | boolean = null;
@@ -104,12 +107,20 @@ export class Config {
             );
         }
 
-        if (config.has('cargo-watch.check-arguments')) {
-            this.cargoWatchOptions.checkArguments = config.get<string>(
-                'cargo-watch.check-arguments',
+        if (config.has('cargo-watch.arguments')) {
+            this.cargoWatchOptions.arguments = config.get<string>(
+                'cargo-watch.arguments',
                 ''
             );
         }
+
+        if (config.has('cargo-watch.command')) {
+            this.cargoWatchOptions.command = config.get<string>(
+                'cargo-watch.command',
+                ''
+            );
+        }
+
         if (config.has('lruCapacity')) {
             this.lruCapacity = config.get('lruCapacity') as number;
         }