Skip to main content

Configuration — infr.toml

Infr uses TOML for project configuration. Create an infr.toml in your project root, or run infr init to generate one.

Full reference

infr.toml
[project]
name = "my-analysis"
r_version = "4.3" # Target R version for output

[check]
strictness = "moderate" # relaxed | moderate | strict
warn_implicit_any = true # Warn when a type can't be inferred
warn_unused_const = true # Warn on const bindings that are never read

[output]
dir = "R/" # Where to write transpiled .R files
preserve_comments = true # Keep comments in emitted R

[declarations]
include = [ # Additional .d.infr files
"types/dplyr.d.infr",
"types/ggplot2.d.infr"
]

Sections

[project]

KeyTypeDefaultDescription
namestringProject name
r_versionstringTarget R version

[check]

KeyTypeDefaultDescription
strictnessstring"relaxed"One of relaxed, moderate, strict
warn_implicit_anyboolfalseWarn when types can't be inferred
warn_unused_constboolfalseWarn on unused const bindings

[output]

KeyTypeDefaultDescription
dirstring"."Output directory for transpiled .R files
preserve_commentsbooltruePreserve comments in output

[declarations]

KeyTypeDefaultDescription
includearray[]Additional .d.infr declaration files to load