Add support for a default path/package.

Author: ehuss

RustEnhanced.sublime-commands

@@ -35,6 +35,10 @@
         "caption": "Rust: Set Cargo Features",
         "command": "cargo_set_features"
     },
+    {
+        "caption": "Rust: Set Default Path",
+        "command": "cargo_set_default_path"
+    },
     {
         "caption": "Rust: Create New Cargo Build Variant",
         "command": "cargo_create_new_build"

cargo_build.py

@@ -63,12 +63,22 @@ def _determine_working_path(self, on_done):
             self.working_dir = working_dir
             self.settings_path = working_dir
             return on_done()
+
         script_path = self.initial_settings.get('script_path')
         if script_path:
             self.working_dir = os.path.dirname(script_path)
             self.settings_path = script_path
             return on_done()
 
+        default_path = self.settings.get('default_path')
+        if default_path:
+            self.settings_path = default_path
+            if os.path.isfile(default_path):
+                self.working_dir = os.path.dirname(default_path)
+            else:
+                self.working_dir = default_path
+            return on_done()
+
         if self.command_info.get('requires_manifest', True):
             cmd = CargoConfigPackage(self.window)
             cmd.run(functools.partial(self._on_manifest_choice, on_done))

docs/build.md

@@ -56,6 +56,7 @@ are:
 
 Command | Description
 ------- | -----------
+Rust: Set Default Path | Set the default Cargo package to build.  If not specified, then it will detect it from the current view, or display a panel to choose from.
 Rust: Set Cargo Target | Set the Cargo target (`--lib`, `--example foo`, etc.) for each build variant.  The "Automatic Detection" option will attempt to determine which target to use based on the current active view in Sublime (a test file will use `--test` or a binary will use `--bin`, etc.).
 Rust: Set Cargo Build Profile | Set whether or not to use the `--release` flag.
 Rust: Set Cargo Target Triple | Set the target triple (such as `x86_64-apple-darwin`).
@@ -89,7 +90,7 @@ An example of a `sublime-project` file:
     "settings": {
         "cargo_build": {
             "paths": {
-                "path/to/package": {
+                "/path/to/package": {
                     "defaults": {
                         "release": true
                     },
@@ -117,7 +118,7 @@ The available settings are:
 
 Setting Name | Description
 ------------ | -----------
-`working_dir` | The directory where to run Cargo.  If not specified, attempts to detect from the active view, or displays a panel to choose a Cargo package.
+`working_dir` | The directory where to run Cargo.  If not specified, uses the value from `default_path`, otherwise attempts to detect from the active view, or displays a panel to choose a Cargo package.
 `script_path` | Path to a `.rs` script, used by `cargo script` if you want to hard-code a specific script to run.
 `release` | If true, uses the `--release` flag.
 `target_triple` | If set, uses the `--target` flag with the given value.

rust/cargo_config.py

@@ -62,6 +62,9 @@ class CargoConfigBase(sublime_plugin.WindowCommand):
     # If True, the command wants the 'package' choice to fetch metadata from
     # Cargo.
     package_wants_metadata = True
+    # If True, the 'package' choice will automatically use the manifest
+    # from the active view if it is available.
+    package_allows_active_view_shortcut = True
     # This is a dictionary populated by the `items_package` method.
     # Key is the path to a package, the value is the metadata from Cargo.
     # This is used by other questions (like `items_target`) to get more
@@ -153,16 +156,18 @@ def wrapper(index):
                 raise ValueError(item_info)
 
     def items_package(self):
-        # If there is a manifest under the current view, use that by default.
         view = self.window.active_view()
-        if view.file_name():
+        if self.package_allows_active_view_shortcut and view.file_name():
+            # If there is a manifest under the current view, use that by
+            # default.
             manifest_dir = util.find_cargo_manifest(view.file_name())
             if manifest_dir:
                 if self.package_wants_metadata:
                     metadata = get_cargo_metadata(self.window, manifest_dir)
                     if metadata:
                         for package in metadata['packages']:
-                            package_dir = os.path.dirname(package['manifest_path'])
+                            package_dir = os.path.dirname(
+                                package['manifest_path'])
                             if package_dir == manifest_dir:
                                 self.packages = {
                                     manifest_dir: package
@@ -493,6 +498,24 @@ def done(self):
                                       self.choices['features'])
 
 
+class CargoSetDefaultPath(CargoConfigBase):
+
+    sequence = ['package']
+    package_allows_active_view_shortcut = False
+
+    def items_package(self):
+        result = super(CargoSetDefaultPath, self).items_package()
+        items = result['items']
+        items.insert(0, (['No Default',
+            'Build will attempt to detect from the current view, or pop up a selection panel.'],
+             None))
+        result['default'] = self.settings.get('default_path')
+        return result
+
+    def done(self):
+        self.settings.set('default_path', self.choices['package'])
+
+
 class CargoCreateNewBuild(CargoConfigBase):
 
     """Command to create a new build variant, stored in the user's

rust/cargo_settings.py

@@ -129,6 +129,16 @@ def load(self):
                 Rust Enhanced Warning: This window does not have an associated sublime-project file.
                 Any changes to the Cargo build settings will be lost if you close the window."""))
 
+    def get(self, key, default=None):
+        return self.project_data.get('settings', {})\
+                                .get('cargo_build', {})\
+                                .get(key, default)
+
+    def set(self, key, value):
+        self.project_data.setdefault('settings', {})\
+                         .setdefault('cargo_build', {})[key] = value
+        self.window.set_project_data(self.project_data)
+
     def get_with_target(self, path, target, key, default=None):
         path = os.path.normpath(path)
         pdata = self.project_data.get('settings', {})\