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\GitIgnore;
21
22	/**
23	* Defines the contract for merging .gitignore entries.
24	*
25	* This service SHALL combine canonical and project-specific .gitignore
26	* definitions into an ordered result. Canonical defaults MUST precede consumer
27	* rules. The merger MUST preserve pattern whitespace and repeated rules because
28	* Git resolves conflicts using the last matching pattern.
29	*/
30	interface MergerInterface
31	{
32	/**
33	* Merges two GitIgnore instances without changing consumer rule precedence.
34	*
35	* An already present canonical prefix MUST NOT be added again.
36	* The path from $project is used in the returned instance.
37	*
38	* @param GitIgnoreInterface $canonical the canonical .gitignore from dev-tools
39	* @param GitIgnoreInterface $project the project-specific .gitignore
40	*
41	* @return GitIgnoreInterface a new GitIgnore instance with merged entries
42	*/
43	public function merge(GitIgnoreInterface $canonical, GitIgnoreInterface $project): GitIgnoreInterface;
44	}