1	<?php
2
3	declare(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
19	namespace FastForward\DevTools\GitIgnore;
20
21	/**
22	* Defines the contract for reading .gitignore files from a storage location.
23	*
24	* Implementations MUST load a .gitignore resource from the provided filesystem
25	* path and SHALL return a GitIgnoreInterface representation of its contents.
26	* Implementations SHOULD delegate parsing and normalization responsibilities to
27	* a dedicated domain object or parser when appropriate.
28	*/
29	interface ReaderInterface
30	{
31	/**
32	* Reads a .gitignore file from the specified filesystem path.
33	*
34	* The provided path MUST identify a readable .gitignore file. Implementations
35	* SHALL return a GitIgnoreInterface instance representing the contents read
36	* from that path.
37	*
38	* @param string $gitignorePath The filesystem path to the .gitignore file.
39	*
40	* @return GitIgnoreInterface The loaded .gitignore representation.
41	*/
42	public function read(string $gitignorePath): GitIgnoreInterface;
43	}