From bb6728810473832f9b1dd99ea3c690f44b4209a1 Mon Sep 17 00:00:00 2001
From: Garry Trinder <garry@trinder365.co.uk>
Date: Fri, 13 Dec 2024 17:28:38 +0000
Subject: [PATCH] Add information diagnostic when a plugin has optional
 configSection. Closes #172

---
 CHANGELOG.md               |  1 +
 README.md                  |  1 +
 src/diagnostics.ts         | 15 +++++++++++++++
 src/test/extension.test.ts |  6 ++++--
 4 files changed, 21 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 72b292f..f3c7969 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added:
 
 - Diagnostics: Ensure at least one plugin is enabled
+- Diagnostics: Information added to pluginName value when plugin can be configured with a configSection
 
 ### Changed:
 
diff --git a/README.md b/README.md
index 93d695c..b2f329e 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,7 @@ The following sections describe the features that the extension contributes to V
 - Check that schema matches installed version of Dev Proxy
 - Check that reporters are placed after plugins
 - Check that at least one plugin is enabled
+- Check that a plugin can be configured with a configSection
 
 ### Editor Actions
 
diff --git a/src/diagnostics.ts b/src/diagnostics.ts
index ec99099..a4cafcc 100644
--- a/src/diagnostics.ts
+++ b/src/diagnostics.ts
@@ -198,6 +198,21 @@ const checkPluginConfiguration = (pluginNode: parse.ObjectNode, diagnostics: vsc
             : vscode.DiagnosticSeverity.Warning
         )
       );
+    } else if (pluginSnippet.config?.required === false) {
+      const pluginNameNode = getASTNode(
+        pluginNode.children,
+        'Identifier',
+        'name'
+      );
+      if (pluginNameNode) {
+        diagnostics.push(
+          new vscode.Diagnostic(
+            getRangeFromASTNode(pluginNameNode.value),
+            `${pluginName} can be configured with a configSection. Use '${pluginSnippet.config?.name}' snippet to create one.`,
+            vscode.DiagnosticSeverity.Information
+          )
+        );
+      }
     }
   } else {
     // if there is a config section defined on the plugin, we should have the config section defined in the document
diff --git a/src/test/extension.test.ts b/src/test/extension.test.ts
index ab35dfa..4715e0f 100644
--- a/src/test/extension.test.ts
+++ b/src/test/extension.test.ts
@@ -506,8 +506,10 @@ suite('schema', () => {
     await sleep(1000);
     const diagnostics = vscode.languages.getDiagnostics(document.uri);
 
-    const expected = 0;
-    const actual = diagnostics.length;
+    const expected = false;
+    const actual = diagnostics.some((diagnostic) => {
+      return diagnostic.severity === vscode.DiagnosticSeverity.Warning;
+    });
     assert.deepStrictEqual(actual, expected);
   });