Change default on-save syntax checking to "cargo check" from no-trans. (#191)

Fixes #183.

Author: ehuss

README.md

@@ -60,8 +60,8 @@ This relies on Cargo and Rust (>= 1.8.0) being installed and on your system path
 | Setting | Default | Description |
 | :------ | :------ | :---------- |
 | `rust_syntax_checking` | `true` | Enable the on-save syntax checking. |
+| `rust_syntax_checking_method` | `"check"` | The method used for checking your code (see below). |
 | `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). |
 
 The available checking methods are:
 

RustEnhanced.sublime-settings

@@ -3,6 +3,10 @@
     // build errors or warnings.
     "rust_syntax_checking": true,
 
+    // The method used to check code on-save.
+    // "check", "no-trans", or "clippy" (see README.md)
+    "rust_syntax_checking_method": "check",
+
     // Enable checking of test code within #[cfg(test)] sections.
     "rust_syntax_checking_include_tests": true,
 

SyntaxCheckPlugin.py

@@ -13,21 +13,33 @@
 """
 
 # Notes:
-# - -Zno-trans produces a warning about being unstable (see
-#   https://github.com/rust-lang/rust/issues/31847). I am uncertain about the
-#   long-term prospects of how this will be resolved.  There are a few things
-#   to consider:
-#       - Cargo recently added "cargo check"
-#         (https://github.com/rust-lang/cargo/pull/3296), which more or less
-#         does the same thing.  See also the original "cargo check" addon
-#         (https://github.com/rsolomo/cargo-check/).
+# - -Zno-trans has been deprecated, and will only be available with the
+#   nightly compiler starting with rust 1.19.  Using "cargo check" is the
+#   preferred alternative, though it currently has some limitations. See:
+#
+#       - Unstable flags removed:
+#         https://github.com/rust-lang/rust/issues/31847
+#
+#       - Cargo check added in rust 1.16:
+#         https://github.com/rust-lang/cargo/pull/3296 (based on original
+#         "cargo check" addon https://github.com/rsolomo/cargo-check/)
+#
 #       - RLS was recently released
 #         (https://github.com/rust-lang-nursery/rls).  It's unclear to me if
 #         this will perform full-linting that could replace this or not.
 #
+#       - "cargo check" ignores #[test]:
+#         https://github.com/rust-lang/cargo/issues/3431
+#
+#       - "cargo check" will not re-issue errors/warnings if nothing has
+#         changed.  This generally should not be a problem since on-save
+#         syntax only runs after the file has been saved which updates the
+#         timestamp, but it's something to be careful about.  See:
+#         https://github.com/rust-lang/cargo/issues/3624
+#
 # - -Zno-trans prevents some warnings and errors from being generated. For
-#   example, see const-err.rs.  "cargo check" will solve this, but it is
-#   nightly only right now. Other issues:
+#   example, see const-err.rs.  "cargo check" does not have this problem.
+#   Other issues:
 #       - Errors generated by compiling an extern crate do not not output as
 #         json.
 
@@ -104,7 +116,7 @@ def get_rustc_messages(self):
 
         :raises rust_proc.ProcessTerminatedError: Check was canceled.
         """
-        method = util.get_setting('rust_syntax_checking_method', 'no-trans')
+        method = util.get_setting('rust_syntax_checking_method', 'check')
         settings = cargo_settings.CargoSettings(self.window)
         settings.load()
         command_info = cargo_settings.CARGO_COMMANDS[method]