lue-bird/elm-review-mini/1.0.0

NOTE: the latest version is 1.0.1

Review.Cli

{ configuration :
{ reviews : List Review
, extraPaths : List String
}
, toJs : Value -> Cmd Never
, fromJs : (Value -> ProgramEvent) -> Sub ProgramEvent
}
-> Program

Run reviews, re-running on file changes. To be used from a node.js CLI program as showcased in elm-review-mini-cli-starter

type alias Program =

An elm worker produced by Review.Cli.Program

If you experience a high memory footprint in a large project, please open an issue called "only ask for file sources to generate local error displays".

That's all you need to know. Below are the internal types if you're interested:

= InitialFilesReceived
{ elmJson :
{ source : String
, project : Project
}
, directDependencies :
List
{ elmJson : Project
, docsJson : List Module
}
, extraFiles :
List
{ path : String
, source : String
}
, modules :
List
{ path : String
, source : String
}
}
| ModuleAddedOrChanged
{ path : String
, source : String
}
| ModuleRemoved { path : String }
| ExtraFileAddedOrChanged
{ path : String
, source : String
}
| ExtraFileRemoved { path : String }
| ErrorFixRejected
| JsEventJsonFailedToDecode Error

elm msg of a Review.Cli.program

= WaitingForInitialFiles
| HavingRunReviewsPreviously
{ nextRuns : List Run
, availableErrorsOnReject :
Dict
String
(List
{ range : Range
, message : String
, details : List String
, fixEditsByPath : Dict String (List SourceEdit)
}
)
, elmJson :
{ source : String
, project : Project
}
, filesByPath : Dict String String
}

elm model of a Review.program