1	<?php
2
3	declare(strict_types=1);
4
5	/**
6	* Fast Forward Development Tools for PHP projects.
7	*
8	* This file is part of fast-forward/dev-tools project.
9	*
10	* @author   Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
11	* @license  https://opensource.org/licenses/MIT MIT License
12	*
13	* @see      https://github.com/php-fast-forward/
14	* @see      https://github.com/php-fast-forward/dev-tools
15	* @see      https://github.com/php-fast-forward/dev-tools/issues
16	* @see      https://php-fast-forward.github.io/dev-tools/
17	* @see      https://datatracker.ietf.org/doc/html/rfc2119
18	*/
19
20	namespace FastForward\DevTools\Project;
21
22	/**
23	* Resolves the effective documentation, testing, and wiki capabilities of the current repository.
24	*/
25	interface ProjectCapabilitiesResolverInterface
26	{
27	/**
28	* @var string the default project-relative test directory checked by repository capability discovery
29	*/
30	public const string DEFAULT_TESTS_PATH = './tests';
31
32	/**
33	* @var string the default project-relative guide directory checked by repository capability discovery
34	*/
35	public const string DEFAULT_GUIDE_DIRECTORY = 'docs';
36
37	/**
38	* @var string the default project-relative wiki target used for generated API wiki output
39	*/
40	public const string DEFAULT_WIKI_TARGET = '.github/wiki';
41
42	/**
43	* Resolves which documentation, testing, and wiki surfaces are available for the current repository.
44	*
45	* @param string $testsPath the project-relative tests directory to inspect
46	* @param string $guideDirectory the project-relative guide directory to inspect
47	* @param string $wikiTarget the project-relative wiki output target to inspect
48	*/
49	public function resolve(
50	string $testsPath = self::DEFAULT_TESTS_PATH,
51	string $guideDirectory = self::DEFAULT_GUIDE_DIRECTORY,
52	string $wikiTarget = self::DEFAULT_WIKI_TARGET,
53	): ProjectCapabilities;
54	}