Introduce purs-tidy formatter

.github/workflows/ci.yml

@@ -14,6 +14,8 @@ jobs:
 
       - name: Set up a PureScript toolchain
         uses: purescript-contrib/setup-purescript@main
+        with:
+          purs-tidy: "latest"
 
       - name: Cache PureScript dependencies
         uses: actions/cache@v2
@@ -31,3 +33,6 @@ jobs:
 
       - name: Run tests
         run: spago test --no-install
+
+      - name: Check formatting
+        run: purs-tidy check src test

.gitignore

@@ -2,6 +2,7 @@
 !.gitignore
 !.github
 !.editorconfig
+!.tidyrc.json
 
 output
 generated-docs

.tidyrc.json

@@ -0,0 +1,10 @@
+{
+  "importSort": "source",
+  "importWrap": "source",
+  "indent": 2,
+  "operatorsFile": null,
+  "ribbon": 1,
+  "typeArrowPlacement": "first",
+  "unicode": "never",
+  "width": null
+}

CHANGELOG.md

@@ -11,6 +11,7 @@ New features:
 Bugfixes:
 
 Other improvements:
+- Added `purs-tidy` formatter (#26 by @thomashoneyman)
 
 ## [v6.0.2](https://github.com/purescript-contrib/purescript-form-urlencoded/releases/tag/v6.0.2) - 2021-06-16
 

src/Data/FormURLEncoded.purs

@@ -34,15 +34,15 @@ instance showFormUrlEncoded :: Show FormURLEncoded where
 encode :: FormURLEncoded -> Maybe String
 encode = map (String.joinWith "&") <<< traverse encodePart <<< toArray
   where
-    encodePart = case _ of
-      Tuple k Nothing -> encodeFormURLComponent k
-      Tuple k (Just v) -> (\key val -> key <> "=" <> val) <$> encodeFormURLComponent k <*> encodeFormURLComponent v
+  encodePart = case _ of
+    Tuple k Nothing -> encodeFormURLComponent k
+    Tuple k (Just v) -> (\key val -> key <> "=" <> val) <$> encodeFormURLComponent k <*> encodeFormURLComponent v
 
 -- | Decode `FormURLEncoded` from `application/x-www-form-urlencoded`.
 decode :: String -> Maybe FormURLEncoded
 decode = map FormURLEncoded <<< traverse decodePart <<< String.split (Pattern "&")
   where
-    decodePart = String.split (Pattern "=") >>> case _ of
-      [k, v] -> (\key val -> Tuple key $ Just val) <$> decodeFormURLComponent k <*> decodeFormURLComponent v
-      [k]    -> Tuple <$> decodeFormURLComponent k <*> pure Nothing
-      _      -> Nothing
+  decodePart = String.split (Pattern "=") >>> case _ of
+    [ k, v ] -> (\key val -> Tuple key $ Just val) <$> decodeFormURLComponent k <*> decodeFormURLComponent v
+    [ k ] -> Tuple <$> decodeFormURLComponent k <*> pure Nothing
+    _ -> Nothing

test/Main.purs

@@ -16,14 +16,15 @@ main = do
 
   testDecode "this=this%3Dthis" (Just $ FormURLEncoded [ Tuple "this" $ Just "this=this" ])
 
-  testDecode "&x=x&&y=y&z=" $
-    Just $ FormURLEncoded
-      [ Tuple "" Nothing
-      , Tuple "x" $ Just "x"
-      , Tuple "" Nothing
-      , Tuple "y" $ Just "y"
-      , Tuple "z" $ Just ""
-      ]
+  testDecode "&x=x&&y=y&z="
+    $ Just
+    $ FormURLEncoded
+        [ Tuple "" Nothing
+        , Tuple "x" $ Just "x"
+        , Tuple "" Nothing
+        , Tuple "y" $ Just "y"
+        , Tuple "z" $ Just ""
+        ]
 
   testDecode "a=b&%8A=c" Nothing
 
@@ -34,23 +35,23 @@ main = do
   testEncode (FormURLEncoded [ Tuple "this" $ Just "this=this" ]) $ Just "this=this%3Dthis"
 
   testEncode
-    (FormURLEncoded
-      [ Tuple "" Nothing
-      , Tuple "x" $ Just "x"
-      , Tuple "" Nothing
-      , Tuple "y" $ Just "y"
-      , Tuple "z" $ Just ""
-      ])
+    ( FormURLEncoded
+        [ Tuple "" Nothing
+        , Tuple "x" $ Just "x"
+        , Tuple "" Nothing
+        , Tuple "y" $ Just "y"
+        , Tuple "z" $ Just ""
+        ]
+    )
     (Just "&x=x&&y=y&z=")
 
   testEncode (FormURLEncoded [ Tuple "a b" $ Just "aa bb" ]) $ Just "a+b=aa+bb"
 
   where
+  testDecode :: String -> Maybe FormURLEncoded -> Effect Unit
+  testDecode input expected =
+    (log $ "decode \"" <> input <> "\" == " <> show expected) *> assert (decode input == expected)
 
-    testDecode :: String -> Maybe FormURLEncoded -> Effect Unit
-    testDecode input expected =
-      (log $ "decode \"" <> input <> "\" == " <> show expected) *> assert (decode input == expected)
-
-    testEncode :: FormURLEncoded -> Maybe String -> Effect Unit
-    testEncode input expected =
-      (log $ "encode " <> show input <> " == \"" <> show expected <> "\"") *> assert (encode input == expected)
+  testEncode :: FormURLEncoded -> Maybe String -> Effect Unit
+  testEncode input expected =
+    (log $ "encode " <> show input <> " == \"" <> show expected <> "\"") *> assert (encode input == expected)