Readmix.Scopes.Defaults (readmix v0.8.0)

Copy Markdown

This is the default Readmix scope that provides variables to generator actions.

Every variable is defined as a function in this module. Refer to the functions documentation to see which variables are defined.

These variables are derived from the current Mix project. When Readmix runs outside of a Mix project (for instance in a standalone script), the variables whose value cannot be determined are simply not defined.

Summary

Functions

The current application version from mix.exs, or nil when running outside of a Mix project.

The OTP application atom (example: :readmix) of the current application, or nil when running outside of a Mix project.

Functions

app_vsn()

The current application version from mix.exs, or nil when running outside of a Mix project.

otp_app()

The OTP application atom (example: :readmix) of the current application, or nil when running outside of a Mix project.