jfmengels/elm-review
1
1
Fork 0
mirror of https://github.com/jfmengels/elm-review.git synced 2024-12-24 18:23:09 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation for Review.Rule

Browse Source
This commit is contained in:
Jeroen Engels 2020-02-11 22:09:11 +01:00
parent f28b7698d7
commit fb8fda2450
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/Review/Rule.elm
View File

@ -15,9 +15,14 @@ module Review.Rule exposing
# How does it work?
`elm-review` turns the code of the analyzed module into an [Abstract Syntax Tree (AST)](https://en.wikipedia.org/wiki/Abstract_syntax_tree)
`elm-review` reads the `elm.json`, dependencies and the modules from your project,
and turns each module into an [Abstract Syntax Tree (AST)](https://en.wikipedia.org/wiki/Abstract_syntax_tree)
(a tree-like structure which represents your source code) using the
[`elm-syntax` package](https://package.elm-lang.org/packages/stil4m/elm-syntax/latest/).
`elm-review` then feeds all this data into `review rules` that then report problems.
The way that review rules consume the data depends on its type, a "module rule" or "project rule".
Then, for each module and rule, it will give the details of your project (like the `elm.json` file) and the
contents of the file to analyze to the rule. The order in which things get passed to the rule is the following:
@ -31,8 +36,8 @@ contents of the file to analyze to the rule. The order in which things get passe
- The list of declarations, visited by [`withDeclarationListVisitor`](#withDeclarationListVisitor)
- Each declaration, visited by [`withSimpleDeclarationVisitor`](#withSimpleDeclarationVisitor) and [`withDeclarationVisitor`](#withDeclarationVisitor).
Before evaluating the next declaration, the expression contained in the declaration
will be visited recursively using by [`withSimpleExpressionVisitor`](#withSimpleExpressionVisitor) and [`withExpressionVisitor`](#withExpressionVisitor)
- A final evaluation is made when the whole AST has been traversed, using [`withFinalModuleEvaluation`](#withFinalModuleEvaluation)
will be visited recursively by [`withSimpleExpressionVisitor`](#withSimpleExpressionVisitor) and [`withExpressionVisitor`](#withExpressionVisitor)
- A final evaluation is made when the module has fully been visited, using [`withFinalModuleEvaluation`](#withFinalModuleEvaluation)
Evaluating a node means two things: