New Cargo build system. (#165)

* New Cargo build system.

* Fix wrapping of commands in GitHub flavored markdown.

* Minor fixes to unittests for Rust 1.16.

* Add support for "cargo check".

* Support clippy for on-save checking.

* Fix on-save syntax check running clippy multiple times.

* Add ability to configure cargo build features.

* Support setting environment variables.

This includes a dependency on shellenv to capture the user's environment from their login shell.

* Normalize paths when dealing with settings.

This fixes some problems running tests on Windows.

* Disable on-load message display for tests.

This was causing random breakage (particularly on Windows).

* Fix race condition in tests manifested on linux.

* Add support for custom build variants.

This includes some significant changes to how the current
package is selected.  It should work a little better if you
have multiple packages.

* Add support for a default path/package.

* Add "Automatic" build variant.

* Stop looking for JSON output during Cargo build once compile is finished.

This fixes issues with "cargo run" if your program outputs { at the start of a line.

* Better fix for checking when we should stop looking for JSON output.

The previous fix caused issues with Clippy.

* Remove debug print left behind.

* Minor updates for rust 1.17.

* Change message tests to check the region of the message.

* Fix error highlighting for nested macros.

* Fix clearing of error regions.

* Add rust_phantom_style and rust_region_style config settings.

Fixes #182.

* Honor show_errors_inline config setting for Cargo build.

* Fix links in messages that are surrounded by angled brackets.

* Consolidate all Cargo config commands into a single command.

Add commands to configure extra arguments and environment variables.

* Document the new build configure command.

Also document the `default_path` option.

* On-save syntax checking now uses configuration settings from the build
system.

* Finish documenting all settings, and include link to new build docs.

* Fix Cargo environment variable config command when selecting "all build
commands".

* Only print warning about sublime-project when saving setings.

* Fix target detection for cdylib.

Adapted from #186, thanks @smbolton.

* Update tests for new messages in rust 1.18.

Author: ehuss

Cargo.build-language

@@ -38,6 +38,12 @@
             <key>name</key>
             <string>variable.parameter</string>
         </dict>
+        <dict>
+            <key>match</key>
+            <string>^warning:</string>
+            <key>name</key>
+            <string>variable.parameter</string>
+        </dict>
         <dict>
             <key>match</key>
             <string>^test result:</string>
@@ -108,4 +114,4 @@
     <key>scopeName</key>
     <string>source.build_results</string>
 </dict>
-</plist>
+</plist>

Cargo.sublime-build

@@ -0,0 +1,17 @@
+[
+    {"keys": ["f4"], "command": "rust_next_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["shift+f4"], "command": "rust_prev_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["ctrl+break"], "command": "rust_cancel", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+]

Default (Linux).sublime-keymap

@@ -0,0 +1,17 @@
+[
+    {"keys": ["f4"], "command": "rust_next_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["shift+f4"], "command": "rust_prev_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["ctrl+c"], "command": "rust_cancel", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+]

Default (OSX).sublime-keymap

@@ -0,0 +1,17 @@
+[
+    {"keys": ["f4"], "command": "rust_next_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["shift+f4"], "command": "rust_prev_message", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+    {"keys": ["ctrl+break"], "command": "rust_cancel", "context":
+        [
+            {"key": "selector", "operator":"equal", "operand": "source.rust"}
+        ]
+    },
+]

Default (Windows).sublime-keymap

@@ -27,20 +27,12 @@ If you can't see `Rust Enhanced` its most likely because you're using Sublime Te
 
 ## Features
 ### Go To Definition
-### Build functionality
-Rust Enhanced has the following build functions:
-- Cargo Check
-- Cargo Run
-- Cargo Script [Cargo Script is needed](https://github.com/DanielKeep/cargo-script)
-- Cargo Test
-- Cargo Bench
-- Cargo Clean
-- Cargo Release
-- Cargo Document
-- Cargo Clippy
-- Rust
-- Rust Run
+### Cargo Build
+Rust Enhanced has a custom build system tailored for running Cargo.  It will display errors and warnings in line using Sublime's phantoms.  It also supports a variety of configuration options to control how Cargo is run.
 
+![testingrust](https://cloud.githubusercontent.com/assets/43198/22944409/7780ab9a-f2a5-11e6-87ea-0e253d6c40f6.png)
+
+See [the build docs](docs/build.md) for more information.
 
 ### Cargo tests with highlighting
 Thanks to [urschrei](https://github.com/urschrei/)  we have Highlighting for:
@@ -53,24 +45,31 @@ Thanks to [urschrei](https://github.com/urschrei/)  we have Highlighting for:
 - total number of measured tests > 0
 
 Example:
+
 ![highlight_rust_test](https://cloud.githubusercontent.com/assets/936006/19247437/3cf6e056-8f23-11e6-9bbe-d8c542287db6.png)
 
 ### Syntax Checking
 Rust Enhanced will automatically perform syntax checking each time you save a file.
+Errors and warnings are displayed in line the same way as the [build system](docs/build.md).
 This relies on Cargo and Rust (>= 1.8.0) being installed and on your system path. Plus Sublime Text >= 3118.
 
-There are a variety of settings (see [Settings](#settings)) for controlling the syntax highlighting:
+[Settings](#settings) for controlling the on-save syntax checking:
 
 | Setting | Default | Description |
 | :------ | :------ | :---------- |
 | `rust_syntax_checking` | `true` | Enable the on-save syntax checking. |
-| `rust_syntax_checking_include_tests` | `true` | Enable checking of test code within `#[cfg(test)]` sections. |
-| `rust_syntax_hide_warnings` | `false` | If true, will not display warning messages. |
-| `rust_syntax_error_color` | `"#F00"` | Color of error messages. |
-| `rust_syntax_warning_color` | `"#FF0"` | Color of warning messages. |
+| `rust_syntax_checking_include_tests` | `true` | Enable checking of test code within `#[cfg(test)]` sections (only for `no-trans` method). |
+| `rust_syntax_checking_method` | `"no-trans"` | The method used for checking your code (see below). |
 
-Here is an example:
-![testingrust](https://cloud.githubusercontent.com/assets/43198/22944409/7780ab9a-f2a5-11e6-87ea-0e253d6c40f6.png)
+The available checking methods are:
+
+| Method | Description |
+| :----- | :---------- |
+| `no-trans` | Runs the rustc compiler with the `-Zno-trans` option. This will be deprecated soon, however it has the benefit of supporting `#[test]` sections. |
+| `check` | Uses `cargo check` (requires at least Rust 1.16). |
+| `clippy` | Uses `cargo clippy`.  This requires [Clippy](https://github.com/Manishearth/rust-clippy) to be installed.  This also may be a little slower since it must check every target in your package. |
+
+This will use the same configuration options as the "Check" and "Clippy" build variants (for example, extra environment variables, or checking with different features).  See [the build docs](docs/build.md) for more information.
 
 Projects with multiple build targets are supported too (--lib, --bin, --example, etc.). If a cargo project has several build targets, it will attempt to automatically detect the correct target.  In some rare cases, you may need to manually specify which target a file belongs to.  This can be done by adding a "projects" setting in `Rust.sublime-settings` with the following format:
 
@@ -93,9 +92,11 @@ Projects with multiple build targets are supported too (--lib, --bin, --example,
 ```
 
 ## Settings
-You can customize the behaviour of sublime-rust by creating a settings file in your User package. This can be accessed from within SublimeText by going to the menu Preferences > Browse Packages.... Create a file named Rust.sublime-settings or alternatively copy the default settings file Packages/sublime-rust/Rust.sublime-settings to your User package and edit it to your liking.
+To customize the settings, use the command from the Sublime menu:
+
+    Preferences > Package Settings > Rust Enhanced > Settings - User
 
-Note: File names are case-sensitive on some platforms (e.g. Linux) so the file name should be exactly Rust.sublime-settings with capitalization preserved.
+Additionally, you can customize settings per-project by adding settings to your `.sublime-project` file under the `"settings"` key.
 
 ## Development
 

README.md

@@ -1,21 +1,58 @@
 {
-    "shell_cmd": "rustc \"$file\"",
+    "target": "cargo_exec",
     "selector": "source.rust",
-    "file_regex": "[ \\t]*-->[ \\t]*(.*?):([0-9]+):([0-9]+)$",
-    "osx":
-    {
-        "path": "~/.cargo/bin:$path",
-    },
+    "command": "build",
 
     "variants": [
         {
-            "selector": "source.rust",
-            "shell_cmd": "./$file_base_name",
+            "name": "Automatic",
+            "command": "auto",
+        },
+        {
             "name": "Run",
-            "windows":
-            {
-                "shell_cmd": "\"$file_base_name.exe\""
+            "command": "run",
+        },
+        {
+            "name": "Run (with args)...",
+            "command": "run",
+            "command_info": {
+                "wants_run_args": true
+            }
+        },
+        {
+            "name": "Check",
+            "command": "check",
+        },
+        {
+            "name": "Test",
+            "command": "test",
+        },
+        {
+            "name": "Test (with args)...",
+            "command": "test",
+            "command_info": {
+                "wants_run_args": true
             }
-        }
+        },
+        {
+            "name": "Bench",
+            "command": "bench",
+        },
+        {
+            "name": "Clean",
+            "command": "clean",
+        },
+        {
+            "name": "Document",
+            "command": "doc",
+        },
+        {
+            "name": "Clippy",
+            "command": "clippy",
+        },
+        {
+            "name": "Script",
+            "command": "script",
+        },
     ]
 }

RustEnhanced.sublime-build

@@ -1,6 +1,26 @@
 [
-    { 
-        "caption": "Rust: Toggle Syntax Checking", 
+    {
+        "caption": "Rust: Toggle Syntax Checking",
         "command": "toggle_rust_syntax_setting"
-    }
+    },
+    {
+        "caption": "Rust: Next Message",
+        "command": "rust_next_message"
+    },
+    {
+        "caption": "Rust: Prev Message",
+        "command": "rust_prev_message"
+    },
+    {
+        "caption": "Rust: Cancel Build",
+        "command": "rust_cancel"
+    },
+    {
+        "caption": "Rust: Create New Cargo Build Variant",
+        "command": "cargo_create_new_build"
+    },
+    {
+        "caption": "Rust: Configure Cargo Build",
+        "command": "cargo_configure"
+    },
 ]

RustEnhanced.sublime-commands

@@ -13,7 +13,24 @@
     "rust_syntax_error_color": "#F00",
 
     // Color of warning messages.
-    "rust_syntax_warning_color":"#FF0"
+    "rust_syntax_warning_color":"#FF0",
+
+    // Specify environment variables to add when running Cargo.
+    // "rust_env": {"PATH": "$PATH:$HOME/.cargo/bin"}
+
+    // If true, will use the environment from the user's login shell when
+    // running Cargo.
+    "rust_include_shell_env": true,
+
+    // For errors/warnings, how to show the inline message.
+    // "normal" - Shows the message inline.
+    // "none" - Do not show the message inline.
+    "rust_phantom_style": "normal",
+
+    // For errors/warnings, how to highlight the region of the error.
+    // "outline" - Outlines the region.
+    // "none" - No outlining.
+    "rust_region_style": "outline",
 
     // If your cargo project has several build targets, it's possible to specify mapping of
     // source code filenames to the target names to enable syntax checking.