Add purs-tidy (#22)

thomashoneyman · web-flow · commit 0c6953602e61 · 2021-08-07T16:40:06.000-04:00
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -19,12 +19,14 @@ jobs:
 
       - uses: ./ # equivalent to purescript-contrib/setup-purescript@<branch>
         with:
+          purs-tidy: "latest"
           zephyr: "latest"
 
       - name: Check spago and purs are installed correctly
         run: |
           purs --version
           spago version
 
-      # - name: Check zephyr is installed correctly
-      #   run: zephyr -f Main.main
+      - name: Check purs-tidy is installed
+        run: |
+          purs-tidy --help
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ A GitHub Action which sets up a PureScript toolchain for CI. Contains the follow
 
 You can also optionally include the following tools:
 
+- The [`purs-tidy` code formatter](https://github.com/natefaubion/purs-tidy)
 - The [Zephyr dead code elimination tool](https://github.com/coot/zephyr)
 
 This action is designed to support PureScript tools. Your PureScript project may also depend on tooling and libraries provided by the NPM ecosystem, in which case you will also want to use the [setup-node](https://github.com/actions/setup-node) action.
@@ -45,6 +46,7 @@ steps:
       purescript: "0.14.0"
       psa: "0.8.2"
       spago: "latest"
+      purs-tidy: "latest"
       zephyr: "0.3.2"
   - run: spago build
 ```
diff --git a/action.yml b/action.yml
@@ -11,6 +11,8 @@ inputs:
   psa:
     description: "The psa version to install. Examples: latest, 0.7.2"
     default: "latest"
+  purs-tidy:
+    description: "The purs-tidy version to install. Examples: latest, 0.1.1"
   zephyr:
     description: "The Zephyr version to install. Examples: latest, 0.3.2"
 runs:
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/update.js b/dist/update.js
diff --git a/dist/versions.json b/dist/versions.json
@@ -2,5 +2,6 @@
   "purs": "0.14.3",
   "spago": "0.20.3",
   "psa": "0.8.2",
+  "purs-tidy": "0.1.1",
   "zephyr": "0.3.2"
-}
+}
diff --git a/spago.dhall b/spago.dhall
@@ -16,7 +16,6 @@
   , "integers"
   , "math"
   , "maybe"
-  , "newtype"
   , "node-buffer"
   , "node-fs"
   , "node-path"
diff --git a/src/Setup/BuildPlan.purs b/src/Setup/BuildPlan.purs
@@ -10,7 +10,6 @@ import Data.Bifunctor (lmap)
 import Data.Either (Either(..))
 import Data.Foldable (fold)
 import Data.Maybe (Maybe(..))
-import Data.Newtype (unwrap)
 import Data.Traversable (traverse)
 import Data.Version (Version)
 import Data.Version as Version
@@ -39,14 +38,14 @@ data VersionField = Latest | Exact Version
 -- | Attempt to read the value of an input specifying a tool version
 getVersionField :: Key -> ExceptT Error Effect (Maybe VersionField)
 getVersionField key = do
-  value <- Core.getInput' (unwrap key)
+  value <- Core.getInput' (Key.toString key)
   case value of
     "" ->
       pure Nothing
     "latest" ->
       pure (pure Latest)
     val -> case Version.parseVersion val of
-      Left msg ->  do
+      Left msg -> do
         liftEffect $ Core.error $ fold [ "Failed to parse version ", val ]
         throwError (error (ParseError.parseErrorMessage msg))
       Right version ->
diff --git a/src/Setup/Data/Key.purs b/src/Setup/Data/Key.purs
@@ -1,15 +1,13 @@
 module Setup.Data.Key
   ( Key
   , fromTool
+  , toString
   ) where
 
-import Data.Newtype (class Newtype)
 import Setup.Data.Tool (Tool(..))
 
 newtype Key = Key String
 
-derive instance newtypeKey :: Newtype Key _
-
 purescriptKey :: Key
 purescriptKey = Key "purescript"
 
@@ -19,12 +17,19 @@ spagoKey = Key "spago"
 psaKey :: Key
 psaKey = Key "psa"
 
+pursTidyKey :: Key
+pursTidyKey = Key "purs-tidy"
+
 zephyrKey :: Key
 zephyrKey = Key "zephyr"
 
+toString :: Key -> String
+toString (Key key) = key
+
 fromTool :: Tool -> Key
 fromTool = case _ of
   PureScript -> purescriptKey
   Spago -> spagoKey
   Psa -> psaKey
+  PursTidy -> pursTidyKey
   Zephyr -> zephyrKey
diff --git a/src/Setup/Data/Platform.purs b/src/Setup/Data/Platform.purs
@@ -8,7 +8,7 @@ data Platform = Windows | Mac | Linux
 
 -- | Parse a platform value from the `process.platform` key
 platform :: Platform
-platform = case Process.platform of 
+platform = case Process.platform of
   Just Platform.Win32 -> Windows
   Just Platform.Darwin -> Mac
   _ -> Linux
diff --git a/src/Setup/Data/Tool.purs b/src/Setup/Data/Tool.purs
@@ -20,6 +20,7 @@ data Tool
   = PureScript
   | Spago
   | Psa
+  | PursTidy
   | Zephyr
 
 derive instance eqTool :: Eq Tool
@@ -51,6 +52,7 @@ name = case _ of
   PureScript -> "purs"
   Spago -> "spago"
   Psa -> "psa"
+  PursTidy -> "purs-tidy"
   Zephyr -> "zephyr"
 
 -- | The source repository for a tool (whether on GitHub or Gitlab)
@@ -67,6 +69,9 @@ repository = case _ of
   Psa ->
     { owner: "natefaubion", name: "purescript-psa" }
 
+  PursTidy ->
+    { owner: "natefaubion", name: "purescript-tidy" }
+
   Zephyr ->
     { owner: "coot", name: "zephyr" }
 
@@ -103,47 +108,44 @@ installMethod tool version = do
 
   case tool of
     PureScript -> Tarball
-      { source:
-          formatGitHub' case platform of
-            Windows -> "win64"
-            Mac -> "macos"
-            Linux -> "linux64"
-      , getExecutablePath:
-          \p -> Path.concat [ p, "purescript", executableName ]
+      { source: formatGitHub' case platform of
+          Windows -> "win64"
+          Mac -> "macos"
+          Linux -> "linux64"
+      , getExecutablePath: \p -> Path.concat [ p, "purescript", executableName ]
       }
 
     Spago -> Tarball
-      { source:
-          formatGitHub'
-            -- Spago has changed naming conventions from version to version
-            if version >= unsafeVersion "0.18.1" then case platform of
-              Windows -> "Windows"
-              Mac -> "macOS"
-              Linux -> "Linux"
-            else if version == unsafeVersion "0.18.0" then case platform of
-              Windows -> "windows-latest"
-              Mac -> "macOS-latest"
-              Linux -> "linux-latest"
-            else case platform of
-              Windows -> "windows"
-              Mac -> "osx"
-              Linux -> "linux"
-      , getExecutablePath:
-          \p -> Path.concat [ p, executableName ]
+      { source: formatGitHub'
+          -- Spago has changed naming conventions from version to version
+          if version >= unsafeVersion "0.18.1" then case platform of
+            Windows -> "Windows"
+            Mac -> "macOS"
+            Linux -> "Linux"
+          else if version == unsafeVersion "0.18.0" then case platform of
+            Windows -> "windows-latest"
+            Mac -> "macOS-latest"
+            Linux -> "linux-latest"
+          else case platform of
+            Windows -> "windows"
+            Mac -> "osx"
+            Linux -> "linux"
+      , getExecutablePath: \p -> Path.concat [ p, executableName ]
       }
 
     Psa ->
-      NPM (toolRepo.name <> "@" <> Version.showVersion version)
+      NPM ("purescript-psa@" <> Version.showVersion version)
+
+    PursTidy ->
+      NPM ("purs-tidy@" <> Version.showVersion version)
 
     Zephyr -> Tarball
-      { source:
-          formatGitHub' $ case platform of
-            Windows -> "Windows"
-            Mac -> "macOS"
-            Linux -> "Linux"
+      { source: formatGitHub' $ case platform of
+          Windows -> "Windows"
+          Mac -> "macOS"
+          Linux -> "Linux"
       , getExecutablePath: \p -> Path.concat [ p, "zephyr", executableName ]
       }
-
   where
   -- Format the release tag for a tool at a specific version. Not all tools use
   -- the same format.
diff --git a/src/Setup/UpdateVersions.purs b/src/Setup/UpdateVersions.purs
@@ -53,7 +53,7 @@ updateVersions = do
   versionsFilePath = "./dist/versions.json"
 
   writeVersionsFile :: Json -> Effect Unit
-  writeVersionsFile = writeTextFile UTF8 versionsFilePath <<< stringifyWithIndent 2
+  writeVersionsFile = writeTextFile UTF8 versionsFilePath <<< (_ <> "\n") <<< stringifyWithIndent 2
 
 -- | Find the latest release version for a given tool. Prefers explicit releases
 -- | as listed in GitHub releases, but for tools which don't support GitHub
@@ -63,6 +63,7 @@ fetchLatestReleaseVersion tool = Tool.repository tool # case tool of
   PureScript -> fetchFromGitHubReleases
   Spago -> fetchFromGitHubReleases
   Psa -> fetchFromGitHubTags
+  PursTidy -> fetchFromGitHubTags
   Zephyr -> fetchFromGitHubReleases
   where
   -- TODO: These functions really ought to be in ExceptT to avoid all the
@@ -84,49 +85,55 @@ fetchLatestReleaseVersion tool = Tool.repository tool # case tool of
   toolVersions :: Tool.ToolRepository -> Int -> Aff (Maybe (Array Version))
   toolVersions repo page = do
     let
-      url = "https://api.github.com/repos/" <> repo.owner <> "/" <> repo.name <> "/releases?per_page=10&page=" <> show page
-    AX.get RF.json url
-      >>= case _ of
-          Left err -> throwError (error $ AX.printError err)
-          Right { body } -> case decodeJson body of
-            Left e -> do
-              throwError $ error
-                $ fold
-                    [ "Failed to decode GitHub response. This is most likely due to a timeout.\n\n"
+      url =
+        "https://api.github.com/repos/"
+          <> repo.owner
+          <> "/"
+          <> repo.name
+          <> "/releases?per_page=10&page="
+          <> show page
+
+    AX.get RF.json url >>= case _ of
+      Left err -> throwError (error $ AX.printError err)
+      Right { body } -> case decodeJson body of
+        Left e -> do
+          throwError $ error
+            $ fold
+              [ "Failed to decode GitHub response. This is most likely due to a timeout.\n\n"
+              , printJsonDecodeError e
+              , stringifyWithIndent 2 body
+              ]
+        Right [] -> pure Nothing
+        Right objects ->
+          Just
+            <$> Array.catMaybes
+            <$> for objects \obj ->
+              case obj .: "tag_name" of
+                Left e ->
+                  throwError $ error $ fold
+                    [ "Failed to get tag from GitHub response: "
                     , printJsonDecodeError e
-                    , stringifyWithIndent 2 body
                     ]
-            Right [] -> pure Nothing
-            Right objects ->
-              Just
-                <$> Array.catMaybes
-                <$> for objects \obj ->
-                  case obj .: "tag_name" of
-                    Left e ->
-                      throwError $ error $ fold
-                        [ "Failed to get tag from GitHub response: "
-                        , printJsonDecodeError e
+                Right tagName ->
+                  case tagStrToVersion tagName of
+                    Left _ -> do
+                      liftEffect $ warning $ fold
+                        [ "Got invalid version"
+                        , tagName
+                        , " from "
+                        , repo.name
                         ]
-                    Right tagName ->
-                      case tagStrToVersion tagName of
-                        Left _ -> do
-                          liftEffect $ warning $ fold
-                            [ "Got invalid version"
-                            , tagName
-                            , " from "
-                            , repo.name
-                            ]
-                          pure Nothing
-                        Right version -> case obj .: "draft" of
-                          Left e ->
-                            throwError $ error $ fold
-                              [ "Failed to get draft from GitHub response: "
-                              , printJsonDecodeError e
-                              ]
-                          Right isDraft ->
-                            pure if isDraft
-                                 then Nothing
-                                 else Just version
+                      pure Nothing
+                    Right version -> case obj .: "draft" of
+                      Left e ->
+                        throwError $ error $ fold
+                          [ "Failed to get draft from GitHub response: "
+                          , printJsonDecodeError e
+                          ]
+                      Right isDraft ->
+                        pure
+                          if isDraft then Nothing
+                          else Just version
 
   tagStrToVersion tagStr =
     tagStr
