Short output format

Author: fsoikin

dist/npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whine",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "PureScript linter, extensible, with configurable rules, and one-off escape hatches",
   "keywords": ["purescript", "lint"],
   "author": "Fyodor Soikin <name.fa@gmail.com>",

dist/vscode-extension/package.json

@@ -3,7 +3,7 @@
   "publisher": "collegevine",
   "displayName": "Whine at PureScript",
   "description": "PureScript linter, extensible, with configurable rules, and one-off escape hatches",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "repository": "https://github.com/collegevine/purescript-whine",
   "engines": {
     "vscode": "^1.95.0"

spago.yaml

@@ -48,7 +48,7 @@ package:
     main: Test.Main
     dependencies: []
   publish:
-    version: 0.0.21
+    version: 0.0.22
     license: MIT
     location:
       githubOwner: collegevine

src/Whine/Print.purs

@@ -6,19 +6,23 @@ import Ansi.Codes (Color(..))
 import Ansi.Output (foreground, withGraphics)
 import Data.String as String
 import Data.String.Utils (padStart')
+import Whine.Runner.Cli (OutputFormat(..))
 import Whine.Types (Violation, WithFile, WithMuted, WithRule)
 
-printViolation :: Violation (WithRule + WithMuted + WithFile + ()) -> Maybe String
-printViolation { muted: true } = Nothing
-printViolation { source, message, rule, file } = Just text
+type Args r = { outputFormat :: OutputFormat | r }
+
+printViolation :: ∀ r. Args r -> Violation (WithRule + WithMuted + WithFile + ()) -> Maybe String
+printViolation _ { muted: true } = Nothing
+printViolation args { source, message, rule, file } = Just text
   where
-    text = fold
-      [ withGraphics (foreground Cyan) file.path, ":"
-      , locationText
-      , withGraphics (foreground Red) rule, ": "
-      , message, "\n"
-      , withGraphics (foreground BrightYellow) sourceText
-      ]
+    text =
+      case args.outputFormat of
+        Short -> fileLocation <> " " <> ruleAndMessage
+        Long -> fileLocation <> " " <> ruleAndMessage <> "\n" <> sourceCode
+      where
+        fileLocation = fold [withGraphics (foreground Cyan) file.path, ":", locationText]
+        ruleAndMessage = fold [withGraphics (foreground Red) rule, ": ", message]
+        sourceCode = withGraphics (foreground BrightYellow) sourceText
 
     indent = "  "
 

src/Whine/Runner/Cli.purs

@@ -19,12 +19,17 @@ data Command
   = JustWhine JustWhineArgs
   | LanguageServer LanguagServerArgs
 
-type JustWhineArgs = { globs :: Maybe (NonEmptyArray NonEmptyString) }
+type JustWhineArgs =
+  { globs :: Maybe (NonEmptyArray NonEmptyString)
+  , outputFormat :: OutputFormat
+  }
 
 type LanguagServerArgs = { checkWhen :: CheckFileWhen }
 
 data CheckFileWhen = CheckOnSave | CheckOnChange
 
+data OutputFormat = Short | Long
+
 parseCliArgs :: ∀ m. MonadEffect m => m Args
 parseCliArgs = liftEffect $
   O.customExecParser
@@ -47,8 +52,10 @@ justWhineArgsParser = ado
     [ O.metavar "GLOB"
     , O.help "Glob patterns to match files to lint. When empty, all files are linted."
     ]
+  outputFormat <- outputFormatOption
   in
     { globs: NEA.fromFoldable $ List.mapMaybe NES.fromString args
+    , outputFormat: fromMaybe Long outputFormat
     }
 
 languageServerArgsParser :: O.Parser LanguagServerArgs
@@ -92,12 +99,18 @@ quietFlag =
     , O.help "Print no output"
     ]
 
-languageServerFlag :: O.Parser Boolean
-languageServerFlag =
-  O.switch $ fold
-    [ O.long "language-server"
-    , O.help "Start Whine as a language server"
+outputFormatOption :: O.Parser (Maybe OutputFormat)
+outputFormatOption =
+  OT.optional $ O.option parseOutputFormat $ fold
+    [ O.long "output"
+    , O.short 'o'
+    , O.help "Output format. Possible values are 'short' and 'long'. Default is 'long'."
     ]
+  where
+    parseOutputFormat = O.eitherReader \s -> do
+      if s == "short" then Right Short
+      else if s == "long" then Right Long
+      else Left $ "Invalid output format: " <> s
 
 determineLogLevel :: Args -> LogSeverity
 determineLogLevel args =

src/Whine/Runner/Runner.purs

@@ -27,9 +27,9 @@ runWhineAndPrintResultsAndExit factories = launchAff_ do
   let env = { logLevel: Cli.determineLogLevel args }
 
   case args.command of
-    Cli.JustWhine { globs } -> do
+    Cli.JustWhine justWhineArgs@{ globs } -> do
       results <- runWhine { factories, globs, configFile: "whine.yaml", env }
-      let output = printViolation `mapMaybe` results
+      let output = nub $ printViolation justWhineArgs `mapMaybe` results
       unless args.quiet do
         Console.log `traverse_` output
         when (null output) $ Console.log "No violations found."