Elm Format on Save
Sublime Text plugin to run elm-format on save
Details
Installs
- Total 4K
- Win 2K
- Mac 1K
- Linux 827
Mar 30 | Mar 29 | Mar 28 | Mar 27 | Mar 26 | Mar 25 | Mar 24 | Mar 23 | Mar 22 | Mar 21 | Mar 20 | Mar 19 | Mar 18 | Mar 17 | Mar 16 | Mar 15 | Mar 14 | Mar 13 | Mar 12 | Mar 11 | Mar 10 | Mar 9 | Mar 8 | Mar 7 | Mar 6 | Mar 5 | Mar 4 | Mar 3 | Mar 2 | Mar 1 | 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 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
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
- Install
elm-format
- Install Elm Syntax Highlighting for Sublime Text
- Press
Ctrl+Shift+P
(orCmd+Shift+P
on Mac) to open the Command Palette - Select Package Control: Install Package
- 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.