Merge branch 'master' into bug-fix/pragma-before-shebang

Author: Ishmum Jawad Khan

.github/mergify.yml

@@ -7,6 +7,8 @@ pull_request_rules:
   conditions:
   - status-success=bench-example (8.10.4, ubuntu-latest, Cabal-3.0.0.0)
   - status-success=bench-example (8.10.4, ubuntu-latest, lsp-types-1.0.0.1)
+  # disabled (too slow, ~4h) until hie-bios >0.7.2 is released
+  # - status-success=bench-example (8.10.4, ubuntu-latest, bench_example_HLS)
 
   - status-success=nix (default, ubuntu-latest)
   - status-success=nix (default, macOS-latest)

.github/workflows/bench.yml

@@ -12,6 +12,9 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
+    # Cancel queued workflows from earlier commits in this branch
+    - uses: fkirc/skip-duplicate-actions@master
+
     - uses: actions/checkout@v2
     - run: git fetch origin master # check the master branch for benchmarking
     - uses: haskell/actions/setup@v1
@@ -78,9 +81,12 @@ jobs:
       matrix:
         ghc: ['8.10.4']
         os: [ubuntu-latest]
-        example: ['Cabal-3.0.0.0', 'lsp-types-1.0.0.1']
+        example: ['Cabal-3.0.0.0', 'lsp-types-1.0.0.1', 'bench_example_HLS']
 
     steps:
+    # Cancel queued workflows from earlier commits in this branch
+    - uses: fkirc/skip-duplicate-actions@master
+
     - uses: haskell/actions/setup@v1
       with:
         ghc-version: ${{ matrix.ghc }}
@@ -121,6 +127,13 @@ jobs:
            ghcide/bench-results/results.*
            ghcide/bench-results/**/*.csv
            ghcide/bench-results/**/*.svg
-           ghcide/bench-results/**/*.eventlog
            ghcide/bench-results/**/*.eventlog.html
+
+    - name: Archive benchmark logs
+      uses: actions/upload-artifact@v2
+      with:
+        name: bench-logs-${{ runner.os }}-${{ matrix.ghc }}
+        path: |
+           ghcide/bench-results/**/*.log
+           ghcide/bench-results/**/*.eventlog
            ghcide/bench-results/**/*.hp

.gitignore

@@ -30,3 +30,6 @@ test/testdata/**/hie.yaml
 
 # shake build folder (used in benchmark suite)
 .shake/
+
+# pre-commit-hook.nix
+.pre-commit-config.yaml

.stylish-haskell.yaml

@@ -0,0 +1,77 @@
+# See https://github.com/jaspervdj/stylish-haskell/blob/main/data/stylish-haskell.yaml
+# for reference.
+
+steps:
+  # - unicode_syntax:
+  #     add_language_pragma: true
+
+  # - module_header:
+  #     indent: 4
+  #     sort: true
+  #     separate_lists: true
+
+  # - records:
+  #     equals: "indent 2"
+  #     first_field: "indent 2"
+  #     field_comment: 2
+  #     deriving: 2
+  #     via: "indent 2"
+  #     sort_deriving: true
+  #     break_enums: false
+  #     break_single_constructors: true
+  #     curried_context: false
+
+  - simple_align:
+      cases: always
+      top_level_patterns: always
+      records: always
+      multi_way_if: always
+
+  - imports:
+      align: global
+      list_align: after_alias
+      pad_module_names: true
+      long_list_align: inline
+      empty_list_align: inherit
+      list_padding: 4
+      separate_lists: true
+      space_surround: false
+      ghc_lib_parser: false
+
+  - language_pragmas:
+      style: vertical
+      align: true
+      remove_redundant: true
+      language_prefix: LANGUAGE
+
+  # - tabs:
+  #     spaces: 8
+
+  - trailing_whitespace: {}
+
+  # - squash: {}
+
+columns: 80
+
+newline: native
+
+language_extensions:
+  - BangPatterns
+  - DataKinds
+  - DeriveFunctor
+  - DeriveGeneric
+  - FlexibleContexts
+  - GeneralizedNewtypeDeriving
+  - KindSignatures
+  - LambdaCase
+  - NamedFieldPuns
+  - OverloadedStrings
+  - RecordWildCards
+  - ScopedTypeVariables
+  - StandaloneDeriving
+  - TupleSections
+  - TypeApplications
+  - TypeOperators
+  - ViewPatterns
+
+cabal: true

CONTRIBUTING.md

@@ -1,5 +1,40 @@
 # Contributors Guide
 
+## Pre-commit hook
+We are using [pre-commit-hook.nix](https://github.com/cachix/pre-commit-hooks.nix) to configure git pre-commit hook for formatting. Although it is possible to run formatting manually, we recommend you to use it to set pre-commit hook as our CI checks pre-commit hook is applied or not.
+
+You can configure the pre-commit-hook by running
+
+``` bash
+nix-shell
+```
+
+If you don't want to use [nix](https://nixos.org/guides/install-nix.html), you can instead use [pre-commit](https://pre-commit.com) with the following config.
+
+```json
+{
+  "repos": [
+    {
+      "hooks": [
+        {
+          "entry": "stylish-haskell --inplace",
+          "exclude": "(test/testdata/.*|hie-compat/.*)",
+          "files": "\\.l?hs$",
+          "id": "stylish-haskell",
+          "language": "system",
+          "name": "stylish-haskell",
+          "pass_filenames": true,
+          "types": [
+            "file"
+          ]
+        }
+      ],
+      "repo": "local"
+    }
+  ]
+}
+```
+
 ## Testing
 
 The tests make use of the [Tasty](https://github.com/feuerbach/tasty) test framework.