Add Rule.withModuleNameNode

jfmengels · Apr 28, 2022 · 0fe88c9 · 0fe88c9
1 parent d17d995
commit 0fe88c9
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/docs.json b/docs.json
diff --git a/src/Review/Rule.elm b/src/Review/Rule.elm
@@ -13,7 +13,7 @@ module Review.Rule exposing
     , withFinalModuleEvaluation
     , withElmJsonModuleVisitor, withReadmeModuleVisitor, withDependenciesModuleVisitor
     , ProjectRuleSchema, newProjectRuleSchema, fromProjectRuleSchema, withModuleVisitor, withModuleContext, withModuleContextUsingContextCreator, withElmJsonProjectVisitor, withReadmeProjectVisitor, withDependenciesProjectVisitor, withFinalProjectEvaluation, withContextFromImportedModules
-    , ContextCreator, initContextCreator, isInSourceDirectories, withModuleName, withFilePath, withModuleNameLookupTable, withModuleKey, withSourceCodeExtractor
+    , ContextCreator, initContextCreator, isInSourceDirectories, withModuleName, withModuleNameNode, withFilePath, withModuleNameLookupTable, withModuleKey, withSourceCodeExtractor
     , Metadata, moduleNameFromMetadata, moduleNameNodeFromMetadata, withMetadata
     , Error, error, errorWithFix, ModuleKey, errorForModule, errorForModuleWithFix, ElmJsonKey, errorForElmJson, errorForElmJsonWithFix, ReadmeKey, errorForReadme, errorForReadmeWithFix
     , globalError, configurationError
@@ -224,7 +224,7 @@ first, as they are in practice a simpler version of project rules.
 
 ## Requesting more information
 
-@docs ContextCreator, initContextCreator, isInSourceDirectories, withModuleName, withFilePath, withModuleNameLookupTable, withModuleKey, withSourceCodeExtractor
+@docs ContextCreator, initContextCreator, isInSourceDirectories, withModuleName, withModuleNameNode, withFilePath, withModuleNameLookupTable, withModuleKey, withSourceCodeExtractor
 @docs Metadata, moduleNameFromMetadata, moduleNameNodeFromMetadata, withMetadata
 
 
@@ -5070,6 +5070,27 @@ withModuleName (ContextCreator fn requestedData) =
         requestedData
 
 
+{-| Request the node corresponding to the name of the module.
+
+    contextCreator : Rule.ContextCreator () Context
+    contextCreator =
+        Rule.initContextCreator
+            (\moduleNameNode () ->
+                { moduleNameNode = moduleNameNode
+
+                -- ...other fields
+                }
+            )
+            |> Rule.withModuleNameNode
+
+-}
+withModuleNameNode : ContextCreator (Node ModuleName) (from -> to) -> ContextCreator from to
+withModuleNameNode (ContextCreator fn requestedData) =
+    ContextCreator
+        (\data -> fn data (moduleNameNodeFromMetadata data.metadata))
+        requestedData
+
+
 {-| Requests the module name lookup table for the types and functions inside a module.
 
 When encountering a `Expression.FunctionOrValue ModuleName String` (among other nodes where we refer to a function or value),