Expose and document ProjectData

This commit is contained in:
Jeroen Engels 2020-08-30 10:04:06 +02:00
parent 586bc20b47
commit 79decbc14c
2 changed files with 5 additions and 3 deletions

File diff suppressed because one or more lines are too long

View File

@ -15,7 +15,7 @@ module Review.Rule exposing
, Error, error, errorWithFix, ModuleKey, errorForModule, errorForModuleWithFix, ElmJsonKey, errorForElmJson, ReadmeKey, errorForReadme, errorForReadmeWithFix
, ReviewError, errorRuleName, errorMessage, errorDetails, errorRange, errorFixes, errorFilePath, errorTarget
, ignoreErrorsForDirectories, ignoreErrorsForFiles
, review, reviewV2, ruleName
, review, reviewV2, ProjectData, ruleName
, Required, Forbidden
)
@ -243,7 +243,7 @@ reason or seemingly inappropriately.
# Running rules
@docs review, reviewV2, ruleName
@docs review, reviewV2, ProjectData, ruleName
# Internals
@ -609,6 +609,8 @@ runReview ((Project p) as project) rules maybeProjectData nodeContexts =
}
{-| Internal cache about the project.
-}
type ProjectData
= ProjectData (ProjectRuleCache ScopeProjectContext)