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 776
  • Win 259
  • Mac 315
  • Linux 202
Feb 29 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15
Windows 0 2 2 1 2 0 2 1 0 1 3 2 1 2 4 0 0 2 3 1 4 1 0 0 3 1 2 1 0 0 1 3 2 1 1 0 0 3 4 1 0 0 1 1 2 1
Mac 0 2 0 1 2 3 0 3 0 4 0 1 0 2 2 1 1 3 3 2 0 3 3 4 3 1 1 0 2 4 5 2 2 1 2 0 2 1 2 4 2 1 0 0 3 4
Linux 0 0 2 1 0 3 0 5 0 1 0 1 2 1 1 0 0 2 0 1 1 0 0 1 0 0 2 2 2 0 0 0 0 0 1 3 0 1 1 0 2 1 2 0 0 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.