Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3declare(strict_types=1);
4
5/**
6 * This file is part of fast-forward/dev-tools.
7 *
8 * This source file is subject to the license bundled
9 * with this source code in the file LICENSE.
10 *
11 * @copyright Copyright (c) 2026 Felipe SayĆ£o Lobato Abreu <github@mentordosnerds.com>
12 * @license   https://opensource.org/licenses/MIT MIT License
13 *
14 * @see       https://github.com/php-fast-forward/dev-tools
15 * @see       https://github.com/php-fast-forward
16 * @see       https://datatracker.ietf.org/doc/html/rfc2119
17 */
18
19namespace FastForward\DevTools\GitAttributes;
20
21/**
22 * Provides the canonical list of candidate paths for export-ignore rules.
23 *
24 * This interface defines the contract for classes that provide the baseline
25 * set of files and directories that should typically be excluded from
26 * Composer package archives.
27 */
28interface CandidateProviderInterface
29{
30    /**
31     * Returns the list of folder paths that are candidates for export-ignore.
32     *
33     * @return list<string> Folder paths in canonical form (e.g., "/.github/")
34     */
35    public function folders(): array;
36
37    /**
38     * Returns the list of file paths that are candidates for export-ignore.
39     *
40     * @return list<string> File paths in canonical form (e.g., "/.editorconfig")
41     */
42    public function files(): array;
43
44    /**
45     * Returns all candidates as a combined list with folders first, then files.
46     *
47     * @return list<string> All candidates in deterministic order
48     */
49    public function all(): array;
50}