Type Alias: RootOptions

Documentation / @wtf/project-vitest / config / RootOptions

type RootOptions = object;

Defined in: packages/project-vitest/src/suite.ts:32

What the root config of a suite, rootConfig, integrationConfig or browserRootConfig, takes.

Properties

coverage?

readonly optional coverage?: object;

Defined in: packages/project-vitest/src/suite.ts:46

What --coverage measures: by default each source in the src of every package of folders, so a module no test loads counts, at 0%; a pattern of include replaces it. It leaves out the stories of each package, *.stories.*, and each package of skip; a pattern of exclude is left out besides.

exclude?

readonly optional exclude?: readonly string[];

include?

readonly optional include?: readonly string[];

---

folders?

readonly optional folders?: readonly string[];

Defined in: packages/project-vitest/src/suite.ts:39

The folders of the workspace that hold its packages, each package a project by its config file: ['packages'] by default.

---

junit?

readonly optional junit?: string;

Defined in: packages/project-vitest/src/suite.ts:62

The path of the JUnit report, from the root, of a repo that keeps it apart from the coverage: the suite’s own, as test-results.xml, in reportsDirectory by default.

---

projects?

readonly optional projects?: any[];

Defined in: packages/project-vitest/src/suite.ts:34

Projects of the run besides each package’s, added after them.

---

reportsDirectory?

readonly optional reportsDirectory?: string;

Defined in: packages/project-vitest/src/suite.ts:57

Where the JUnit report and the coverage go: reports by default.

---

skip?

readonly optional skip?: readonly string[];

Defined in: packages/project-vitest/src/suite.ts:55

The packages of folders the run leaves out, each by its folder from the root, as packages/site: no project of it runs, and the coverage measures none of its sources. None by default.