Document cabal diagnostic options (#3971)

fendor · mergify[bot] · michaelpj · web-flow · commit 0d9fd2325ad9 · 2024-01-17T17:21:10.000Z
Co-authored-by: mergify[bot] &lt;37929162+mergify[bot]@users.noreply.github.com&gt;
Co-authored-by: Michael Peyton Jones &lt;me@michaelpj.com&gt;
diff --git a/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs b/plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal.hs
@@ -114,6 +114,9 @@ descriptor recorder plId =
                   deleteFileOfInterest recorder ide file
                   restartCabalShakeSession (shakeExtras ide) vfs file "(closed)"
           ]
+    , pluginConfigDescriptor = defaultConfigDescriptor
+      { configHasDiagnostics = True
+      }
     }
  where
   log' = logWith recorder
diff --git a/test/testdata/schema/ghc92/default-config.golden.json b/test/testdata/schema/ghc92/default-config.golden.json
@@ -9,7 +9,8 @@
         },
         "cabal": {
             "codeActionsOn": true,
-            "completionOn": true
+            "completionOn": true,
+            "diagnosticsOn": true
         },
         "callHierarchy": {
             "globalOn": true
diff --git a/test/testdata/schema/ghc92/vscode-extension-schema.golden.json b/test/testdata/schema/ghc92/vscode-extension-schema.golden.json
@@ -17,6 +17,12 @@
         "scope": "resource",
         "type": "boolean"
     },
+    "haskell.plugin.cabal.diagnosticsOn": {
+        "default": true,
+        "description": "Enables cabal diagnostics",
+        "scope": "resource",
+        "type": "boolean"
+    },
     "haskell.plugin.callHierarchy.globalOn": {
         "default": true,
         "description": "Enables callHierarchy plugin",
diff --git a/test/testdata/schema/ghc94/default-config.golden.json b/test/testdata/schema/ghc94/default-config.golden.json
@@ -9,7 +9,8 @@
         },
         "cabal": {
             "codeActionsOn": true,
-            "completionOn": true
+            "completionOn": true,
+            "diagnosticsOn": true
         },
         "callHierarchy": {
             "globalOn": true
diff --git a/test/testdata/schema/ghc94/vscode-extension-schema.golden.json b/test/testdata/schema/ghc94/vscode-extension-schema.golden.json
@@ -17,6 +17,12 @@
         "scope": "resource",
         "type": "boolean"
     },
+    "haskell.plugin.cabal.diagnosticsOn": {
+        "default": true,
+        "description": "Enables cabal diagnostics",
+        "scope": "resource",
+        "type": "boolean"
+    },
     "haskell.plugin.callHierarchy.globalOn": {
         "default": true,
         "description": "Enables callHierarchy plugin",
diff --git a/test/testdata/schema/ghc96/default-config.golden.json b/test/testdata/schema/ghc96/default-config.golden.json
@@ -9,7 +9,8 @@
         },
         "cabal": {
             "codeActionsOn": true,
-            "completionOn": true
+            "completionOn": true,
+            "diagnosticsOn": true
         },
         "callHierarchy": {
             "globalOn": true
diff --git a/test/testdata/schema/ghc96/vscode-extension-schema.golden.json b/test/testdata/schema/ghc96/vscode-extension-schema.golden.json
@@ -17,6 +17,12 @@
         "scope": "resource",
         "type": "boolean"
     },
+    "haskell.plugin.cabal.diagnosticsOn": {
+        "default": true,
+        "description": "Enables cabal diagnostics",
+        "scope": "resource",
+        "type": "boolean"
+    },
     "haskell.plugin.callHierarchy.globalOn": {
         "default": true,
         "description": "Enables callHierarchy plugin",
diff --git a/test/testdata/schema/ghc98/default-config.golden.json b/test/testdata/schema/ghc98/default-config.golden.json
@@ -9,7 +9,8 @@
         },
         "cabal": {
             "codeActionsOn": true,
-            "completionOn": true
+            "completionOn": true,
+            "diagnosticsOn": true
         },
         "callHierarchy": {
             "globalOn": true
diff --git a/test/testdata/schema/ghc98/vscode-extension-schema.golden.json b/test/testdata/schema/ghc98/vscode-extension-schema.golden.json
@@ -17,6 +17,12 @@
         "scope": "resource",
         "type": "boolean"
     },
+    "haskell.plugin.cabal.diagnosticsOn": {
+        "default": true,
+        "description": "Enables cabal diagnostics",
+        "scope": "resource",
+        "type": "boolean"
+    },
     "haskell.plugin.callHierarchy.globalOn": {
         "default": true,
         "description": "Enables callHierarchy plugin",

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,9 @@ descriptor recorder plId =`
`114`	`114`	`deleteFileOfInterest recorder ide file`
`115`	`115`	`restartCabalShakeSession (shakeExtras ide) vfs file "(closed)"`
`116`	`116`	`]`
	`117`	`+ , pluginConfigDescriptor = defaultConfigDescriptor`
	`118`	`+ { configHasDiagnostics = True`
	`119`	`+ }`
`117`	`120`	`}`
`118`	`121`	`where`
`119`	`122`	`log' = logWith recorder`