use_test_helper: Create or edit a test helper file

In r-lib/usethis: Automate Package and Project Setup

Create or edit a test helper file

Description

This function creates (or opens) a test helper file, typically tests/testthat/helper.R. Test helper files are executed at the beginning of every automated test run and are also executed by load_all(). A helper file is a great place to define test helper functions for use throughout your test suite, such as a custom expectation.

Usage

use_test_helper(name = NULL, open = rlang::is_interactive())

Arguments

name	Can be used to specify the optional "SLUG" in tests/testthat/helper-SLUG.R.
open	Whether to open the file for interactive editing.

See Also

• use_test() to create a test file.

• The testthat vignette on special files vignette("special-files", package = "testthat").

Examples

## Not run: 
use_test_helper()
use_test_helper("mocks")

## End(Not run)

r-lib/usethis documentation built on Nov. 28, 2024, 7:11 a.m.