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 * 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
20namespace FastForward\DevTools\GitAttributes;
21
22/**
23 * Filters canonical export-ignore candidates against consumer keep rules.
24 *
25 * Implementations MUST remove any candidate path explicitly configured to stay
26 * in the exported package archive, while preserving the order of the remaining
27 * candidates.
28 */
29interface ExportIgnoreFilterInterface
30{
31    /**
32     * Filters export-ignore candidates using the configured keep-in-export paths.
33     *
34     * @param list<string> $candidates the canonical candidate paths
35     * @param list<string> $keepInExportPaths the paths that MUST remain exportable
36     *
37     * @return list<string> the filtered export-ignore candidates
38     */
39    public function filter(array $candidates, array $keepInExportPaths): array;
40}