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 * Merges export-ignore entries with existing .gitattributes content.
23 *
24 * This interface defines the contract for managing .gitattributes files,
25 * specifically handling the merging of canonical export-ignore rules with
26 * existing custom entries while removing obsolete generated markers and
27 * duplicate lines.
28 */
29interface MergerInterface
30{
31    /**
32     * Merges generated export-ignore entries with existing .gitattributes content.
33     *
34     * @param string $existingContent The current .gitattributes content.
35     * @param list<string> $exportIgnoreEntries The export-ignore entries to manage
36     * @param list<string> $keepInExportPaths The paths that MUST remain exported
37     *
38     * @return string The merged .gitattributes content
39     */
40    public function merge(string $existingContent, array $exportIgnoreEntries, array $keepInExportPaths = []): string;
41}