Configure how elm-review
runs.
You should not have to use this when writing a rule. This is only necessary if you wish to run elm-review
in a new
process like the CLI.
Internal.ReviewOptionsInternal
Represents the different options you can use to run the review process.
defaults : ReviewOptions
Somewhat arbitrary default options.
withDataExtraction : Basics.Bool -> ReviewOptions -> ReviewOptions
Enable or disable data extraction.
withLogger : Maybe (List ( String, Json.Encode.Value ) -> List ( String, Json.Encode.Value )) -> ReviewOptions -> ReviewOptions
Add a logger.
withSuppressedErrors : Dict ( String, String ) Basics.Int -> ReviewOptions -> ReviewOptions
Add suppressions from the suppressed folder.
withFixes : FixMode -> ReviewOptions -> ReviewOptions
Set the fix mode.
Internal.FixMode
Represents whether elm-review
should apply fixes found in the reported errors.
fixedDisabled : FixMode
Don't apply fixes.
fixesEnabledWithLimit : Basics.Int -> FixMode
Apply the fixes for every error whenever possible, but abort the whole review process once a number of errors have been fixed.
fixesEnabledWithoutLimits : FixMode
Apply the fixes for every error whenever possible.
withIgnoredFixes : ({ ruleName : String, filePath : String, message : String, details : List String, range : Elm.Syntax.Range.Range } -> Basics.Bool) -> ReviewOptions -> ReviewOptions
Provide a predicate for ignoring fixes to apply. This is useful to ignore previously refused fixes in elm-review --fix
.