0.19 upgrade: replace open listing with documented variables

avh4 · May 17, 2018 · 90bf524 · 90bf524
1 parent e7e7757
commit 90bf524
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 12 deletions.
diff --git a/src/ElmFormat/Render/Box.hs b/src/ElmFormat/Render/Box.hs
@@ -15,6 +15,7 @@ import qualified AST.Variable
 import qualified Cheapskate.Types as Markdown
 import qualified Control.Monad as Monad
 import qualified Data.Char as Char
+import qualified Data.Foldable as Foldable
 import qualified Data.List as List
 import qualified Data.Map.Strict as Map
 import qualified Data.Maybe as Maybe
@@ -176,25 +177,38 @@ formatModuleHeader elmVersion modu =
       header =
         AST.Module.header modu
 
+      documentedVars =
+          AST.Module.docs modu
+              |> RA.drop
+              |> fmap Foldable.toList
+              |> Maybe.fromMaybe []
+              |> concatMap extractDocs
+
+      extractDocs block =
+          case block of
+              Markdown.ElmDocs vars ->
+                  fmap Text.unpack (concat vars)
+              _ -> []
+
       moduleLine =
         case elmVersion of
           Elm_0_16 ->
             formatModuleLine_0_16 header
 
           Elm_0_17 ->
-            formatModuleLine elmVersion header
+            formatModuleLine elmVersion documentedVars header
 
           Elm_0_18 ->
-            formatModuleLine elmVersion header
+            formatModuleLine elmVersion documentedVars header
 
           Elm_0_18_Upgrade ->
-              formatModuleLine elmVersion header
+              formatModuleLine elmVersion documentedVars header
 
           Elm_0_19 ->
-              formatModuleLine elmVersion header
+              formatModuleLine elmVersion documentedVars header
 
           Elm_0_19_Upgrade ->
-              formatModuleLine elmVersion header
+              formatModuleLine elmVersion documentedVars header
 
       docs =
           fmap (formatModuleDocs elmVersion) $ RA.drop $ AST.Module.docs modu
@@ -274,8 +288,8 @@ formatModuleLine_0_16 header =
           ]
 
 
-formatModuleLine :: ElmVersion -> AST.Module.Header -> Box
-formatModuleLine elmVersion header =
+formatModuleLine :: ElmVersion -> [String] -> AST.Module.Header -> Box
+formatModuleLine elmVersion documentedVars header =
   let
     tag =
       case AST.Module.srcTag header of
@@ -293,11 +307,22 @@ formatModuleLine elmVersion header =
             [ line $ keyword "module" ]
 
     exports list =
-      case formatListing (formatDetailedListing elmVersion) $ list of
-          Just listing ->
-            listing
-          _ ->
-              pleaseReport "UNEXPECTED MODULE DECLARATION" "empty listing"
+      let
+          finalValue =
+              case (elmVersion, list, documentedVars) of
+                  (Elm_0_19_Upgrade, AST.Variable.OpenListing (AST.Commented pre () post), first:rest) ->
+                      AST.Variable.ExplicitListing
+                          (AST.Module.DetailedListing
+                              ((LowercaseIdentifier first, AST.Commented pre () post):(rest |> fmap (\v -> (LowercaseIdentifier v, AST.Commented [] () []))) |> Map.fromList)
+                              Map.empty
+                              Map.empty
+                          )
+                          False
+                  _ -> list
+      in
+      case formatListing (formatDetailedListing elmVersion) finalValue of
+          Just listing -> listing
+          _ -> pleaseReport "UNEXPECTED MODULE DECLARATION" "empty listing"
 
     formatSetting (k, v) =
       formatRecordPair elmVersion "=" (line . formatUppercaseIdentifier elmVersion) (k, v, False)

diff --git a/tests/run-tests.sh b/tests/run-tests.sh
@@ -316,6 +316,7 @@ checkUpgrade 0.19 Elm-0.19/RemoveBasicsUncurry.elm
 checkUpgrade 0.19 Elm-0.19/ConvertBasicsRem.elm
 checkUpgrade 0.19 Elm-0.19/ConvertHtmlAttributesStyle.elm
 checkUpgrade 0.19 Elm-0.19/ConvertHtmlAttributesStyleAltImport.elm
+checkUpgrade 0.19 Elm-0.19/ListExports.elm
 
 checkGood 0.18 Simple.elm
 checkGood 0.18 AllSyntax/0.18/AllSyntax.elm

diff --git a/tests/test-files/transform/Elm-0.19/ListExports.elm b/tests/test-files/transform/Elm-0.19/ListExports.elm
@@ -0,0 +1,16 @@
+module ListExports exposing (..)
+
+{-|
+
+@docs a
+
+# Heading
+
+@docs X
+@docs b, c
+
+-}
+
+a = 1
+b = 2
+c = 3
diff --git a/tests/test-files/transform/Elm-0.19/ListExports.formatted.elm b/tests/test-files/transform/Elm-0.19/ListExports.formatted.elm
@@ -0,0 +1,25 @@
+module ListExports exposing (X, a, b, c)
+
+{-|
+
+@docs a
+
+
+# Heading
+
+@docs X
+@docs b, c
+
+-}
+
+
+a =
+    1
+
+
+b =
+    2
+
+
+c =
+    3