visual-studio-codeconfigurationvscode-extensions

Auto run command from vscode extension on file save


I can I auto execute 2 separate commands upon file saving in VS Code?

I want the two commands to do the following:

    1. Format the document in focus
    2. Sort the documents Imports


Solution

  • There is no default support for running Tasks, or Commands, on save (onSave). However, there is 3rd party support via the VSCode extension "Run on Save".

    Here is the link: https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave

    This is a very popular extension, I used it once a while back and it worked well for my use-case.

    Also if you just want to lint, or format code, on save that can be done through VSCode settings.

    EDIT June 20, 2021 @ 9:04pm UTC

    If you want to add the command to your settings you have to configure a the extension, which is explained in the extensions README.md, that can be viewed by clicking on the extensions icon in the VSCode extensions explorer.

    Configuration

    Add "emeraldwalk.runonsave" configuration to user or workspace settings.

    Sample Config

    This sample configuration will run echo statements including the saved file path. In this sample, the first command is async, so the second command will get executed immediately even if first hasn't completed. Since the second isn't async, the third command won't execute until the second is complete.

    "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": ".*",
                "isAsync": true,
                "cmd": "echo 'I run for all files.'"
            },
            {
                "match": "\\.txt$",
                "cmd": "echo 'I am a .txt file ${file}.'"
            },
            {
                "match": "\\.js$",
                "cmd": "echo 'I am a .js file ${file}.'"
            },
            {
                "match": ".*",
                "cmd": "echo 'I am ${env.USERNAME}.'"
            }
        ]
    }
    


    Configuring a command to execute when you save, isn't going to be as simple as hitting [F1] to open the quick-input, and finding the extensions task that you want to run. You will have to follow the instructions, and when you get stuck, you might have to come back and ask a question about the issue you are experiencing, or google it however; if your a Linux user, or you have a lot of MS-Dos or Powershell experience, this will be pretty straight forward.