https://github.com/evancz/elm-format-on-save

Sublime Text plugin to run elm-format on save
https://github.com/evancz/elm-format-on-save

editor-plugin elm elm-format sublime-text

Last synced: about 2 months ago
JSON representation

Sublime Text plugin to run elm-format on save

• Host: GitHub
• URL: https://github.com/evancz/elm-format-on-save
• Owner: evancz
• License: bsd-3-clause
• Created: 2019-08-03T19:08:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-09T19:56:54.000Z (almost 5 years ago)
• Last Synced: 2024-01-31T08:05:27.590Z (5 months ago)
• Topics: editor-plugin, elm, elm-format, sublime-text
• Language: Python
• Homepage: https://packagecontrol.io/packages/Elm%20Format%20on%20Save
• Size: 18.6 KB
• Stars: 23
• Watchers: 4
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-elm - Elm Format on Save - Sublime Text plugin to run elm-format on save. (Editor plugins / Sublime Text)

README

        
# 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

0. Install [`elm-format`](https://github.com/avh4/elm-format)

1. Install [Elm Syntax Highlighting](https://github.com/evancz/elm-syntax-highlighting) for Sublime Text

2. Press `Ctrl+Shift+P` (or `Cmd+Shift+P` on Mac) to open the Command Palette

3. Select **Package Control: Install Package**

4. 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:

```json

{

    "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.