Skip to content

RegisterDemoVaultCoverageSuiteParams

The parameters for registerDemoVaultCoverageSuite.

Import:

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

Signature:

export interface RegisterDemoVaultCoverageSuiteParams

Properties

PropertyTypeDescription
configInterfacesDemoVaultConfigInterfaceCoverageSpec[]The config interfaces whose options must each be demonstrated by their bare name.
docs?DemoVaultDocsCoverageSpecThe 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.
interfacesDemoVaultInterfaceCoverageSpec[]The interfaces whose members must each be demonstrated (and referenced without drift).
nonTrivialGuardDemoVaultNonTrivialGuardSpecThe guard that keeps the reflected surface non-trivial.
rootFolderstringThe absolute path of the plugin repo root. Callers typically pass getRootFolder() ?? process.cwd().

Links to this page: