Merge remote-tracking branch 'origin/master' into kokobd/improve-haddock-comments

Author: kokobd

.github/workflows/pre-commit.yml

@@ -6,11 +6,24 @@ on:
     branches: [master]
 
 jobs:
+  file-diff:
+    runs-on: ubuntu-latest
+    outputs:
+      git-diff: ${{ steps.git-diff.outputs.diff }}
+    steps:
+        - name: Checkout code
+          uses: actions/checkout@v3
+        - name: Find changed files
+          uses: technote-space/get-diff-action@v6.1.0
+          id: git-diff
+          with:
+            PATTERNS: |
+              +(src|exe|test|ghcide|plugins|hls-plugin-api|hie-compat|hls-graph|hls-test-utils)/**/*.hs
   pre-commit:
     runs-on: ubuntu-latest
+    needs: file-diff
     steps:
     - uses: actions/checkout@v3
-
     - uses: ./.github/actions/setup-build
       with:
         os: ${{ runner.os }}
@@ -40,3 +53,5 @@ jobs:
 
     - uses: actions/setup-python@v4
     - uses: pre-commit/action@v3.0.0
+      with:
+        extra_args: --files ${{ needs.file-diff.outputs.git-diff }}

.pre-commit-config.yaml

@@ -4,7 +4,7 @@
       "hooks": [
         {
           "entry": "stylish-haskell --inplace",
-          "exclude": "(^Setup.hs$|test/testdata/.*$|test/data/.*$|test/manual/lhs/.*$|^hie-compat/.*$|^plugins/hls-tactics-plugin/.*$|^ghcide/src/Development/IDE/GHC/Compat.hs$|^ghcide/src/Development/IDE/Plugin/CodeAction/ExactPrint.hs$|^ghcide/src/Development/IDE/GHC/Compat/Core.hs$|^ghcide/src/Development/IDE/Spans/Pragmas.hs$|^ghcide/src/Development/IDE/LSP/Outline.hs$|^plugins/hls-splice-plugin/src/Ide/Plugin/Splice.hs$|^ghcide/test/exe/Main.hs$|ghcide/src/Development/IDE/Core/Rules.hs|^hls-test-utils/src/Test/Hls/Util.hs$)",
+          "exclude": "(^Setup.hs$|test/testdata/.*$|test/data/.*$|test/manual/lhs/.*$|^hie-compat/.*$|^plugins/hls-tactics-plugin/.*$|^ghcide/src/Development/IDE/GHC/Compat.hs$|^plugins/hls-refactor-plugin/src/Development/IDE/GHC/Compat/ExactPrint.hs$|^ghcide/src/Development/IDE/GHC/Compat/Core.hs$|^ghcide/src/Development/IDE/Spans/Pragmas.hs$|^ghcide/src/Development/IDE/LSP/Outline.hs$|^plugins/hls-splice-plugin/src/Ide/Plugin/Splice.hs$|^ghcide/test/exe/Main.hs$|^ghcide/src/Development/IDE/Core/Rules.hs$|^hls-test-utils/src/Test/Hls/Util.hs$|^ghcide/src/Development/IDE/Core/Compile.hs$|^plugins/hls-refactor-plugin/src/Development/IDE/GHC/ExactPrint.hs$|^plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction/ExactPrint.hs$)",
           "files": "\\.l?hs$",
           "id": "stylish-haskell",
           "language": "system",

.stylish-haskell.yaml

@@ -57,6 +57,7 @@ newline: lf
 
 language_extensions:
   - BangPatterns
+  - CPP
   - DataKinds
   - DeriveFunctor
   - DeriveGeneric

configuration-ghc-90.nix

@@ -23,7 +23,7 @@ let
       ghc-lib-parser-ex = hself.ghc-lib-parser-ex_9_2_0_4;
 
       Cabal = hself.Cabal_3_6_3_0;
-      ormolu = hself.ormolu_0_5_0_0;
+      ormolu = hself.ormolu_0_5_0_1;
       fourmolu = hself.fourmolu_0_6_0_0;
       # Hlint is still broken
       hlint = doJailbreak (hself.callCabal2nix "hlint" inputs.hlint-34 { });

configuration-ghc-94.nix

@@ -31,6 +31,19 @@ let
 
       stylish-haskell = appendConfigureFlag  hsuper.stylish-haskell "-fghc-lib";
 
+      cereal = hsuper.callHackage "cereal" "0.5.8.3" {};
+      base-compat = hsuper.callHackage "base-compat" "0.12.2" {};
+      base-compat-batteries = hsuper.callHackage "base-compat-batteries" "0.12.2" {};
+      hashable = hsuper.callHackage "hashable" "1.4.1.0" {};
+      primitive = hsuper.callHackage "primitive" "0.7.4.0" {};
+      ghc-check = hsuper.callHackage "ghc-check" "0.5.0.8" {};
+      lens = hsuper.callHackage "lens" "5.2" {};
+      integer-logarithms = hsuper.callHackage "integer-logarithms" "1.0.3.1" {};
+      hiedb = hsuper.callHackage "hiedb" "0.4.2.0" {};
+      hie-bios = hsuper.callHackage "hie-bios" "0.11.0" {};
+      lsp = hsuper.callCabal2nix "lsp" "${inputs.lsp}/lsp" {};
+      lsp-types = hsuper.callCabal2nix "lsp-types" "${inputs.lsp}/lsp-types" {};
+
       # Re-generate HLS drv excluding some plugins
       haskell-language-server =
         hself.callCabal2nixWithOptions "haskell-language-server" ./.

docs/configuration.md

@@ -42,15 +42,15 @@ Here is a list of the additional settings currently supported by `haskell-langua
 
 - Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
 - Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
-- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. As it is activated by default could drive to bad performance in large projects.
-- Check parents (`haskell.checkParents`, default `CheckOnSaveAndClose`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnClose`, `CheckOnSaveAndClose`, or `AlwaysCheck`.
+- Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on initial load. As it is activated by default could drive to bad performance in large projects.
+- Check parents (`haskell.checkParents`, default `CheckOnSave`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnSave` (means dependent/parent modules will only be checked when you save), or `AlwaysCheck` (means re-typechecking them on every change).
 
 #### Generic plugin configuration
 
 Plugins have a generic config to control their behaviour. The schema of such config is:
 
 - `haskell.plugin.${pluginName}.globalOn`: usually with default true. Whether the plugin is enabled at runtime or it is not. That is the option you might use if you want to disable completely a plugin.
-  - Actual plugin names are: `ghcide-code-actions-fill-holes`, `ghcide-completions`, `ghcide-hover-and-symbols`, `ghcide-type-lenses`, `ghcide-code-actions-type-signatures`, `ghcide-code-actions-bindings`, `ghcide-code-actions-imports-exports`, `eval`, `moduleName`, `pragmas`, `refineImports`, `importLens`, `class`, `tactics` (aka wingman), `hlint`, `haddockComments`, `retrie`, `rename`, `splice`.
+  - Actual plugin names are: `ghcide-code-actions-fill-holes`, `ghcide-completions`, `ghcide-hover-and-symbols`, `ghcide-type-lenses`, `ghcide-code-actions-type-signatures`, `ghcide-code-actions-bindings`, `ghcide-code-actions-imports-exports`, `eval`, `moduleName`, `pragmas`, `refineImports`, `importLens`, `class`, `tactics` (aka wingman), `hlint`, `haddockComments`, `retrie`, `rename`, `splice`, `stan`.
   - So to disable the import lens with an explicit list of module definitions you could set `haskell.plugin.importLens.globalOn: false`
 - `haskell.plugin.${pluginName}.${lspCapability}On`: usually with default true. Whether a concrete plugin capability is enabled.
   - Capabilities are the different ways a lsp server can interact with the editor. The current available capabilities of the server are: `callHierarchy`, `codeActions`, `codeLens`, `diagnostics`, `hover`, `symbols`, `completion`, `rename`.
@@ -271,6 +271,8 @@ Coc is recommend since it is the only complete LSP implementation for Vim and Ne
 Follow Coc's [installation instructions](https://github.com/neoclide/coc.nvim).
 Then issue `:CocConfig` and add the following to your Coc config file.
 
+##### Minimal Example
+
 ```json
 {
   "languageserver": {
@@ -284,6 +286,32 @@ Then issue `:CocConfig` and add the following to your Coc config file.
 }
 ```
 
+##### Example with Settings
+
+```json
+{
+  "languageserver": {
+    "haskell": {
+      "command": "haskell-language-server-wrapper",
+      "args": ["--lsp"],
+      "rootPatterns": [ "*.cabal", "stack.yaml", "cabal.project", "package.yaml", "hie.yaml" ],
+      "filetypes": ["haskell", "lhaskell"],
+      "settings": {
+        "haskell": {
+          "checkParents": "CheckOnSave",
+          "checkProject": true,
+          "maxCompletions": 40,
+          "formattingProvider": "ormolu",
+          "plugin": {
+            "stan": { "globalOn": true }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
 #### LanguageClient-neovim
 
 ##### vim-plug