Relax UndesirableFunctions

Author: fsoikin

dist/npm/package.json

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

spago.yaml

@@ -51,7 +51,7 @@ package:
     dependencies:
       - spec-node
   publish:
-    version: 0.0.25
+    version: 0.0.26
     license: MIT
     location:
       githubOwner: collegevine

src/Whine/Core/UndesirableFunctions.purs

@@ -59,27 +59,26 @@ rule badFunctions = emptyRule { onExpr = onExpr }
         | Just mods <- Map.lookup { function } badFunctions -> -- This function is on the list of undesirables.
             currentModule \m -> do
               let report message = reportViolation { source: Just $ rangeOf e, message }
-              case findImport m mod function of
+                  importedFrom = explicitOrQualifiedImport m mod function <|> loneOpenImport m
+              case importedFrom of
                 Just imprt -> do -- Found whence this function is imported.
                   let message =
                         Map.lookup (Just imprt) mods -- See if we have a message for this specific import.
                         <|> Map.lookup Nothing mods -- If not, see if we have a module-agnostic message for this function.
                   report `traverse_` message
+
                 Nothing -> -- Couldn't find this function in any imports. It could have been imported via an "open" import.
-                  case Map.lookup Nothing mods of
-                    Just message -> -- Found a module-agnostic message for this function => report it.
-                      report message
-                    Nothing -> -- No message found for this function => report all messages just in case.
-                      report `traverse_` mods
+                  for_ (Map.lookup Nothing mods) \message -> -- Report a module-agnostic message for this function, if defined.
+                    report message
 
       _ -> do
         pure unit
 
     -- Look through imports in the header of the module and find one that either
     -- (1) is qualified with the given qualifier `mod` or (2) lists the given
     -- identifier `ident` among imported values or operators.
-    findImport :: ∀ e. Module e -> Maybe ModuleName -> String -> Maybe ModuleName
-    findImport (Module { header: ModuleHeader { imports } }) mod ident =
+    explicitOrQualifiedImport :: ∀ e. Module e -> Maybe ModuleName -> String -> Maybe ModuleName
+    explicitOrQualifiedImport (Module { header: ModuleHeader { imports } }) mod ident =
       imports # findMap \(ImportDecl i@{ module: Name { name } }) -> case i of
         { qualified: Just (_ /\ Name { name: qualifier }) }
           | Just qualifier == mod
@@ -96,6 +95,18 @@ rule badFunctions = emptyRule { onExpr = onExpr }
         sameIdentifier (ImportOp (Name { name: Operator op })) = op == ident
         sameIdentifier _ = false
 
+    loneOpenImport :: ∀ e. Module e -> Maybe ModuleName
+    loneOpenImport (Module { header: ModuleHeader { imports } }) =
+      let candidates =
+            imports # mapMaybe \(ImportDecl i@{ module: Name { name } }) -> case i of
+              { qualified: Nothing, names: Nothing } -> Just name
+              _ -> Nothing
+
+      in
+        case candidates of
+          [name] -> Just name
+          _ -> Nothing
+
 
 codec :: CJ.Codec Args
 codec =

test/Core/UndesirableFunctions.purs

@@ -34,21 +34,31 @@ spec = describe "UndesirableFunctions" do
       x = y fn3
     """
 
+  it "Assumes open-imported module if there is only one" do
+    hasViolations ["2:6-2:9" /\ "Do not use fn3 from Bad.Module"] """
+      import Bad.Module
+      import Another.Module (fn2)
+      x = y fn3
+    """
+
+  it "Does not assume open-imported module if there are several of them" do
+    hasViolations [] """
+      import Bad.Module
+      import Another.Module
+      x = y fn2
+    """
+
   it "Falls back to unqualified message when the import is open" do
     hasViolations ["1:6-1:9" /\ "Do not use fn3"] """
       import Some
       x = y fn3
     """
 
-  it "Reports all messages when no import and no unqualified message" do
-    hasViolations
-      [ "1:6-1:9" /\ "Do not use fn2 from Another.Module"
-      , "1:6-1:9" /\ "Do not use fn2 from Bad.Module"
-      ]
-      """
-        import Some
-        x = y fn2
-      """
+  it "Does not report when no import and no unqualified message" do
+    hasViolations [] """
+      import Some
+      x = y fn2
+    """
 
   it "Reports when imported with a qualifier" do
     hasViolations