Improve elm-format integration

sentience · sentience · commit 297b2b87f1b1 · 2018-10-14T15:54:47.000+11:00
* Run elm-format from project directory for Elm version auto-detection. * Specify elm-format command-line options with `elm_format_options` setting. * Override all settings in project settings file. Fixes #53
diff --git a/README.md b/README.md
@@ -1,25 +1,25 @@
 ![Elm Language Support logo](images/logo.png)
+
 # The Sublime Elm Language Package
 
 > This prerelease version provides experimental support for the just-released
 > [Elm 0.19][], and **breaks compatibility** with Elm 0.18 and earlier.
-> 
+>
 > Please report issues on GitHub:
 > <https://github.com/elm-community/SublimeElmLanguageSupport/issues>
 >
-> Help Welcome
-> ------------
+> ## Help Welcome
 >
 > Are you interested in contributing to the Elm Language Support package for
-Sublime Text? Get in touch!
+> Sublime Text? Get in touch!
 
 ## Installation
 
 1. Install [Package Control][]
 2. Run `Package Control: Install Package` in the Command Palette (<kbd>Super+Shift+P</kbd>)
 3. Install [Elm][] or use [NPM][] (`npm i -g elm`)
 
-### Manual 
+### Manual
 
 1. Go to Packages directory
 2. Clone the repository `git clone https://github.com/elm-community/SublimeElmLanguageSupport.git 'Elm Language Support'`
@@ -30,54 +30,72 @@ Sublime Text? Get in touch!
 - Syntax highlighting
 - Snippets for common Elm syntax (function, `case` … `of`, `let` … `in`, etc.)
 
-| Tab Trigger    | Description                                      |
-|----------------|--------------------------------------------------|
-| cof            | ``case … of``                                    |
-| cofm           | ``case … of (Maybe)``                            |
-| cofr           | ``case … of (Result)``                           |
-| debug          | ``Debug.log``                                    |
-| fn             | ``Function (a -> b)``                            |
-| fn2            | ``Function (a -> b -> c)``                       |
-| fn3            | ``Function (a -> b -> c -> d)``                  |
-| fn4            | ``Function (a -> b -> c -> d -> e)``             |
-| imp            | ``import``                                       |
-| impas          | ``import … as``                                  |
-| let            | ``let … in …``                                   |
-| mod            | ``module``                                       |
-| type           | ``type``                                         |
-| typea          | ``type alias (Record)``                          |
+  | Tab Trigger | Description                        |
+  | ----------- | ---------------------------------- |
+  | cof         | `case … of`                        |
+  | cofm        | `case … of (Maybe)`                |
+  | cofr        | `case … of (Result)`               |
+  | debug       | `Debug.log`                        |
+  | fn          | `Function (a -> b)`                |
+  | fn2         | `Function (a -> b -> c)`           |
+  | fn3         | `Function (a -> b -> c -> d)`      |
+  | fn4         | `Function (a -> b -> c -> d -> e)` |
+  | imp         | `import`                           |
+  | impas       | `import … as`                      |
+  | let         | `let … in …`                       |
+  | mod         | `module`                           |
+  | type        | `type`                             |
+  | typea       | `type alias (Record)`              |
 
 - Four standard build commands (<kbd>Super+[Shift]+B</kbd> or <kbd>Super+[Shift]+F7</kbd>)
-    1. `Build` just checks errors. Kudos to this [tweet][]!
-    2. `Run` additionally outputs your compiled program to an inferred path.
-    3. The same as the above two, but ignoring warnings
-    4. Output path is configurable in `elm-package.json` or `Elm Build System: …` in the Command Palette. Elm build system only requires a valid config in any ancestor directory of the active file. ![compile messages screenshot](images/elm_project.jpg)
+  1. `Build` just checks errors. Kudos to this [tweet][]!
+  2. `Run` additionally outputs your compiled program to an inferred path.
+  3. The same as the above two, but ignoring warnings
+  4. Output path is configurable in `elm-package.json` or `Elm Build System: …` in the Command Palette. Elm build system only requires a valid config in any ancestor directory of the active file. ![compile messages screenshot](images/elm_project.jpg)
 - Compile messages
-    1. Navigate errors and warnings (<kbd>Super+[Shift]+F4</kbd>).
-    2. Formatted for build output panel.
-    3. Compile message highlighting, embedded code highlighting, and color scheme for output panel. ![compile messages screenshot](images/elm_make.jpg)
+  1. Navigate errors and warnings (<kbd>Super+[Shift]+F4</kbd>).
+  2. Formatted for build output panel.
+  3. Compile message highlighting, embedded code highlighting, and color scheme for output panel. ![compile messages screenshot](images/elm_make.jpg)
 - Integration with popular plugins (installed separately)
-    1. [SublimeREPL][] — Run `elm-repl` in an editor tab with syntax highlighting. ![SublimeREPL screenshot](images/elm_repl.jpg)
+  1. [SublimeREPL][] — Run `elm-repl` in an editor tab with syntax highlighting. ![SublimeREPL screenshot](images/elm_repl.jpg)
 - Integration with [elm format](https://github.com/avh4/elm-format)
-    1. Make sure `elm-format` is in your PATH
-    2. Run the "Elm Language Support: Run elm-format" command from the Command Palette to run elm-format on the current file
-    3. To enable automatic formatting on every save, Go to Preferences -> Package Settings -> Elm Language Support -> Settings and add this setting:
-        `"elm_format_on_save": true`
-    4. If there are certain Elm source files you don't want to automatically run `elm-format` on, for example elm-css based files, you can set a regex filter which will search the full filename (including the path to the file). If the regex matches, then it will not automatically run `elm-format` on the file when you save. For example, the following filter would prevent automatic `elm-format` on a file named `elm-css/src/Css/TopBar.elm`:
-        `"elm_format_filename_filter": "elm-css/src/Css/.*\\.elm$"`![elm-format screenshot](images/elm_format.png)
+  1. Make sure `elm-format` is in your PATH
+  2. Run the "Elm Language Support: Run elm-format" command from the Command Palette to run elm-format on the current file
+  3. To enable automatic formatting on every save, Go to Preferences -> Package Settings -> Elm Language Support -> Settings and add this setting:
+     `"elm_format_on_save": true`
+  4. If there are certain Elm source files you don't want to automatically run `elm-format` on, for example elm-css based files, you can set a regex filter which will search the full filename (including the path to the file). If the regex matches, then it will not automatically run `elm-format` on the file when you save. For example, the following filter would prevent automatic `elm-format` on a file named `elm-css/src/Css/TopBar.elm`:
+     `"elm_format_filename_filter": "elm-css/src/Css/.*\\.elm$"`![elm-format screenshot](images/elm_format.png)
+- Project-specific settings
+
+  Need to configure a setting (such as `elm_format_binary`) per-project? Prefix the name of the setting with `elm_language_support_` and add it to your project settings file.
+
+  ```
+  {
+    "folders":
+    [
+      {
+        "path": "."
+      }
+    ],
+    "settings":
+    {
+      "elm_language_support_elm_format_binary": "node_modules/elm-format/unpacked_bin/elm-format"
+    }
+  }
+  ```
 
 ## Troubleshooting
 
 - I have `elm-oracle` installed, but completions, type signature display, and the type panel don't work
-    1. Make sure `elm-oracle` is on your PATH, or
-    2. Add the absolute path of the directory containing `elm-oracle` to the `elm_paths` setting in your Elm Language Support User settings
+  1. Make sure `elm-oracle` is on your PATH, or
+  2. Add the absolute path of the directory containing `elm-oracle` to the `elm_paths` setting in your Elm Language Support User settings
 - I have `elm-format` installed, but it's not working
-    1. Make sure `elm-format` is on your PATH, or
-    2. If using an alternate name for the binary (`elm-format-0.17` or `elm-format-0.18`) add it to the `elm_format_binary` setting in your Elm Language Support User settings; an example might be `"elm_format_binary": "elm-format-0.18",`, or
-    3. Add the absolute path of the directory containing `elm-format` to the `elm_paths` setting in your Elm Language Support User settings. Note that you can combine paths with the above, so an example might be `"elm_paths": "/users/alex/elm-format:/users/alex/elm-oracle"`
+  1. Make sure `elm-format` is on your PATH, or
+  2. Add the absolute path of the directory containing `elm-format` to the `elm_paths` setting in your Elm Language Support User settings. Note that you can combine paths with `:`, for example `"elm_paths": "/users/alex/elm-format/bin:/users/alex/elm-oracle/bin"`.
+  3. If using an alternate name for the binary (`elm-format-0.19`), adjust the `elm_format_binary` setting in your Elm Language Support User settings. This can be relative to your project directory. For example, if you want to use the NPM package version of `elm-format` installed locally in your project, use `"elm_format_binary": "node_modules/elm-format/unpacked_bin/elm-format"`.
 - Elm format automatically runs every time I save a file, but there are some files I don't want it to run on
-    1. If there are certain Elm source files you don't want to automatically run `elm-format` on, for example elm-css based files, you can set a regex filter which will search the full filename (including the path to the file). If the regex matches, then it will not automatically run `elm-format` on the file when you save. For example, the following filter would prevent automatic `elm-format` on a file named `elm-css/src/Css/TopBar.elm`:
-        `"elm_format_filename_filter": "elm-css/src/Css/.*\\.elm$"`
+  1. If there are certain Elm source files you don't want to automatically run `elm-format` on, for example elm-css based files, you can set a regex filter which will search the full filename (including the path to the file). If the regex matches, then it will not automatically run `elm-format` on the file when you save. For example, the following filter would prevent automatic `elm-format` on a file named `elm-css/src/Css/TopBar.elm`:
+     `"elm_format_filename_filter": "elm-css/src/Css/.*\\.elm$"`
 
 ## Learning
 
@@ -89,15 +107,15 @@ Don't know Elm? Great first step!
 - [Elm Town Podcast][]
 
 [elm-discuss group]: https://groups.google.com/d/forum/elm-discuss
-[Elm]: http://elm-lang.org/install
-[Elm Town Podcast]: https://elmtown.github.io
-[Elm Website]: http://elm-lang.org
-[Highlight Build Errors]: https://packagecontrol.io/packages/Highlight%20Build%20Errors
-[NPM]: https://nodejs.org
-[Package Control]: https://packagecontrol.io/installation
+[elm]: http://elm-lang.org/install
+[elm town podcast]: https://elmtown.github.io
+[elm website]: http://elm-lang.org
+[highlight build errors]: https://packagecontrol.io/packages/Highlight%20Build%20Errors
+[npm]: https://nodejs.org
+[package control]: https://packagecontrol.io/installation
 [pragmatic]: https://pragmaticstudio.com/elm
-[SublimeREPL]: https://packagecontrol.io/packages/SublimeREPL
-[Sublime Text 2]: http://www.sublimetext.com/2
-[Sublime Text 3]: http://www.sublimetext.com/3
+[sublimerepl]: https://packagecontrol.io/packages/SublimeREPL
+[sublime text 2]: http://www.sublimetext.com/2
+[sublime text 3]: http://www.sublimetext.com/3
 [tweet]: https://twitter.com/rtfeldman/status/624026168652660740
-[Elm 0.19]: https://elm-lang.org/blog/small-assets-without-the-headache
+[elm 0.19]: https://elm-lang.org/blog/small-assets-without-the-headache
diff --git a/Settings/Elm Language Support.sublime-settings b/Settings/Elm Language Support.sublime-settings
@@ -3,6 +3,7 @@
     "enabled": true,
     "elm_binary": "elm",
     "elm_format_binary": "elm-format",
+    "elm_format_options": "",
     "elm_format_on_save": true,
     "elm_format_filename_filter": "",
     "elm_paths": ""
diff --git a/elm_format.py b/elm_format.py
@@ -5,26 +5,30 @@
 import re
 import sublime, sublime_plugin
 
+from .elm_plugin import *
+from .elm_project import ElmProject
+
+USER_SETTING_PREFIX = 'elm_language_support_'
 
 class ElmFormatCommand(sublime_plugin.TextCommand):
     def run(self, edit):
-
         # Hide the console window on Windows
         shell = False
         path_separator = ':'
         if os.name == "nt":
             shell = True
             path_separator = ';'
 
-        settings = sublime.load_settings('Elm Language Support.sublime-settings')
-        binary = settings.get('elm_format_binary', 'elm-format')
-        path = settings.get('elm_paths', '')
+        binary = self.get_setting('elm_format_binary') or 'elm-format'
+        options = self.get_setting('elm_format_options') or ''
+        path = self.get_setting('elm_paths') or ''
         if path:
             old_path = os.environ['PATH']
             os.environ['PATH'] = os.path.expandvars(path + path_separator + '$PATH')
 
-        command = [binary, self.view.file_name(), '--yes']
-        p = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=shell)
+        working_dir = self.working_dir()
+        command = binary.split() + [self.view.file_name(), '--yes'] + options.split()
+        p = subprocess.Popen(command, cwd=working_dir, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=shell)
 
         if path:
             os.environ['PATH'] = old_path
@@ -46,22 +50,39 @@ def run(self, edit):
         else:
             self.view.window().run_command("hide_panel", {"panel": "output.elm_format"})
 
-
-        if settings.get('debug', False):
+        if self.get_setting('debug'):
             string_settings = sublime.load_settings('Elm User Strings.sublime-settings')
-            print(string_settings.get('logging.prefix', '') + '(' + binary + ') ' + str(output.strip()), '\nerrors: ' + str(errors.strip()))
-            if str(errors.strip()):
+            print(string_settings.get('logging.prefix', '') + output.strip().decode(),
+                  '\ncommand: ' + str(command),
+                  '\nworking directory: ' + working_dir,
+                  '\nerrors: ' + errors.strip().decode()
+            )
+            if errors.strip():
                 print('Your PATH is: ', os.environ['PATH'])
 
+    def working_dir(self):
+        vars = self.view.window().extract_variables()
+        project = ElmProject(vars['file'])
+        log_string('project.logging.settings', repr(project))
+        return project.working_dir or vars['project_path'] or vars['file_path']
+
+    def get_setting(self, key, user_key=None):
+        package_settings = sublime.load_settings('Elm Language Support.sublime-settings')
+        user_settings = self.view.settings()
+
+        return user_settings.get(user_key or (USER_SETTING_PREFIX + key), package_settings.get(key))
+
 
 class ElmFormatOnSave(sublime_plugin.EventListener):
     def on_post_save(self, view):
         sel = view.sel()[0]
         region = view.word(sel)
         scope = view.scope_name(region.b)
         if scope.find('source.elm') != -1:
-            settings = sublime.load_settings('Elm Language Support.sublime-settings')
-            if settings.get('elm_format_on_save', True):
-                regex = settings.get('elm_format_filename_filter', '')
+            package_settings = sublime.load_settings('Elm Language Support.sublime-settings')
+            on_save = 'elm_format_on_save'
+            if view.settings().get(USER_SETTING_PREFIX + on_save, package_settings.get(on_save, True)):
+                filename_filter = 'elm_format_filename_filter'
+                regex = view.settings().get(USER_SETTING_PREFIX + filename_filter, package_settings.get(filename_filter, ''))
                 if not (len(regex) > 0 and re.search(regex, view.file_name()) is not None):
                     view.run_command('elm_format')
diff --git a/elm_make.py b/elm_make.py
@@ -11,6 +11,8 @@
 from .elm_plugin import *
 from .elm_project import ElmProject
 
+USER_SETTING_PREFIX = 'elm_language_support_'
+
 # We need a custom build command so that we can take the JSON output from the
 # Elm compiler and render it in a format that works with Sublime Text’s build
 # output panel syntax highlighting and regexp-based error navigation.
@@ -274,4 +276,4 @@ def get_setting(self, key, user_key=None):
         package_settings = sublime.load_settings('Elm Language Support.sublime-settings')
         user_settings = self.window.active_view().settings()
 
-        return user_settings.get(user_key or ('elm_language_support_' + key), package_settings.get(key))
+        return user_settings.get(user_key or (USER_SETTING_PREFIX + key), package_settings.get(key))
