Refactor traversal logic, add ModuleQualifiers rule (#4)

Author: fsoikin

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
 
     - uses: actions/setup-node@v2
       with:
-        node-version: 20
+        node-version: 24
 
     - run: npm install
     - run: npx spago build

bootstrap/src/Cache.purs

@@ -22,7 +22,7 @@ import Node.ChildProcess.Types as StdIO
 import Node.Path as NodePath
 import Partial.Unsafe (unsafePartial)
 import Spago.Generated.BuildInfo as BuildInfo
-import Whine.Bootstrap.Execa (execResultSuccessOrDie, execSuccessOrDie_, execa)
+import Whine.Bootstrap.Execa (execSuccessOrDie, execSuccessOrDie_, execa)
 import Whine.Bootstrap.Hash (hashString)
 import Whine.Bootstrap.JsonCodecs as J
 import Whine.Runner.Config (PackageSpec(..))
@@ -106,6 +106,7 @@ rebuildCache { rulePackages, bundleFile } = do
   let mainModule = "Main" <> unique
       packageName = "whine-cached-bootstrap"
       dependencies = Map.union rulePackages (uncurry Map.singleton whineCorePackage)
+      entryPointFile = cacheDir <> "/src/Main.purs"
 
   FS.mkDirP (cacheDir <> "/src")
   FS.writeFile (cacheDir <> "/package.json") "{}"
@@ -150,15 +151,14 @@ rebuildCache { rulePackages, bundleFile } = do
       , "vscode-languageserver"
       , "vscode-languageserver-textdocument"
       ]
-      _
-        { cwd = Just cacheDir
-        , stdout = Just StdIO.pipe
-        , stderr = Just StdIO.pipe
-        }
+      inCacheDirAndPipeOutputs
 
   logSameLine "Making a pitiful face..."
   logDebug "Installed NPM dependencies"
 
+  whenM (FS.exists entryPointFile) $
+    FS.unlink entryPointFile # tryOrDie
+
   moduleGraphJson <- spagoGraphModules
   moduleGraph <- moduleGraphJson # JSON.parse # lmap DecodeError.basic >>= J.decode moduleGraphCodec # rightOrDie
   logDebug "Obtained dependency module graph"
@@ -176,18 +176,14 @@ rebuildCache { rulePackages, bundleFile } = do
             inferredModule = Map.lookup package candidateModules
         pure $ specifiedModule <|> inferredModule
 
-  FS.writeFile (cacheDir <> "/src/Main.purs") $
+  FS.writeFile entryPointFile $
     cachedBundleMainModule { moduleName: mainModule, ruleModules }
 
   logSameLine "Revisiting complaints..."
   logDebug "Wrote executable entry point"
 
   execSuccessOrDie_ "spago bundle" =<<
-    execa "npx" ["spago", "bundle", "--source-maps"] _
-      { cwd = Just cacheDir
-      , stdout = Just StdIO.pipe
-      , stderr = Just StdIO.pipe
-      }
+    execa "npx" ["spago", "bundle", "--source-maps"] inCacheDirAndPipeOutputs
 
   logSameLine "Done, ready to whine."
   logDebug "Bundled the executable"
@@ -203,30 +199,23 @@ rebuildCache { rulePackages, bundleFile } = do
       logInfo $ prefix <> msg
 
     spagoGraphModules = do
-      proc <-
-        execa "npx" ["spago", "graph", "modules", "--json"] _
-          { cwd = Just cacheDir
-          , stdout = Just StdIO.pipe
-          , stderr = Just StdIO.pipe
-          }
-
-      res <- liftAff proc.getResult
-
-      unless (res.exitCode == Just 0) do
-        logDebug "'spago graph modules' failed. Trying to build to see what the error was..."
-        FS.writeFile (cacheDir <> "/src/Main.purs") "module M where\nx = 42 :: Int"
-        execSuccessOrDie_ "spago build" =<<
-          execa "npx" ["spago", "build"] _
-            { cwd = Just cacheDir
-            , stdout = Just StdIO.pipe
-            , stderr = Just StdIO.pipe
-            }
-
-        logDebug "Building succeeded, but 'spago graph modules' still failed."
-        execResultSuccessOrDie "spago graph modules" res
+      -- First build to make sure all modules are fresh, in case we just
+      -- overwrote a previous config that was somehow incompatible.
+      execSuccessOrDie_ "spago build" =<<
+        execa "npx" ["spago", "build"] inCacheDirAndPipeOutputs
+
+      -- Then get the module graph.
+      res <- execSuccessOrDie "spago graph modules" =<<
+        execa "npx" ["spago", "graph", "modules", "--json"] inCacheDirAndPipeOutputs
 
       pure res.stdout
 
+    inCacheDirAndPipeOutputs = _
+      { cwd = Just cacheDir
+      , stdout = Just StdIO.pipe
+      , stderr = Just StdIO.pipe
+      }
+
 whineCorePackage :: { package :: String } /\ PackageSpec
 whineCorePackage = { package: "whine-core" } /\ PackageVersion version
   where

dist/npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whine",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "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.32",
+  "version": "0.0.33",
   "repository": "https://github.com/collegevine/purescript-whine",
   "engines": {
     "vscode": "^1.95.0"

integration-tests/cases/1-local-rules/src/WhineRules.purs

@@ -7,16 +7,12 @@ import JSON (JSON)
 import JSON as JSON
 import PureScript.CST.Types (Module(..), ModuleHeader(..), ModuleName(..), Name(..))
 import Whine.Log (logInfo)
-import Whine.Types (Handle(..), Rule, RuleFactories, currentModule, emptyRule, ruleFactory)
+import Whine.Types (Rule(..), RuleFactories, ruleFactory)
 
 rules :: RuleFactories
 rules = [ruleFactory "LocalRule" CJ.json localRule]
 
 localRule :: JSON -> Rule
-localRule config = emptyRule { onModule = onModule }
-  where
-    onModule :: Handle Module
-    onModule = Handle \_ ->
-      currentModule \(Module { header: ModuleHeader { name: Name { name: ModuleName n } } }) -> do
-        logInfo $ "Local rule configured with '" <> JSON.print config <> "' is running on " <> n
-        pure unit
+localRule config = Rule \(Module { header: ModuleHeader { name: Name { name: ModuleName n } } }) -> do
+  logInfo $ "Local rule configured with '" <> JSON.print config <> "' is running on " <> n
+  pure unit

integration-tests/cases/1-local-rules/with-local-rule-changed.txt

@@ -18,4 +18,4 @@ Local rule changed configured with '{"foo":"bar","baz":42}' is running on Local.
 <TIMESTAMP>: Parsing src/Main.purs
 <TIMESTAMP>: Parsed src/Main.purs, running rules
 Local rule changed configured with '{"foo":"bar","baz":42}' is running on Main
-No violations found.
+No violations found.

integration-tests/cases/1-local-rules/with-local-rule-config-debug.txt

@@ -5,4 +5,4 @@ Local rule configured with '{"foo":"bar","baz":42}' is running on Local.WhineRul
 <TIMESTAMP>: Parsing src/Main.purs
 <TIMESTAMP>: Parsed src/Main.purs, running rules
 Local rule configured with '{"foo":"bar","baz":42}' is running on Main
-No violations found.
+No violations found.

integration-tests/cases/2-multirules/output.txt

@@ -1,12 +1,17 @@
-src/B.purs:4:5:  UndesirableFunctions/foo: Function g should not be used
+src/B.purs:5:7:  CommaFirstArrays: Format array literals comma-first, align items vertically
 
-    4: y = g 1
+    5: z = h [2,
+    6:   3]
 
 src/B.purs:5:5:  UndesirableFunctions/bar: Function h should not be used
 
     5: z = h [2,
 
-src/B.purs:5:7:  CommaFirstArrays: Format array literals comma-first, align items vertically
+src/B.purs:4:5:  UndesirableFunctions/foo: Function g should not be used
+
+    4: y = g 1
+
+src/A.purs:5:7:  CommaFirstArrays: Format array literals comma-first, align items vertically
 
     5: z = h [2,
     6:   3]
@@ -18,9 +23,4 @@
 src/A.purs:5:5:  UndesirableFunctions/bar: Function h should not be used
 
     5: z = h [2,
-
-src/A.purs:5:7:  CommaFirstArrays: Format array literals comma-first, align items vertically
-
-    5: z = h [2,
-    6:   3]