Integrate PSA into spago (#955)

Author: JordanMartinez

spaghetto/README.md

@@ -222,6 +222,8 @@ When ran from the directory `foo`, Spago will search for a "workspace" config fi
 
 At the end of this process, `foo` and `baz` are the only packages considered.
 
+</details>
+
 ### `spago.yml` fields and their meaning
 
 ```yml
@@ -238,11 +240,49 @@ package:
     # One of three options
     #   1. just the package
     - packageName
-    #   2. the package, using the widest possible vesrion range
+    #   2. the package, using the widest possible version range
     - packageName: "*"
-    #   2. the package, using a specified vesrion range
+    #   2. the package, using a specified version range
     - packageName: ">=1.1.1 <2.0.0"
 
+# optional
+  build:
+    # optional, whether to censor warnings from dependency sources,
+    # project sources, both, or none
+    censorBuildWarnings: 
+      # one of 4 values:
+      #   1. Both
+      "all"
+      #   2. dependency only
+      "dependency"
+      #   3. project only
+      "project"
+      #   4. do not censor warnings
+      "none"
+    # optional, NonEmptyArray, censor specific codes
+    censorCodes:
+      - ShadowedName
+    # optional, NonEmptyArray, only show specific codes
+    filterCodes:
+      - ShadowedName
+    # optional, whether to show statistics at the end
+    # of warning/error output and how much informaiton
+    statVerbosity:
+      # One of 3 values
+      #   1. Don't show it
+      "no-stats"
+      #   2. Show it and only sum the total warnings/errors
+      "compact-stats"
+      #   3. Show it and show total warnings/errors by code
+      "verbose-stats"
+    # optional, boolean, whether to show the source code
+    # corresponding to the error's location
+    showSource: true
+    # optional, boolean, counts compiler warnings as compiler errors
+    strict: false
+    # optional, Boolean String, persist compiler warnings
+    stash: true
+
 # optional
   bundle:
     # optional, Boolean, whether to minify
@@ -345,6 +385,10 @@ workspace:
     output: "output"
     # optional, Boolean, fail the build if `spago.yml` has redundant/missing packages
     pedantic_packages: false
+    # All of the Package's `buildOptions` fields (e.g. `strict` as shown below)
+    # can also go here. Any specified here will be used
+    # if the selected package doesn't specify that option in its configuration
+    strict: false
 ```
 
 ### FAQs

spaghetto/bin/src/Flags.purs

@@ -4,13 +4,76 @@ import Spago.Prelude
 
 import ArgParse.Basic (ArgParser)
 import ArgParse.Basic as ArgParser
+import Data.Set.NonEmpty (NonEmptySet)
+import Data.Set.NonEmpty as NonEmptySet
+import Spago.Core.Config (ShowSourceCode(..))
+import Spago.Core.Config as Core
 
 selectedPackage ∷ ArgParser (Maybe String)
 selectedPackage =
   ArgParser.argument [ "--package", "-p" ]
     "Select the local project to build"
     # ArgParser.optional
 
+strict ∷ ArgParser (Maybe Boolean)
+strict =
+  ArgParser.flag [ "--strict" ]
+    "Promotes project sources' warnings to errors"
+    # ArgParser.boolean
+    # ArgParser.optional
+
+censorBuildWarnings ∷ ArgParser (Maybe Core.CensorBuildWarnings)
+censorBuildWarnings =
+  ArgParser.argument [ "--censor-build-warnings" ]
+    "Censor compiler warnings based on file's location: 'dependency', 'project', or 'all'"
+    # ArgParser.unformat "ARG"
+        ( case _ of
+            "all" -> Right Core.CensorAllWarnings
+            "project" -> Right Core.CensorProjectWarnings
+            "dependency" -> Right Core.CensorDependencyWarnings
+            _ -> Left $ "Expected 'all', 'project', or 'dependency'"
+        )
+    # ArgParser.optional
+
+showSource ∷ ArgParser (Maybe ShowSourceCode)
+showSource =
+  NoSourceCode
+    <$ ArgParser.flag [ "--no-source" ]
+      "Disable original source code printing"
+    # ArgParser.optional
+
+censorCodes :: ArgParser (Maybe (NonEmptySet String))
+censorCodes =
+  ArgParser.argument [ "--censor-code" ]
+    "Censor a specific error code (e.g. `ShadowedName`)"
+    # ArgParser.many
+    <#> NonEmptySet.fromFoldable
+
+filterCodes :: ArgParser (Maybe (NonEmptySet String))
+filterCodes =
+  ArgParser.argument [ "--filter-code" ]
+    "Only show a specific error code (e.g. `TypesDoNotUnify`)"
+    # ArgParser.many
+    <#> NonEmptySet.fromFoldable
+
+statVerbosity :: ArgParser (Maybe Core.StatVerbosity)
+statVerbosity = ArgParser.optional $ ArgParser.choose "StatVerbosity"
+  [ Core.VerboseStats <$ ArgParser.flag [ "--verbose-stats" ] "Show counts for each warning type"
+  , Core.NoStats <$ ArgParser.flag [ "--censor-stats" ] "Censor warning/error summary"
+  ]
+
+persistWarnings ∷ ArgParser (Maybe Boolean)
+persistWarnings =
+  ArgParser.flag [ "--persist-warnings" ] "Persist the compiler warnings between multiple underlying `purs compile` calls"
+    # ArgParser.boolean
+    # ArgParser.optional
+
+jsonErrors ∷ ArgParser Boolean
+jsonErrors =
+  ArgParser.flag [ "--json-errors" ]
+    "Output compiler warnings/errors as JSON"
+    # ArgParser.boolean
+
 minify ∷ ArgParser Boolean
 minify =
   ArgParser.flag [ "--minify" ]
@@ -63,7 +126,7 @@ verbose =
 
 noColor ∷ ArgParser Boolean
 noColor =
-  ArgParser.flag [ "--no-color" ]
+  ArgParser.flag [ "--no-color", "--monochrome" ]
     "Force logging without ANSI color escape sequences"
     # ArgParser.boolean
     # ArgParser.default false
@@ -92,7 +155,7 @@ pedanticPackages =
 pursArgs ∷ ArgParser (List String)
 pursArgs =
   ArgParser.argument [ "--purs-args" ]
-    "Arguments to pass to purs compile. Wrap in quotes."
+    "Arguments to pass to purs compile. Wrap in quotes. `--output` and `--json-errors` must be passed to Spago directly."
     # ArgParser.many
 
 execArgs :: ArgParser (Maybe (Array String))