Merge pull request #2409 from davidalber/configuration-check-opt-out

Skipping formatting of some configuration snippets

Author: nrc

Configurations.md

@@ -1931,6 +1931,8 @@ lines are found, they are trimmed down to match this integer.
 Original Code:
 
 ```rust
+#![rustfmt_skip]
+
 fn foo() {
     println!("a");
 }
@@ -1988,6 +1990,8 @@ them, additional blank lines are inserted.
 Original Code (rustfmt will not change it with the default value of `0`):
 
 ```rust
+#![rustfmt_skip]
+
 fn foo() {
     println!("a");
 }

rustfmt-core/tests/lib.rs

@@ -664,26 +664,36 @@ impl ConfigCodeBlock {
 
     fn get_block_config(&self) -> Config {
         let mut config = Config::default();
-        config.override_value(
-            self.config_name.as_ref().unwrap(),
-            self.config_value.as_ref().unwrap(),
-        );
+        if self.config_value.is_some() && self.config_value.is_some() {
+            config.override_value(
+                self.config_name.as_ref().unwrap(),
+                self.config_value.as_ref().unwrap(),
+            );
+        }
         config
     }
 
     fn code_block_valid(&self) -> bool {
         // We never expect to not have a code block.
         assert!(self.code_block.is_some() && self.code_block_start.is_some());
 
-        if self.config_name.is_none() {
+        // See if code block begins with #![rustfmt_skip].
+        let fmt_skip = self.code_block
+            .as_ref()
+            .unwrap()
+            .split("\n")
+            .nth(0)
+            .unwrap_or("") == "#![rustfmt_skip]";
+
+        if self.config_name.is_none() && !fmt_skip {
             write_message(&format!(
                 "No configuration name for {}:{}",
                 CONFIGURATIONS_FILE_NAME,
                 self.code_block_start.unwrap()
             ));
             return false;
         }
-        if self.config_value.is_none() {
+        if self.config_value.is_none() && !fmt_skip {
             write_message(&format!(
                 "No configuration value for {}:{}",
                 CONFIGURATIONS_FILE_NAME,
@@ -752,7 +762,7 @@ impl ConfigCodeBlock {
     // - Rust code blocks are identifed by lines beginning with "```rust".
     // - One explicit configuration setting is supported per code block.
     // - Rust code blocks with no configuration setting are illegal and cause an
-    //   assertion failure.
+    //   assertion failure, unless the snippet begins with #![rustfmt_skip].
     // - Configuration names in Configurations.md must be in the form of
     //   "## `NAME`".
     // - Configuration values in Configurations.md must be in the form of