gitignore

Description

The gitignore command merges the canonical .gitignore from dev-tools with the project's existing .gitignore.

Usage

composer gitignore
composer gitignore [options]
composer dev-tools gitignore -- [options]
vendor/bin/dev-tools gitignore [options]

Options

--source, -s (optional)

Path to the source .gitignore file (canonical). Default: packaged .gitignore.

--target, -t (optional)

Path to the target .gitignore file (project). Default: project root .gitignore.

--dry-run

Preview managed .gitignore drift without writing the file.

--check

Exit with code 1 when .gitignore needs an update.

--interactive

Prompt before updating .gitignore .

--json

Emit a structured machine-readable payload instead of the normal terminal output.

--pretty-json

Emit the same structured payload with indentation for terminal inspection.

Examples

Merge .gitignore files:

composer gitignore

Specify custom paths:

composer gitignore --source=/path/to/source/.gitignore --target=/path/to/target/.gitignore

Exit Codes

Behavior

• Reads the canonical .gitignore from dev-tools and merges with the project's.
• By default, the source is the packaged .gitignore and the target is the project's root.
• Duplicates are removed and entries are sorted alphabetically.
• Uses the Reader, Merger, and Writer components from the GitIgnore namespace.
• --dry-run and --check render a diff against the normalized managed result before deciding whether to write.