Implement --import-wrap options (#46)

* Implement --import-wrap options

* Update .tidyrc.json

* Pass option through from CLI.

Author: natefaubion

.tidyrc.json

@@ -1,4 +1,5 @@
 {
+  "importWrap": "source",
   "indent": 2,
   "operatorsFile": null,
   "ribbon": 1,

bin/Bin/FormatOptions.purs

@@ -13,10 +13,11 @@ import Data.Argonaut.Encode (assoc, encodeJson, extend)
 import Data.Either (Either)
 import Data.Maybe (Maybe(..), fromMaybe, maybe)
 import Data.Traversable (traverse)
-import PureScript.CST.Tidy (TypeArrowOption(..), UnicodeOption(..))
+import PureScript.CST.Tidy (ImportWrapOption(..), TypeArrowOption(..), UnicodeOption(..))
 
 type FormatOptions =
-  { indent :: Int
+  { importWrap :: ImportWrapOption
+  , indent :: Int
   , operatorsFile :: Maybe String
   , ribbon :: Number
   , typeArrowPlacement :: TypeArrowOption
@@ -26,7 +27,8 @@ type FormatOptions =
 
 defaults :: FormatOptions
 defaults =
-  { indent: 2
+  { importWrap: ImportWrapSource
+  , indent: 2
   , operatorsFile: Nothing
   , ribbon: 1.0
   , typeArrowPlacement: TypeArrowFirst
@@ -37,7 +39,17 @@ defaults =
 formatOptions :: ArgParser FormatOptions
 formatOptions =
   Arg.fromRecord
-    { indent:
+    { importWrap:
+        Arg.choose "import wrap"
+          [ Arg.flag [ "--import-wrap-source", "-iws" ]
+              "Imports are wrapped only when breaks are in the source.\nDefault. Works well with IDE imports."
+              $> ImportWrapSource
+          , Arg.flag [ "--import-wrap-auto", "-iwa" ]
+              "Imports are wrapped based on the `--width` option."
+              $> ImportWrapAuto
+          ]
+          # Arg.default defaults.importWrap
+    , indent:
         Arg.argument [ "--indent", "-i" ]
           "Number of spaces to use as indentation.\nDefaults to 2."
           # Arg.int
@@ -88,14 +100,16 @@ unicodeOption =
 fromJson :: Json -> Either JsonDecodeError FormatOptions
 fromJson json = do
   obj <- decodeJson json
+  importWrap <- traverse importWrapFromString =<< obj .:? "importWrap"
   indent <- obj .:? "indent"
   operatorsFile <- obj .:? "operatorsFile"
   ribbon <- obj .:? "ribbon"
   typeArrowPlacement <- traverse typeArrowPlacementFromString =<< obj .:? "typeArrowPlacement"
   unicode <- traverse unicodeFromString =<< obj .:? "unicode"
   width <- obj .:? "width"
   pure
-    { indent: fromMaybe defaults.indent indent
+    { importWrap: fromMaybe defaults.importWrap importWrap
+    , indent: fromMaybe defaults.indent indent
     , operatorsFile: operatorsFile <|> defaults.operatorsFile
     , ribbon: fromMaybe defaults.ribbon ribbon
     , typeArrowPlacement: fromMaybe defaults.typeArrowPlacement typeArrowPlacement
@@ -106,6 +120,7 @@ fromJson json = do
 toJson :: FormatOptions -> Json
 toJson options =
   jsonEmptyObject
+    # extend (assoc "importWrap" (importWrapToString options.importWrap))
     # extend (assoc "indent" options.indent)
     # extend (assoc "operatorsFile" (maybe jsonNull encodeJson options.operatorsFile))
     # extend (assoc "ribbon" options.ribbon)
@@ -136,3 +151,14 @@ unicodeToString = case _ of
   UnicodeSource -> "source"
   UnicodeAlways -> "always"
   UnicodeNever -> "never"
+
+importWrapFromString :: String -> Either JsonDecodeError ImportWrapOption
+importWrapFromString = case _ of
+  "source" -> pure ImportWrapSource
+  "auto" -> pure ImportWrapAuto
+  other -> throwError $ UnexpectedValue (Json.fromString other)
+
+importWrapToString :: ImportWrapOption -> String
+importWrapToString = case _ of
+  ImportWrapSource -> "source"
+  ImportWrapAuto -> "auto"

bin/Main.purs

@@ -290,7 +290,8 @@ formatCommand args operators contents = do
     ParseSucceeded ok -> do
       let
         opts = defaultFormatOptions
-          { operators = remapOperators operators ok
+          { importWrap = args.importWrap
+          , operators = remapOperators operators ok
           , typeArrowPlacement = args.typeArrowPlacement
           , unicode = args.unicode
           }
@@ -299,7 +300,8 @@ formatCommand args operators contents = do
       let
         opts =
           defaultFormatOptions
-            { operators = remapOperators operators ok
+            { importWrap = args.importWrap
+            , operators = remapOperators operators ok
             , typeArrowPlacement = args.typeArrowPlacement
             , unicode = args.unicode
             }
@@ -308,7 +310,8 @@ formatCommand args operators contents = do
       Left err.error
 
 type WorkerConfig =
-  { indent :: Int
+  { importWrap :: String
+  , indent :: Int
   , operatorsFile :: String
   , ribbon :: Number
   , typeArrowPlacement :: String
@@ -318,7 +321,8 @@ type WorkerConfig =
 
 toWorkerConfig :: FormatOptions -> WorkerConfig
 toWorkerConfig options =
-  { indent: options.indent
+  { importWrap: FormatOptions.importWrapToString options.importWrap
+  , indent: options.indent
   , operatorsFile: fromMaybe ".tidyoperators.default" options.operatorsFile
   , ribbon: options.ribbon
   , typeArrowPlacement: FormatOptions.typeArrowPlacementToString options.typeArrowPlacement
@@ -357,7 +361,10 @@ formatWorker = Worker.make \{ receive, reply, workerData: { shouldCheck, operato
 
       formatOptions :: FormatOptions
       formatOptions =
-        { indent: config.indent
+        { importWrap:
+            fromRight' (\_ -> unsafeCrashWith "Unknown importWrap value") do
+              FormatOptions.importWrapFromString config.importWrap
+        , indent: config.indent
         , operatorsFile: Nothing
         , ribbon: config.ribbon
         , typeArrowPlacement:

src/PureScript/CST/Tidy.purs

@@ -2,6 +2,7 @@ module PureScript.CST.Tidy
   ( FormatOptions
   , defaultFormatOptions
   , TypeArrowOption(..)
+  , ImportWrapOption(..)
   , Format
   , formatModule
   , formatDecl
@@ -45,11 +46,18 @@ data TypeArrowOption
 
 derive instance eqTypeArrowOption :: Eq TypeArrowOption
 
+data ImportWrapOption
+  = ImportWrapSource
+  | ImportWrapAuto
+
+derive instance eqImportWrapOption :: Eq ImportWrapOption
+
 type FormatOptions e a =
   { formatError :: e -> FormatDoc a
   , unicode :: UnicodeOption
   , typeArrowPlacement :: TypeArrowOption
   , operators :: PrecedenceMap
+  , importWrap :: ImportWrapOption
   }
 
 defaultFormatOptions :: forall e a. FormatError e => FormatOptions e a
@@ -58,6 +66,7 @@ defaultFormatOptions =
   , unicode: UnicodeSource
   , typeArrowPlacement: TypeArrowFirst
   , operators: Map.empty
+  , importWrap: ImportWrapSource
   }
 
 class FormatError e where
@@ -172,10 +181,17 @@ formatModule conf (Module { header: ModuleHeader header, body: ModuleBody body }
             anchor (foldMap (formatParenListNonEmpty NotGrouped formatExport conf) header.exports)
           `space`
             anchor (formatToken conf header."where")
-    , joinWithMap break (formatImportDecl conf) header.imports
+    , case conf.importWrap of
+        ImportWrapAuto ->
+          imports
+        ImportWrapSource ->
+          locally (_ { pageWidth = top, ribbonRatio = 1.0 }) imports
     , joinWithMap break (formatDecl conf) body.decls
     , foldr (formatComment leadingLineComment) mempty body.trailingComments
     ]
+  where
+  imports =
+    joinWithMap break (formatImportDecl conf) header.imports
 
 formatExport :: forall e a. Format (Export e) e a
 formatExport conf = case _ of

test/FormatDirective.purs

@@ -112,6 +112,7 @@ parseDirectivesFromModule (Module { header: ModuleHeader header, body }) =
         , operators: default.operators
         , unicode: opts.unicode
         , typeArrowPlacement: opts.typeArrowPlacement
+        , importWrap: opts.importWrap
         }
     }
     where

test/snapshots/ImportWrap.output

@@ -0,0 +1,56 @@
+module ImportWrap where
+
+import Test (Test, Test, Test, Test, Test, Test, Test, Test, Test)
+import Test
+  ( Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  )
+
+-- @format --import-wrap-auto --width 20
+module ImportWrap where
+
+import Test
+  ( Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  )
+import Test
+  ( Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  )
+
+-- @format --import-wrap-source --width 20
+module ImportWrap where
+
+import Test (Test, Test, Test, Test, Test, Test, Test, Test, Test)
+import Test
+  ( Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  , Test
+  )

test/snapshots/ImportWrap.purs

@@ -0,0 +1,7 @@
+-- @format --import-wrap-source --width 20
+-- @format --import-wrap-auto --width 20
+module ImportWrap where
+
+import Test (Test, Test, Test, Test, Test, Test, Test, Test, Test)
+import Test (Test, Test,
+  Test, Test, Test, Test, Test, Test, Test)