FileStatus
API reference › Scaffold › Services › FileStatus
Represents the state of a scaffold file, tracked in scaffold-lock.json or pending, as reported by the status
command.
| Case | Value | Description |
|---|---|---|
Conflict | 'conflict' | The destination is a replace file changed by the consumer while the provider stub also changed. |
Ejected | 'ejected' | The destination was ejected and scaffold no longer manages it. |
Error | 'error' | The lock entry is unsafe, or the destination, stub or provider manifest cannot be read. |
Missing | 'missing' | The destination is absent from disk. |
Modified | 'modified' | The replace or preserve destination changed since the last apply. |
Orphan | 'orphan' | No allowed and installed provider ships the destination anymore. |
Outdated | 'outdated' | The provider stub changed since the last apply, or an append/prepend destination lacks provider content. |
Pending | 'pending' | An allowed and installed provider ships the destination, but scaffold-lock.json has no entry for it yet. |
Synced | 'synced' | The destination matches the last apply and the current provider stub. |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
summaryOrder() static | Returns the states in the order the summary line lists them. | FileStatus |
Method details
Section titled “Method details”summaryOrder()
Section titled “summaryOrder() ”public static function summaryOrder(): list<self>Returns the states in the order the summary line lists them.
Returns
list<self>: Every state in summary order, from synced to error.