Make style guideline warnings opt-in

README.md

@@ -44,6 +44,7 @@ The following options are currently available.
 | --- | --- | --- | --- |
 | `enable_snippets` | `bool` | `true` | Enables snippet completion, set to false for compatibility with language clients that do not support snippets (such as ale). |
 | `zig_lib_path` | `?[]const u8` | `null` | zig library path, used to analyze std library imports. |
+| `warn_style` | `bool` | `false` | Enables warnings for style *guideline* mismatches |
 
 ## Usage
 

src/config.zig

@@ -5,3 +5,7 @@ enable_snippets: bool = true,
 
 /// zig library path
 zig_lib_path: ?[]const u8 = null,
+
+/// Whether to pay attention to style issues. This is opt-in since the style
+/// guide explicitly states that the style info provided is a guideline only.
+warn_style: bool = false,

src/main.zig

@@ -137,6 +137,7 @@ fn publishDiagnostics(handle: DocumentStore.Handle, config: Config) !void {
                     if (is_extern)
                         break :blk;
 
+                    if (config.warn_style) {
                         if (func.name_token) |name_token| {
                             const loc = tree.tokenLocation(0, name_token);
 
@@ -167,6 +168,7 @@ fn publishDiagnostics(handle: DocumentStore.Handle, config: Config) !void {
                                 });
                             }
                         }
+                    }
                 },
                 else => {},
             }