ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Elm Format on Save

by evancz ALL

Sublime Text plugin to run elm-format on save

Labels elm, formatting

Details

Installs

  • Total 634
  • Win 205
  • Mac 257
  • Linux 172
Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4
Windows 1 1 2 1 1 2 0 1 0 3 3 1 0 0 0 0 1 1 5 0 2 1 0 1 1 1 0 2 0 1 3 1 2 1 3 1 2 1 2 2 1 3 1 1 2 1
Mac 0 0 3 4 1 2 1 0 2 3 1 2 0 2 0 2 2 1 0 0 3 0 1 0 1 0 1 1 3 1 1 1 1 0 1 1 0 5 2 1 1 0 1 0 3 0
Linux 2 0 0 1 1 1 1 2 0 1 0 5 1 1 1 0 5 0 1 0 0 1 1 3 1 1 2 1 0 1 1 2 0 0 2 0 3 1 0 1 0 0 1 0 1 1

Readme

Source
raw.​githubusercontent.​com

Elm Format on Save

Run elm-format whenever you save an Elm file.

And add the keyboard shortcut Ctrl+K Ctrl+F (or Cmd+K Cmd+F on Mac) to run elm-format any time you want. No need to save.

Install

  1. Install elm-format
  2. Install Elm Syntax Highlighting for Sublime Text
  3. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
  4. Select Package Control: Install Package
  5. Select Elm Format on Save

Try saving an Elm file to see if it works. You may see a panel open with troubleshooting advice if something has gone wrong!

Including/Excluding Files

Do you only want elm-format to run on certain files? (e.g. only work code)

Go to Sublime Text -> Preferences -> Package Settings -> Elm Format on Save -> Settings

You will see two panels. The left is all the defaults and the right is your custom overrides. So in the right panel, you can override the default settings with something like:

{
    "on_save": {
        "including": ["my/company/"],
        "excluding": ["src/generated/"]
    }
}

This would mean that you only run elm-format on code that is in the my/company/ directory, but you skip any files in the src/generated directory.

See the left settings panel for more information about how to include and exclude files!

Technical Details

This plugin works by modifying the code in the editor itself.

So when it runs “on save” it is specifically running before the file is saved to disk.

This is really important if you have some elaborate file watching system set up! Other plugins may format after the file is saved to disk, triggering a second save, and thereby degrading the performance of your file watching system.