ProjectCapabilitiesResolverInterface
Interface
Resolves the effective documentation, testing, and wiki capabilities of the current repository.
Constants
= 'docs'
= './tests'
= '.github/wiki'
Methods
resolve()
: ProjectCapabilities
Resolves which documentation, testing, and wiki surfaces are available for the current repository.
Constants
public
string
DEFAULT_GUIDE_DIRECTORY
=
'docs'
Description
the default project-relative guide directory checked by repository capability discovery
public
string
DEFAULT_TESTS_PATH
=
'./tests'
Description
the default project-relative test directory checked by repository capability discovery
public
string
DEFAULT_WIKI_TARGET
=
'.github/wiki'
Description
the default project-relative wiki target used for generated API wiki output
Methods
Resolves which documentation, testing, and wiki surfaces are available for the current repository.
public
resolve([
string
$testsPath = self::DEFAULT_TESTS_PATH][,
string
$guideDirectory = self::DEFAULT_GUIDE_DIRECTORY][,
string
$wikiTarget = self::DEFAULT_WIKI_TARGET]) : ProjectCapabilities
Parameters
$testsPath
:
string
=
self::DEFAULT_TESTS_PATH
Description
the project-relative tests directory to inspect
$guideDirectory
:
string
=
self::DEFAULT_GUIDE_DIRECTORY
Description
the project-relative guide directory to inspect
$wikiTarget
:
string
=
self::DEFAULT_WIKI_TARGET
Description
the project-relative wiki output target to inspect