Commands: refactored / improved some code.

- Renamed command caption to `Mix Test: Set --seed`
- Added palette command `Mix Test: All`
- Renamed unused `kwargs` -> `_kwargs`
- Renamed save_json_settings() -> save_json_file()
- Renamed load_json_settings() -> load_json_file()
- Improved exception handling in json functions

Author: azizk

README.md

@@ -84,11 +84,12 @@ Use the default shortcut `Alt+Shift+F` or the palette command `Mix Format: File`
 
 - `ElixirSyntax: Settings`
 - `Mix Test: Settings`
+- `Mix Test: All`
 - `Mix Test: File`
 - `Mix Test: Selection(s)`
 - `Mix Test: Failed`
 - `Mix Test: Repeat`
-- `Mix Test: Set Seed`
+- `Mix Test: Set --seed`
 - `Mix Test: Toggle --stale Flag`
 - `Mix Format: File`
 - `Mix Format: Project / Folder`

commands/Default.sublime-commands

@@ -4,11 +4,12 @@
     "default": "{\n  $0\n}\n"
   } },
   { "caption": "Mix Test: Settings", "command": "mix_test_settings" },
+  { "caption": "Mix Test: All", "command": "mix_test" },
   { "caption": "Mix Test: File", "command": "mix_test_file" },
   { "caption": "Mix Test: Selection(s)", "command": "mix_test_selection" },
   { "caption": "Mix Test: Failed", "command": "mix_test_failed" },
   { "caption": "Mix Test: Repeat", "command": "mix_test_repeat" },
-  { "caption": "Mix Test: Set Seed", "command": "mix_test_set_seed" },
+  { "caption": "Mix Test: Set --seed", "command": "mix_test_set_seed" },
   { "caption": "Mix Test: Toggle --stale Flag", "command": "mix_test_toggle_stale_flag" },
   { "caption": "Mix Format: File", "command": "mix_format_file" },
   { "caption": "Mix Format: Project / Folder", "command": "mix_format_project" },

commands/mix_format.py

@@ -12,7 +12,7 @@ class MixFormatProjectCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Runs `mix format` on the project path or the opened folder.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     call_mix_format(self.window)
 
 class MixFormatFileCommand(sublime_plugin.TextCommand):
@@ -32,7 +32,7 @@ class MixFormatToggleAutoFormatCommand(sublime_plugin.TextCommand):
   def description(self):
     return 'Enables or disables auto-formatting on save.'
 
-  def run(self, _edit, **kwargs):
+  def run(self, _edit, **_kwargs):
     package_settings, mix_format_settings = load_mix_format_settings()
     on_save = mix_format_settings['on_save'] = not mix_format_settings.get('on_save', False)
     package_settings.set('mix_format', mix_format_settings)

commands/mix_test.py

@@ -22,14 +22,14 @@ class MixTestSettingsCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Opens the `mix test` settings file for the current project.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     abs_file_path = self.window.active_view().file_name()
     window_vars = self.window.extract_variables()
     mix_settings_path = reverse_find_json_path(self.window, FILE_NAMES.SETTINGS_JSON)
 
     if mix_settings_path:
       if not path.exists(mix_settings_path):
-        save_json_settings(mix_settings_path, add_help_info({'args': []}))
+        save_json_file(mix_settings_path, add_help_info({'args': []}))
       sublime_NewFileFlags_NONE = 4
       self.window.open_file(mix_settings_path, flags=sublime_NewFileFlags_NONE)
     else:
@@ -42,14 +42,14 @@ class MixTestCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Runs the full test-suite with `mix test`.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     call_mix_test_with_settings(self.window)
 
 class MixTestFileCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Runs `mix test` on the current test file.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     abs_file_path = self.window.active_view().file_name()
     assert_is_test_file(abs_file_path)
     call_mix_test_with_settings(self.window, abs_file_path=abs_file_path)
@@ -156,18 +156,18 @@ class MixTestFailedCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Repeats only tests that failed the last time.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     call_mix_test_with_settings(self.window, failed=True)
 
 class MixTestRepeatCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Repeats `mix test` with the last used parameters.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     json_path = reverse_find_json_path(self.window, path.join('_build', FILE_NAMES.REPEAT_JSON))
 
     if json_path:
-      call_mix_test_with_settings(self.window, **load_json_settings(json_path))
+      call_mix_test_with_settings(self.window, **load_json_file(json_path))
     else:
       print_status_msg('Error: No tests to repeat.')
 
@@ -180,7 +180,7 @@ def run(self, _edit, seed=None):
     if not mix_settings_path:
       return
 
-    mix_params = load_json_settings(mix_settings_path)
+    mix_params = load_json_file(mix_settings_path)
     seed = self.view.substr(self.view.sel()[0]) if seed is None else seed
     seed = seed.strip() if type(seed) == str else seed
     msg = None
@@ -193,7 +193,7 @@ def run(self, _edit, seed=None):
         msg = 'Erased mix test seed.'
         'seed' in mix_params and mix_params.pop('seed')
 
-      save_json_settings(mix_settings_path, add_help_info(mix_params))
+      save_json_file(mix_settings_path, add_help_info(mix_params))
 
     print_status_msg(msg or 'Error: cannot set mix test seed to: %s' % repr(seed))
 
@@ -209,16 +209,16 @@ class MixTestToggleStaleFlagCommand(sublime_plugin.WindowCommand):
   def description(self):
     return 'Toggles the --stale flag.'
 
-  def run(self, **kwargs):
+  def run(self, **_kwargs):
     mix_settings_path = reverse_find_json_path(self.window, FILE_NAMES.SETTINGS_JSON)
     if not mix_settings_path:
       return
-    mix_params = load_json_settings(mix_settings_path)
+    mix_params = load_json_file(mix_settings_path)
     args = mix_params.get('args', [])
     has_stale_flag = '--stale' in args
     args = [a for a in args if a != '--stale'] if has_stale_flag else args + ['--stale']
     mix_params['args'] = args
-    save_json_settings(mix_settings_path, mix_params)
+    save_json_file(mix_settings_path, mix_params)
     print_status_msg('%s mix test --stale flag!' % ['Added', 'Removed'][has_stale_flag])
 
 
@@ -242,6 +242,8 @@ def get_test_block_regions(view, header_region, lookup_table):
   point, view_size = name_region.b, view.size()
   begin_scopes_counter = 0
 
+  # TODO: use view.expand_to_scope() when available?
+
   while point < view_size:
     token_region = view.extract_scope(point)
     token_str = view.substr(token_region)
@@ -390,9 +392,9 @@ def call_mix_test_with_settings(window, **params):
     params.setdefault('file_path', path.relpath(params['abs_file_path'], root_dir))
     del params['abs_file_path']
 
-  save_json_settings(path.join(build_dir, FILE_NAMES.REPEAT_JSON), params)
+  save_json_file(path.join(build_dir, FILE_NAMES.REPEAT_JSON), params)
 
-  mix_params = load_json_settings(mix_settings_path)
+  mix_params = load_json_file(mix_settings_path)
   mix_params = remove_help_info(mix_params)
   mix_params.update(params)
   mix_params.setdefault('cwd', root_dir)

commands/utils.py

@@ -37,25 +37,25 @@ def reverse_find_root_folder(bottom_path):
 
   return None
 
-def save_json_settings(file_path, dict_data):
+def save_json_file(file_path, dict_data):
   try:
-    with open(file_path, 'w') as file:
+    with open(str(file_path), 'w') as file:
       try:
         return json.dump(dict_data, file, indent=2)
-      except:
-        print_status_msg('Error: could not save JSON to: %s' % file_path)
-  except:
-    print_status_msg('Error: could not open file: %s' % file_path)
+      except BaseException as e:
+        print_status_msg('Error: could not save JSON to: %r\nException: %s' % (file_path, e))
+  except BaseException as e:
+    print_status_msg('Error: could not open file: %r\nException: %s' % (file_path, e))
 
-def load_json_settings(file_path):
+def load_json_file(file_path):
   try:
-    with open(file_path, 'r') as file:
+    with open(str(file_path), 'r') as file:
       try:
         return json.load(file)
-      except:
-        print_status_msg('Error: could not load JSON from: %s' % file_path)
-  except:
+      except BaseException as e:
+        print_status_msg('Error: could not load JSON from: %r\nException: %s' % (file_path, e))
+  except BaseException as e:
     exists = Path(file_path).exists()
-    exists and print_status_msg('Error: could not open file: %s' % file_path)
+    exists and print_status_msg('Error: could not open file: %r\nException: %s' % (file_path, e))
 
   return {}