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 1K
  • Win 370
  • Mac 429
  • Linux 297
Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19
Windows 0 1 0 3 2 0 2 0 3 0 4 0 0 0 1 1 0 3 3 0 0 1 2 0 0 1 1 1 1 1 3 1 0 0 3 4 1 1 3 1 1 0 4 0 0 0
Mac 0 0 1 1 1 2 2 0 1 2 0 1 1 0 0 2 1 1 0 2 2 2 1 1 2 0 2 3 5 4 1 0 2 1 2 5 0 1 2 2 3 0 1 2 1 0
Linux 0 1 0 1 0 0 1 0 1 1 1 1 0 1 1 3 1 4 0 0 1 0 1 1 2 0 0 0 3 1 0 3 2 2 1 1 0 2 0 1 4 1 2 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.