VS Code tasks.json for Rust/Cargo

tasks.json

/*
 Before using this tasks.json you may like to consider trying one of the following VS Code extensions:

 rust-analyzer
    Marketplace: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer
    Source: https://github.com/rust-analyzer/rust-analyzer

 rls
    Marketplace: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust
    Source: https://github.com/rust-lang/rls-vscode

*/

// Available variables which can be used inside of strings.
// ${workspaceRoot}: the root folder of the team
// ${file}: the current opened file
// ${fileBasename}: the current opened file's basename
// ${fileDirname}: the current opened file's dirname
// ${fileExtname}: the current opened file's extension
// ${cwd}: the current working directory of the spawned process
{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "build",
      "args": ["build", "-v"],
      "command": "cargo",
      "group": "build",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "clean",
      "args": ["clean"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      }
    },
    {
      "label": "run",
      "args": ["run", "-v"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": {
          "kind": "build",
          "isDefault": true
      },
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "test",
      "args": ["test"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": {
          "kind": "z",
          "isDefault": false
      },
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    },
    {
      "label": "bench",
      "args": ["bench"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": "test",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    }
  ]
}

thanks 👍

Appreciated.

Many Thanks!

Here is the updated one for config v2.0.0

// Available variables which can be used inside of strings.
// ${workspaceRoot}: the root folder of the team
// ${file}: the current opened file
// ${fileBasename}: the current opened file's basename
// ${fileDirname}: the current opened file's dirname
// ${fileExtname}: the current opened file's extension
// ${cwd}: the current working directory of the spawned process
{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "build",
      "args": ["build", "-v"],
      "command": "cargo",
      "group": "build",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "clean",
      "args": ["clean"],
      "presentation": {
        "reveal": "always"
      }
    },
    {
      "label": "run",
      "args": ["run", "-v"],
      "presentation": {
        "reveal": "always"
      },
      "group": "build",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "test",
      "args": ["test"],
      "presentation": {
        "reveal": "always"
      },
      "group": "test",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    },
    {
      "label": "bench",
      "args": ["bench"],
      "presentation": {
        "reveal": "always"
      },
      "group": "test",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    }
  ]
}

How do you use it ?

@TomerZeitune

How do you use it ?

In the root of your project (containing the Cargo.toml file) create a folder called .vscode.
Inside .vscode, create a file called tasks.json and place the content of this gist inside the json file.
Then press CTRL+SHIFT+b when your main.rs is open.

I use this one

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "cargo run",
      "type": "shell",
      "command": "cargo",
      "args": ["run"],
      "group": {
        "kind": "build",
        "isDefault": true
      }
    }
  ]
}

When pressing CTRL+SHIFT+b, it will directly build and run since the tast is set to "isDefault" : true

The updated version doesn't work properly (only build is available). Try this one

// Available variables which can be used inside of strings.
// ${workspaceRoot}: the root folder of the team
// ${file}: the current opened file
// ${fileBasename}: the current opened file's basename
// ${fileDirname}: the current opened file's dirname
// ${fileExtname}: the current opened file's extension
// ${cwd}: the current working directory of the spawned process
{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "build",
      "args": ["build", "-v"],
      "command": "cargo",
      "group": "build",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "clean",
      "args": ["clean"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      }
    },
    {
      "label": "run",
      "args": ["run", "-v"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": {
          "kind": "build",
          "isDefault": true
      },
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        }
      ]
    },
    {
      "label": "test",
      "args": ["test"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": {
          "kind": "z",
          "isDefault": false
      },
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    },
    {
      "label": "bench",
      "args": ["bench"],
      "command": "cargo",
      "presentation": {
        "reveal": "always"
      },
      "group": "test",
      "problemMatcher": [
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "pattern": {
            "regexp": "^(.*):(\\d+):(\\d+):\\s+(\\d+):(\\d+)\\s+(warning|error):\\s+(.*)$",
            "file": 1,
            "line": 2,
            "column": 3,
            "endLine": 4,
            "endColumn": 5,
            "severity": 6,
            "message": 7
          }
        },
        {
          "owner": "rust",
          "fileLocation": ["relative", "${workspaceRoot}"],
          "severity": "error",
          "pattern": {
            "regexp": "^.*panicked\\s+at\\s+'(.*)',\\s+(.*):(\\d+)$",
            "message": 1,
            "file": 2,
            "line": 3
          }
        }
      ]
    }
  ]
}

The default build task here is cargo run but you can switch it with cargo build

Thanks for the new syntax @mbartelsm - I've updated the Gist with your suggestions.

If you haven't already, I recommend checking out the rust language server-based VS Code extension:
https://marketplace.visualstudio.com/items?itemName=rust-lang.rust

It's replaced this tasks.json for me entirely.

@deadalusai How so? I have those extensions installed (rls, rust-language-server and code-lldb) and Ctrl+Shift+B still asks me to define a tasks.json definition for cargo build et al :_/

@brainstorm On my machine after creating a new rust project and opening it in VS Code:

> cargo new footest
> code footest

Hitting Ctrl+Shift+B shows the following menu:

Just hitting Enter starts the build.
Clicking on the cog icon in that menu ejects a tasks.json file which you can then customize and commit to source control.

Edit: here is the README - https://github.com/rust-lang/rls-vscode#tasks

Interesting. On my OSX machine Cmd+Pand then > Cargo: Build seems to do the right thing, collecting warnings/errors right. On the other hand, Cmd+Shift+B shows up this:

I am working on a remote (SSH plugin) VSCode project, for more context.

Might be an OSX vs Windows difference, though that seems unlikely. I'd start checking that everything is up to date perhaps. This is the only VS Code extension I have installed:
https://marketplace.visualstudio.com/items?itemName=rust-lang.rust

No worries, a year later it works :P

👍

Just to move the goalposts again, apparently the rust-analyzer project now provides a better experience.

https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer

@deadalusai This work ok with the rust-analyzer plugin?

@wonbyte as I mentioned, I'd suggest using rust-analyzer instead of this tasks.json.

i see got it!

use --manifest-path