Skip to content

CandidateProviderInterface

github-actions edited this page Apr 11, 2026 · 1 revision

Provides the canonical list of candidate paths for export-ignore rules.

This interface defines the contract for classes that provide the baseline set of files and directories that should typically be excluded from Composer package archives.


  • Full name: \FastForward\DevTools\GitAttributes\CandidateProviderInterface

Methods

folders

Returns the list of folder paths that are candidates for export-ignore.

public folders(): list<string>

Return Value:

Folder paths in canonical form (e.g., "/.github/")


files

Returns the list of file paths that are candidates for export-ignore.

public files(): list<string>

Return Value:

File paths in canonical form (e.g., "/.editorconfig")


all

Returns all candidates as a combined list with folders first, then files.

public all(): list<string>

Return Value:

All candidates in deterministic order


Clone this wiki locally