RegisterDemoVaultCoverageSuiteParams

The parameters for registerDemoVaultCoverageSuite.

Import:

import type { RegisterDemoVaultCoverageSuiteParams } from 'obsidian-dev-utils/script-utils/demo-vault-coverage';

Signature:

export interface RegisterDemoVaultCoverageSuiteParams

Properties

Property	Type	Description
authoring?	DemoVaultAuthoringSpec	Tunes the always-on authoring checks, or undefined to take their defaults. It cannot disable them.
configInterfaces?	DemoVaultConfigInterfaceCoverageSpec[]	The config interfaces whose options must each be demonstrated by their bare name, or undefined when the plugin has no settings.
docs?	DemoVaultDocsCoverageSpec	The feature-doc linking check, or undefined when the plugin ships no docs/ folder.
functionModules?	DemoVaultFunctionsCoverageSpec[]	The modules whose export functions must each be demonstrated by their bare name, or undefined when the plugin exposes no such module to check.
interfaces?	DemoVaultInterfaceCoverageSpec[]	The interfaces whose members must each be demonstrated (and referenced without drift), or undefined when the plugin exposes no public API surface to reflect.
nonTrivialGuard?	DemoVaultNonTrivialGuardSpec	The guard that keeps the reflected surface non-trivial, or undefined when there is no reflected surface to guard. The vault is checked for being non-empty either way.
rootFolder	string	The absolute path of the plugin repo root. Callers typically pass getRootFolder() ?? process.cwd().

---

Links to this page:

• registerDemoVaultCoverageSuite