overloaded record dot plugin intial version (closes #3350) (#3560)

* overloaded record dot plugin initial version (closes #3350)

* Added support to GHC 9.2, and updated documentation

Also, update the CI to test overloaded-record-dot-plugin
and added overloaded-record-dot-plugin to stack.yml

* Apply suggestions from Lei Zhu (July541)

Co-authored-by: Lei Zhu <[email protected]>

* Use GHC2021 and updated gif

* Fix test.yml formatting problem

* use coerce instead of unExt (from michaelpj)

Co-authored-by: Michael Peyton Jones <[email protected]>

* Implements michaelpj code review suggestions

* Collect records on lists instead of maybe
This way we don't need to switch back and forward between the two,
and we can also return more than one match from inside a HsExpanded

* Added documentation

* Reworded comments for spelling and clarity

* use useWithStale for the TypeCheck rule

* Update version to conform with changes on master

* No longer depend on specific hls package versions

* Fixed comments and line length issues

* Added test for HsExpanded expressions

---------

Co-authored-by: Lei Zhu <[email protected]>
Co-authored-by: Michael Peyton Jones <[email protected]>

Author: 3 people

.github/workflows/test.yml

@@ -247,6 +247,12 @@ jobs:
         name: Test hls-retrie-plugin test suite
         run: cabal test hls-retrie-plugin --test-options="$TEST_OPTS" || cabal test hls-retrie-plugin --test-options="$TEST_OPTS"
 
+      - if: matrix.test && matrix.ghc != '8.10.7' && matrix.ghc != '9.0.2'
+        name: Test hls-overloaded-record-dot-plugin test suite
+        run: cabal test hls-overloaded-record-dot-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-overloaded-record-dot-plugin --test-options="$TEST_OPTS"
+
+
+
   test_post_job:
     if: always()
     runs-on: ubuntu-latest

CODEOWNERS

@@ -33,6 +33,7 @@
 /plugins/hls-tactics-plugin @isovector
 /plugins/hls-stan-plugin @uhbif19
 /plugins/hls-explicit-record-fields-plugin @ozkutuk
+/plugins/hls-overloaded-record-dot-plugin @joyfulmantis
 
 # Benchmarking
 /shake-bench @pepeiborra

cabal.project

@@ -36,6 +36,7 @@ packages:
          ./plugins/hls-explicit-fixity-plugin
          ./plugins/hls-explicit-record-fields-plugin
          ./plugins/hls-refactor-plugin
+         ./plugins/hls-overloaded-record-dot-plugin
 
 -- Standard location for temporary packages needed for particular environments
 -- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script

docs/features.md

@@ -398,6 +398,15 @@ Known limitations:
 
 - Cross-module renaming requires all components to be indexed, which sometimes causes [partial renames in multi-component projects](https://github.com/haskell/haskell-language-server/issues/2193).
 
+### Rewrite to overloaded record syntax
+
+Provided by: `hls-overloaded-record-dot-plugin`
+
+Code action kind: `refactor.rewrite`
+
+Rewrites record selectors to use overloaded dot syntax
+
+![Explicit Wildcard Demo](../plugins/hls-overloaded-record-dot-plugin/example.gif)
 ## Missing features
 
 The following features are supported by the LSP specification but not implemented in HLS.

docs/support/plugin-support.md

@@ -63,6 +63,7 @@ For example, a plugin to provide a formatter which has itself been abandoned has
 | `hls-refine-imports-plugin`         | 2    |                          |
 | `hls-stylish-haskell-plugin`        | 2    | 9.6                      |
 | `hls-tactics-plugin`                | 2    | 9.2, 9.4, 9.6            |
+| `hls-overloaded-recrod-dot-plugin`  | 2    | 8.10, 9.0                |
 | `hls-haddock-comments-plugin`       | 3    | 9.2, 9.4, 9.6            |
 | `hls-stan-plugin`                   | 3    | 8.6, 9.0, 9.2, 9.4, 9.6  |
 | `hls-retrie-plugin`                 | 3    |                          |

ghcide/src/Development/IDE/GHC/Orphans.hs

@@ -236,3 +236,9 @@ instance NFData NodeKey where
 instance NFData HomeModLinkable where
   rnf = rwhnf
 #endif
+
+instance NFData (HsExpr (GhcPass 'Renamed)) where
+    rnf = rwhnf
+
+instance NFData Extension where
+  rnf = rwhnf

haskell-language-server.cabal

@@ -174,6 +174,11 @@ flag explicitFields
   default:     True
   manual:      True
 
+flag overloadedRecordDot
+  description: Enable overloadedRecordDot plugin
+  default:     True
+  manual:      True
+
 -- formatters
 
 flag floskell
@@ -326,10 +331,15 @@ common explicitFields
     build-depends: hls-explicit-record-fields-plugin == 2.0.0.0
     cpp-options: -DexplicitFields
 
+common overloadedRecordDot
+  if flag(overloadedRecordDot) && (impl(ghc >= 9.2.0) || flag(ignore-plugins-ghc-bounds))
+    build-depends: hls-overloaded-record-dot-plugin == 2.0.0.0
+    cpp-options: -Dhls_overloaded_record_dot
+
 -- formatters
 
 common floskell
-  if flag(floskell) && impl(ghc < 9.5) 
+  if flag(floskell) && impl(ghc < 9.5)
     build-depends: hls-floskell-plugin == 2.0.0.0
     cpp-options: -Dhls_floskell
 
@@ -387,6 +397,7 @@ library
                   , ormolu
                   , stylishHaskell
                   , refactor
+                  , overloadedRecordDot
 
   exposed-modules:
     Ide.Arguments

plugins/hls-explicit-record-fields-plugin/src/Ide/Plugin/ExplicitFields.hs

@@ -22,8 +22,8 @@ import           Data.Functor                    ((<&>))
 import           Data.Generics                   (GenericQ, everything, extQ,
                                                   mkQ)
 import qualified Data.HashMap.Strict             as HashMap
-import           Data.Maybe                      (isJust, listToMaybe,
-                                                  maybeToList, fromMaybe)
+import           Data.Maybe                      (fromMaybe, isJust,
+                                                  listToMaybe, maybeToList)
 import           Data.Text                       (Text)
 import           Development.IDE                 (IdeState, NormalizedFilePath,
                                                   Pretty (..), Recorder (..),
@@ -36,8 +36,8 @@ import           Development.IDE.Core.Shake      (define, use)
 import qualified Development.IDE.Core.Shake      as Shake
 import           Development.IDE.GHC.Compat      (HsConDetails (RecCon),
                                                   HsRecFields (..), LPat,
-                                                  Outputable, getLoc, unLoc,
-                                                  recDotDot)
+                                                  Outputable, getLoc, recDotDot,
+                                                  unLoc)
 import           Development.IDE.GHC.Compat.Core (Extension (NamedFieldPuns),
                                                   GhcPass,
                                                   HsExpr (RecordCon, rcon_flds),
@@ -103,7 +103,7 @@ codeActionProvider :: PluginMethodHandler IdeState 'TextDocumentCodeAction
 codeActionProvider ideState pId (CodeActionParams _ _ docId range _) = pluginResponse $ do
   nfp <- getNormalizedFilePath (docId ^. L.uri)
   pragma <- getFirstPragma pId ideState nfp
-  CRR recMap (map unExt -> exts) <- collectRecords' ideState nfp
+  CRR recMap exts <- collectRecords' ideState nfp
   let actions = map (mkCodeAction nfp exts pragma) (RangeMap.filterByRange range recMap)
   pure $ List actions
 
@@ -160,8 +160,8 @@ collectRecordsRule recorder = define (cmapWithPrio LogShake recorder) $ \Collect
           pure ([], CRR <$> recMap <*> Just exts)
 
   where
-    getEnabledExtensions :: TcModuleResult -> [GhcExtension]
-    getEnabledExtensions = map GhcExtension . getExtensions . tmrParsed
+    getEnabledExtensions :: TcModuleResult -> [Extension]
+    getEnabledExtensions =  getExtensions . tmrParsed
 
 getRecords :: TcModuleResult -> [RecordInfo]
 getRecords (tmrRenamed -> (hs_valds -> valBinds,_,_,_)) =
@@ -186,7 +186,7 @@ instance NFData CollectRecords
 
 data CollectRecordsResult = CRR
   { recordInfos       :: RangeMap RenderedRecordInfo
-  , enabledExtensions :: [GhcExtension]
+  , enabledExtensions :: [Extension]
   }
   deriving (Generic)
 
@@ -213,15 +213,8 @@ instance Show CollectNamesResult where
 
 type instance RuleResult CollectNames = CollectNamesResult
 
--- `Extension` is wrapped so that we can provide an `NFData` instance
--- (without resorting to creating an orphan instance).
-newtype GhcExtension = GhcExtension { unExt :: Extension }
-
-instance NFData GhcExtension where
-  rnf x = x `seq` ()
-
 -- As with `GhcExtension`, this newtype exists mostly to attach
--- an `NFData` instance to `UniqFM`.
+-- an `NFData` instance to `UniqFM`.(without resorting to creating an orphan instance).
 newtype NameMap = NameMap (UniqFM Name [Name])
 
 instance NFData NameMap where

plugins/hls-overloaded-record-dot-plugin/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for hls-overloaded-record-dot-plugin
+
+## 1.0.0.0 -- 2023-04-16
+
+* First version. 

plugins/hls-overloaded-record-dot-plugin/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2023, Nathan Maxson
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Nathan Maxson nor the names of other
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

plugins/hls-overloaded-record-dot-plugin/README.md

@@ -0,0 +1,18 @@
+# Explicit Record Fields Plugin
+
+`hls-overloaded-record-dot-plugin` is a plugin to convert record selectors to record dot syntax in GHC 9.2 and above.
+
+
+## Demo
+
+![Convert Record Selector Demo](example.gif)
+
+
+## Known limitations
+
+hls-overloaded-record-dot-plugin currently only converts record selectors to the record dot syntax, and will not help you convert your record updaters to overloaded record update syntax.
+
+
+## Change log
+### 1.0.0.0
+- Release

plugins/hls-overloaded-record-dot-plugin/example.gif

@@ -0,0 +1,65 @@
+cabal-version:      3.0
+name:               hls-overloaded-record-dot-plugin
+version:            2.0.0.0
+synopsis:           Overloaded record dot plugin for Haskell Language Server
+description:
+  Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
+license:            BSD-3-Clause
+license-file:       LICENSE
+author:             Nathan Maxson
+maintainer:         [email protected]
+category:           Development
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+extra-source-files:
+  test/testdata/**/*.hs
+
+source-repository head
+  type:     git
+  location: https://github.com/haskell/haskell-language-server
+
+common warnings
+    ghc-options: -Wall
+
+library
+    if impl(ghc < 9.2)
+      buildable: False
+    else
+      buildable: True
+    import:           warnings
+    exposed-modules:  Ide.Plugin.OverloadedRecordDot
+    build-depends:
+      , base                  >=4.16 && <5
+      , ghcide
+      , hls-plugin-api
+      , lsp
+      , lens
+      , hls-graph
+      , text
+      , syb
+      , transformers
+      , ghc-boot-th
+      , unordered-containers
+      , containers
+      , deepseq
+    hs-source-dirs:   src
+    default-language: GHC2021
+
+test-suite tests
+    if impl(ghc < 9.2)
+      buildable: False
+    else
+      buildable: True
+    import:           warnings
+    default-language: GHC2021
+    type:             exitcode-stdio-1.0
+    hs-source-dirs:   test
+    main-is:          Main.hs
+    build-depends:
+      , base
+      , filepath
+      , text
+      , hls-overloaded-record-dot-plugin
+      , lsp-test
+      , hls-test-utils
+