ReaderInterface

Defines the contract for reading .gitignore files from a storage location.

Implementations MUST load a .gitignore resource from the provided filesystem path and SHALL return a GitIgnoreInterface representation of its contents. Implementations SHOULD delegate parsing and normalization responsibilities to a dedicated domain object or parser when appropriate.

---

• Full name: \FastForward\DevTools\GitIgnore\ReaderInterface

Methods

read

Reads a .gitignore file from the specified filesystem path.

public read(string $gitignorePath): \FastForward\DevTools\GitIgnore\GitIgnoreInterface

The provided path MUST identify a readable .gitignore file. Implementations SHALL return a GitIgnoreInterface instance representing the contents read from that path.

Parameters:

Parameter	Type	Description
$gitignorePath	string	The filesystem path to the .gitignore file.

Return Value:

The loaded .gitignore representation.

---