Review.Project

Represents the contents of the project to be analyzed. This information will then be fed to the review rules.

You may need to use use this module if you want

to create test cases where the project is in a certain configuration
to make elm-review run in a new environment

You can safely ignore this module if you just want to write a review rule that does not look at project information (like the elm.json, dependencies, ...).

type alias Project =

Project

Holds all the information related to the project such as the contents of the elm.json file, the project modules and the project dependencies.

new : Project

Create a new empty Project.

For tests, you can also start of with a project that contains the elm/core dependency using Review.Test.Dependencies.projectWithElmCore. Some more prepared dependencies can be found in that same module.

Elm modules

type alias ProjectModule =

ProjectModule

Represents a parsed file.

addModule :

{ path : String

, source : String

}

-> Project

Add an Elm file to the project. If a file with the same path already exists, then it will replace it.

If the file is syntactically valid Elm code, it will then be analyzed by the review rules. Otherwise, the file will be added to the list of files that failed to parse, which you can get using modulesThatFailedToParse, and for which a parsing error will be reported when running the review function.

addParsedModule :

{ path : String

, source : String

, ast : File

}

-> Project

Add an already parsed module to the project. This module will then be analyzed by the rules.

removeModule : String -> Project -> Project

Remove a module from the project by its path.

modules : Project -> List ProjectModule

Get the list of modules in the project.

modulesThatFailedToParse :

Project

-> List

{ path : String

, source : String

}

Get the list of file paths that failed to parse because they were syntactically invalid Elm code.

`elm.json`

addElmJson :

{ path : String

, raw : String

, project : Project

}

-> Project

Add the content of the elm.json file to the project, making it available for rules to access using Review.Rule.withElmJsonModuleVisitor and Review.Rule.withElmJsonProjectVisitor.

The raw value should be the raw JSON as a string, and project corresponds to elm/project-metadata-utils's Elm.Project.Project type.

elmJson :

Project

-> Maybe

{ path : String

, raw : String

, project : Project

}

Get the contents of the elm.json file, if available.

This will give you a Elm.Project.Project type from the elm/project-metadata-utils package, so you will need to install and use it to gain access to the information from the elm.json file.

`README.md`

addReadme :

{ path : String

, content : String

}

-> Project

Add the content of the README.md file to the project, making it available for rules to access using Review.Rule.withReadmeModuleVisitor and Review.Rule.withReadmeProjectVisitor.

readme :

Project

-> Maybe

{ path : String

, content : String

}

Get the contents of the README.md file, if available.

Extra files

"Extra files" are files that elm-review doesn't load by default because they do not relate to Elm source files or Elm packages, that rules can then visit.

addExtraFiles : Dict String String -> Project -> Project

Add (or update) extra files to the project.

addExtraFile :

{ path : String

, source : String

}

-> Project

Add (or update) a single extra file to the project.

updateFile :

{ path : String

, source : String

}

-> Project

Update an existing file in the project. The file can be an Elm file of the project and/or an extra file.

removeExtraFile : String -> Project -> Project

Remove a single extra file from the project.

removeFile : String -> Project -> Project

Remove an existing file from the project. The file can be an Elm file of the project and/or an extra file.

extraFiles : Project -> Dict String String

Get the extra files in the project.

Project dependencies

addDependency : Dependency -> Project -> Project

Add a dependency to the project. These will be available for rules to make better assumptions on what is happening in the code.

Knowing the dependencies of the project will also help better parse the source files, since the dependencies will allow us to know the precedence and associativity of operators, which has an impact on the resulting AST when parsing a file.

For tests, elm-review comes with a few dependencies that you can find in Review.Test.Dependencies.

removeDependency : String -> Project -> Project

Remove a dependency from a project by name.

removeDependencies : Project -> Project

Remove all dependencies of a project. Use this to flush the dependencies of a project when they are changed, before re-adding them.

directDependencies : Project -> Dict String Dependency

Get the direct dependencies of the project.

dependencies : Project -> Dict String Dependency

Get the dependencies of the project.

Diffing

type Diff

= Edited

{ before : String

, after : String

}

| Removed

The kind of change associated to a file. A file was either edited or removed.

diffV2 :

{ before : Project

, after : Project

}

-> List

{ path : String

, diff : Diff

}

Get the files that have been modified between two versions of a Project.

Includes removed files but added files are ignored.

diff :

{ before : Project

, after : Project

}

-> List

{ path : String

, before : String

, after : String

}

Get the files that have been modified between two versions of a Project.

Added or removed files are ignored.

Deprecated

precomputeModuleGraph : Project -> Project

Precomputes the module graph.

@deprecated This is not useful anymore.

jfmengels/elm-review/2.16.6

Review.Project

Elm modules

`elm.json`

`README.md`

Extra files

Project dependencies

Diffing

Deprecated

Modules