# ListMergeStrategy

> Merges ignore-style list files (.gitignore, .gitattributes and similar) by entry, never by comment.

[API reference](/docs/api/index.md) › [Scaffold](/docs/extensions/scaffold/reference/index.md) › [Merge](/docs/extensions/scaffold/reference/merge/index.md) › ListMergeStrategy

| final class | `PHPForge\Scaffold\Merge\ListMergeStrategy` |
| --- | --- |
| Extends | [`AbstractLineMergeStrategy`](/docs/extensions/scaffold/reference/merge/abstractlinemergestrategy/index.md) |
| Implements | [`MergeStrategy`](/docs/extensions/scaffold/reference/merge/mergestrategy/index.md) |
| Source | [`src/Merge/ListMergeStrategy.php`](https://github.com/php-forge/scaffold/blob/main/src/Merge/ListMergeStrategy.php#L18) |

Merges ignore-style list files (`.gitignore`, `.gitattributes` and similar) by entry, never by comment.

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-merge"></span>[`merge()`](/docs/extensions/scaffold/reference/merge/abstractlinemergestrategy/index.md#method-merge) | Adds the provider entries missing from the consumer. | [`AbstractLineMergeStrategy`](/docs/extensions/scaffold/reference/merge/abstractlinemergestrategy/index.md) |
| [`plan()`](#method-plan) protected | Plans missing entries under the consumer's matching comment header, or as new commented blocks at the end. | `ListMergeStrategy` |

## Method details

### plan() <span id="method-plan"></span>

```php
protected function plan(list<string> $provider, list<string> $consumer): PHPForge\Scaffold\Merge\MergePlan
```

Plans missing entries under the consumer's matching comment header, or as new commented blocks at the end.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$provider` | `list<string>` | Provider lines. |
| `$consumer` | `list<string>` | Consumer lines without terminators. |

**Returns**

`PHPForge\Scaffold\Merge\MergePlan`: Lines to insert after a consumer line index and blocks to append; both empty when satisfied.