lint_qmd

runner.lint_qmd(
    qmd_file,
    linter=None,
    custom_command=None,
    *,
    keep_temp_files=False,
    verbose=False,
    lint_non_exec=False,
)

Convert a .qmd file to .py, lint it, and clean up.

Parameters

Name Type Description Default
qmd_file str | Path Path to the .qmd file to process. required
linter str | None Name of the linter to run. None
custom_command str | None Custom command to run against generated .py file. None
keep_temp_files bool If True, retain the temporary .py file after linting. False
verbose bool If True, print detailed progress information. False
lint_non_exec bool If True, also lint non-executable Python code chunks. False

Returns

Name Type Description
int 0 on success, nonzero on error.