Laravel Pint

https://github.com/laravel/pint
Admin
Laravel Pint is a PHP code style fixer CLI built on PHP-CS-Fixer. It applies preset rules such as...
Tokens:62,063
Snippets:466
Trust Score:9.7
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### NodePackageManager usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Shows how to detect the manager, install a package, and get binary and runtime names. Comments illustrate expected output.

```php
use App\Enums\NodePackageManager;

$manager = NodePackageManager::detect(getcwd()); // from lock files, default npm

if ($manager === NodePackageManager::Npm) {
    // npm install -D prettier@^3.9.6
    $manager->installCommand(['prettier@^3.9.6']);
}

echo $manager->binary();        // 'npm'
echo $manager->runtimeBinary(); // 'node' (or 'bun' for Bun projects)
```

--------------------------------

### Example usage of ConfigurationResolverFactory

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/factories.md

Shows how to use fromIO() to get the resolver and total files, and how to check runningInAgent() to conditionally output machine-readable JSON only.

```php
use App\Factories\ConfigurationResolverFactory;

[$resolver, $totalFiles] = ConfigurationResolverFactory::fromIO($input, $output);

// $resolver->getFinder()  — files to process
// $resolver->getFixers()  — effective fixers
// $resolver->isDryRun()   — true with --test/--bail
// $resolver->getCacheManager(), $resolver->getLinter(), $resolver->getDiffer()

if (ConfigurationResolverFactory::runningInAgent()) {
    // stdout must carry machine-readable JSON only.
}
```

--------------------------------

### pint.json Example with Laravel Preset and Custom Rules

Source: https://github.com/laravel/pint/blob/main/_autodocs/configuration.md

Example configuration using the `laravel` preset, disabling `no_unused_imports`, enabling `concat_space` with `spacing: one`, and enabling `Pint/laravel_blade`. Also sets `exclude`, `notName`, and `cache-file`.

```json
{
    "preset": "laravel",
    "rules": {
        "no_unused_imports": false,
        "concat_space": { "spacing": "one" },
        "Pint/laravel_blade": true
    },
    "exclude": ["resources/views/vendor"],
    "notName": ["*.generated.php"],
    "cache-file": ".pint-cache"
}
```

--------------------------------

### pint.json Example with psr12 Preset and extend

Source: https://github.com/laravel/pint/blob/main/_autodocs/configuration.md

Example configuration using the `psr12` preset, extending a parent `pint.json` via `extend`, and enabling the `single_quote` rule. `extend` is resolved relative to the config file's directory and only one level is allowed.

```json
{
    "preset": "psr12",
    "extend": "./vendor/acme/pint-base.json",
    "rules": { "single_quote": true }
}
```

--------------------------------

### Direct usage example of EnsurePrettierIsConfigured

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Shows how to resolve the action from the container and call execute() and cacheFingerprints().

```php
use App\Actions\EnsurePrettierIsConfigured;

$action = resolve(EnsurePrettierIsConfigured::class);

$action->execute();          // aborts (exit 1) when requirements are unmet
$fingerprints = $action->cacheFingerprints(); // e.g. ['Pint/laravel_blade' => '9f2…']
```

--------------------------------

### Example usage of ConfigurationFactory

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/factories.md

Shows how to call preset(), customFixers(), and isPathExcluded(). The preset merges pint.json rules on top of the passed rules; isPathExcluded checks against ignorable path rules.

```php
use App\Factories\ConfigurationFactory;

$config = ConfigurationFactory::preset(['no_unused_imports' => true]);
// $config instanceof PhpCsFixer\ConfigInterface;
// Rules from pint.json are merged on top of the passed preset rules.

$fixers = ConfigurationFactory::customFixers(); // [LaravelBlade\Fixer, PrettierCacheFingerprint]

if (ConfigurationFactory::isPathExcluded('resources/views/emails/x.blade.php')) {
    // excluded: inside 'resources/views/emails/' — matches the EmailView ignorable path rules.
}
```

--------------------------------

### get() method implementation

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Parses the config file, resolves extend if present, and returns the array. Aborts with exit 1 if JSON is invalid. Returns [] when no config path/file.

```php
protected function get()
{
    if (! is_null($this->path) && $this->fileExists((string) $this->path)) {
        $baseConfig = json_decode(file_get_contents($this->path), true);

        if (isset($baseConfig['extend'])) {
            $baseConfig = $this->resolveExtend($baseConfig);
        }

        return tap($baseConfig, function ($configuration) {
            if (! is_array($configuration)) {
                abort(1, sprintf('The configuration file [%s] is not valid JSON.', $this->path));
            }
        });
    }

    return [];
}
```

--------------------------------

### Usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Shows how to instantiate and use PhpFragmentFormatter. Demonstrates full document formatting, fragment mode, and non-PHP passthrough. The parallel worker's '--rules' flag overrides the preset file when present.

```php
use App\Support\PhpFragmentFormatter;

$formatter = new PhpFragmentFormatter;

// Full document:
echo $formatter->format("<?php\n\$a = array(1, 2);\n");
// => "<?php\n\n\$a = [1, 2];"

// Fragment mode skips import/declare-strict-type fixers that would corrupt a snippet:
$arg = $formatter->format("<?php\n__pint__(\$user ? \$a : \$b);\n", fragment: true);

// Non-PHP input is passed through unchanged:
echo $formatter->format('plain text', fragment: true); // 'plain text'

// If the parallel worker's "--rules" flag is present in argv, that ruleset is
// used instead of the preset file.
```

--------------------------------

### Auto-created package.json

Source: https://github.com/laravel/pint/blob/main/_autodocs/configuration.md

Written by EnsurePrettierIsConfigured when package.json is missing and npm packages must be installed.

```json
{
    "$schema": "https://www.schemastore.org/package.json",
    "private": true,
    "type": "module"
}
```

--------------------------------

### Prettier usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Example of using Prettier to format a Blade file, catching PrettierException and ensuring termination.

```php
use App\Support\Prettier;
use App\Exceptions\PrettierException;

$prettier = new Prettier(getcwd());

try {
    $formatted = $prettier->format('resources/views/welcome.blade.php', $rawBlade);
    echo $formatted;
} catch (PrettierException $e) {
    // Worker crashed, timed out, or emitted an error to stderr.
    fwrite(STDERR, $e->getMessage());
} finally {
    $prettier->ensureTerminated();
}
```

--------------------------------

### Issue usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Creates an Issue for a fixed file and demonstrates calling file(), description(), fixable(), and code().

```php
use App\ValueObjects\Issue;

$issue = new Issue(
    getcwd(),
    getcwd().'/app/Http/Controllers/HomeController.php',
    '✓',
    [
        'appliedFixers' => ['no_unused_imports'],
        'diff' => '--- a/…  +++ b/…',
    ],
);

echo $issue->file();          // 'app/Http/Controllers/HomeController.php'
echo $issue->description(false); // 'no_unused_imports'
$issue->fixable();            // true
echo $issue->code();          // colorized diff
```

--------------------------------

### NodePackageManager::installCommand()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the argv array for installing packages as dev dependencies. Uses npm install -D, yarn add -D, pnpm add -D, or bun add -d depending on the case. Ready for Symfony Process or Illuminate Process::run().

```php
/**
 * The command used to install the given packages as development dependencies.
 *
 * @param  array<int, string>  $packages
 * @return array<int, string>
 */
public function installCommand(array $packages): array
{
    return match ($this) {
        self::Npm => ['npm', 'install', '-D', ...$packages],
        self::Yarn => ['yarn', 'add', '-D', ...$packages],
        self::Pnpm => ['pnpm', 'add', '-D', ...$packages],
        self::Bun => ['bun', 'add', '-d', ...$packages],
    };
}
```

--------------------------------

### ConfigurationJsonRepository usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Shows how to instantiate and use the ConfigurationJsonRepository. The preset defaults to 'laravel', rules come from pint.json, and finder only exposes exclude/in/notPath/notName keys. Invalid JSON throws ConsoleException with the message 'The configuration file [<path>] is not valid JSON.'

```php
use App\Repositories\ConfigurationJsonRepository;

// Wired by the container in real runs:
$config = new ConfigurationJsonRepository(getcwd().'/pint.json', null);

$preset = $config->preset();            // 'laravel' by default
$rules  = $config->rules();             // array<string, mixed> from pint.json
$finder = $config->finder();            // only exclude/in/notPath/notName keys

// Error handling: invalid JSON → ConsoleException('The configuration file [<path>] is not valid JSON.')
```

--------------------------------

### FixCode usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Resolves FixCode from the container and calls execute(). Iterates over changed files to print file paths and applied fixers. Requires mocked or pinned input/output in the container.

```php
use App\Actions\FixCode;

// Resolved from the container as DefaultCommand does; input/output must be
// mocked or pinned in the container (see App\Kernel).
$fixCode = resolve(FixCode::class);

[$totalFiles, $changes] = $fixCode->execute();

foreach ($changes as $file => $change) {
    echo $file."\n";
    echo implode(', ', $change['appliedFixers'])."\n";
}
```

--------------------------------

### Masker lifecycle example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/prettier-formatters-maskers.md

Shows the masker lifecycle as used by BladeFormatter: preFormat hides Blade inside script/style, then postFormat restores it. If prettier loses or duplicates a placeholder, UnrestorableContentException is caught and the original content is returned.

```php
use App\PrettierFormatters\EmbeddedBladeMasker;

$masker = new EmbeddedBladeMasker;

$masked = $masker->preFormat($source);       // Blade inside <script>/<style> hidden
$formatted = $prettyPrinted;                  // prettier output over $masked
try {
    $restored = $masker->postFormat($formatted);
} catch (UnrestorableContentException $e) {
    // prettier lost or duplicated a placeholder → BladeFormatter discards the
    // whole run and returns the untouched original content.
}
```

--------------------------------

### Version probe CLI invocation

Source: https://github.com/laravel/pint/blob/main/_autodocs/types.md

Command to run the version-probe script with a package name; it writes the installed version to stdout or exits 1 if the package is not resolvable.

```bash
node <version-probe.cjs> <package>
```

--------------------------------

### Issue error-style example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Creates an Issue for an error using ErrorsManager, with payload containing a source exception. Demonstrates description(true) returning the exception message.

```php
use PhpCsFixer\Error\ErrorsManager;

$errors = new ErrorsManager;
// … runner populates $errors …

$issue = new Issue(
    getcwd(),
    $anyError->getFilePath(),
    '!',
    ['source' => $anyError->getSource()],
);

echo $issue->description(true); // $anyError->getSource()->getMessage()
```

--------------------------------

### NodePackageManager::installCommand(array $packages): array

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the command used to install the given packages as development dependencies. The returned argv array is ready for Symfony Process or Laravel's Process facade.

```APIDOC
## NodePackageManager::installCommand(array $packages): array

### Description
Returns the command used to install the given packages as development dependencies.

### Method
Instance method

### Signature
```php
public function installCommand(array $packages): array
```

### Parameters
- **$packages** (array<int, string>) - Required - Package specifiers (e.g. `prettier@^3.9.6`)

### Returns
- **array<int, string>** - The argv array to run, ready for `Symfony\Component\Process\Process` / `Illuminate\Support\Facades\Process::run()`.

### Example
```php
$manager->installCommand(['prettier@^3.9.6']);
// For Npm: ['npm', 'install', '-D', 'prettier@^3.9.6']
```
```

--------------------------------

### Custom formatter implementing PrettierPostFormatter

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/contracts.md

Example of a custom formatter that collapses inline style tags. Safe anywhere in the chain; constructor dependencies are auto-wired via container resolution.

```php
use App\Contracts\PrettierPostFormatter;

class InlineStyleCollapser implements PrettierPostFormatter
{
    public function postFormat(string $content): string
    {
        // one-line transformers are safe anywhere in the chain
        return str_replace("<style>\n", '<style>', $content);
    }
}
```

--------------------------------

### CollapseShortSlots formatter usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/prettier-formatters-post.md

Instantiates the CollapseShortSlots formatter and applies postFormat to a Blade slot string, collapsing the content onto a single line. Outputs the transformed string.

```php
use App\PrettierFormatters\CollapseShortSlots;

$formatter = new CollapseShortSlots;

$wrapped = "<x-slot name=\"title\">\n  Hello\n</x-slot>";
echo $formatter->postFormat($wrapped);
// => '<x-slot name="title">Hello</x-slot>'
```

--------------------------------

### Handling UnrestorableContentException in masker

Source: https://github.com/laravel/pint/blob/main/_autodocs/errors.md

Example of using AlpineMaskPatterns and catching UnrestorableContentException. The original content is the only safe output when restoration fails.

```php
use App\PrettierFormatters\AlpineMaskPatterns;
use App\Exceptions\UnrestorableContentException;

$masker = new AlpineMaskPatterns;
$masked = $masker->preFormat($content);

try {
    $restored = $masker->postFormat($prettierOutput);
} catch (UnrestorableContentException $e) {
    // discard the run; the original content is the only safe output
}
```

--------------------------------

### NotOperatorSpacing formatter usage example

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/prettier-formatters-post.md

Instantiates the NotOperatorSpacing formatter and applies postFormat to a Blade template string, adding a space after the '!' operator. Outputs the transformed string.

```php
use App\PrettierFormatters\NotOperatorSpacing;

$formatter = new NotOperatorSpacing;

$content = '<button x-on:click="!show">Toggle</button>';
echo $formatter->postFormat($content);
// => '<button x-on:click="! show">Toggle</button>'
```

--------------------------------

### Entry-point data flow diagram

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/entry-point-and-container.md

Shows the startup sequence from argv through the Pint script, bootstrap, kernel handling, command execution, and termination. The worker argument short-circuits after step 3 to delegate to php-cs-fixer.

```text
argv → pint script (stdin placeholder, class-map overrides)
     → bootstrap/app.php (Application + kernel bindings)
     → Kernel::handle() (pins InputInterface/OutputInterface)
     → DefaultCommand::handle() via CommandsServiceProvider::bindMethod
          → EnsurePrettierIsConfigured::execute()
          → hasStdinInput() ? fixStdinInput() : [totalFiles, changes] = FixCode::execute()
          → ElaborateSummary::execute($totalFiles, $changes) → exit status
     → Kernel::terminate() → Prettier::ensureTerminated() → exit($status)
```

--------------------------------

### Compile the binary with ./pint app:build

Source: https://github.com/laravel/pint/blob/main/RELEASE.md

Run this command to compile the Pint binary after updating the version in config/app.php.

```zsh
./pint app:build
```

--------------------------------

### Create ConfigurationJsonRepository with options

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Instantiate the repository with the config path and preset. The config path is null when --no-config is used, otherwise it's the --config value or <cwd>/pint.json. The preset comes from --preset.

```php
new ConfigurationJsonRepository(
    $input->getOption('no-config') ? null : $config,   // $config = --config or <cwd>/pint.json
    $input->getOption('preset'),
);
```

--------------------------------

### Tag the release and push the tag

Source: https://github.com/laravel/pint/blob/main/RELEASE.md

Use these commands to create a new version tag and push it to GitHub.

```zsh
git tag v1.x.y
git push origin v1.x.y
```

--------------------------------

### unsatisfied() return shape

Source: https://github.com/laravel/pint/blob/main/_autodocs/types.md

Declares the return type of unsatisfied() as an array of arrays with package, installed, and constraint fields.

```php
/**
 * @return array<int, array{package: string, installed: string, constraint: string}>
 */
```

--------------------------------

### ConfigurationJsonRepository class state and constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Defines the finder options and constructor. The constructor accepts a path (string|null) and preset (string|null). The path null disables configuration loading; preset falls back to config preset then 'laravel'.

```php
/**
 * Lists the finder options.
 *
 * @var array<int, string>
 */
protected $finderOptions = [
    'exclude',
    'in',
    'notPath',
    'notName',
];

public function __construct(protected $path, protected $preset)
{
    //
}
```

--------------------------------

### Catching PrettierException in format call

Source: https://github.com/laravel/pint/blob/main/_autodocs/errors.md

Example of catching PrettierException when calling Prettier::format(). The exception indicates worker death, timeout, or invalid response.

```php
use App\Support\Prettier;
use App\Exceptions\PrettierException;

try {
    $formatted = (new Prettier(getcwd()))->format($path, $content);
} catch (PrettierException $e) {
    // worker died / timed out / returned garbage
}
```

--------------------------------

### Constructor: __construct

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Initializes the formatter with a stand-in SplFileInfo('fragment.php') used for fixer supports() checks. Takes no arguments.

```php
public function __construct()
{
    $this->file = new SplFileInfo('fragment.php');
}
```

--------------------------------

### fromIO() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/factories.md

Creates a new PHP CS Fixer Configuration Resolver instance from the given input and output. Returns an array containing the resolver and the number of files matched by its finder.

```php
/**
 * Creates a new PHP CS Fixer Configuration Resolver instance
 * from the given input and output.
 *
 * @param  InputInterface  $input
 * @param  OutputInterface  $output
 * @return array{ConfigurationResolver, int}
 */
public static function fromIO($input, $output)
```

--------------------------------

### SummaryOutput presets and constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/output.md

Defines preset display names and constructor for App\Output\SummaryOutput. Requires config, errors, input, and output parameters.

```php
protected $presets = [
    'per' => 'PER',
    'psr12' => 'PSR 12',
    'laravel' => 'Laravel',
    'symfony' => 'Symfony',
    'empty' => 'Empty',
];

public function __construct(
    protected $config,
    protected $errors,
    protected $input,
    protected $output,
) {
    // ..
}
```

--------------------------------

### App\Kernel handle method

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/entry-point-and-container.md

Extends LaravelZero\Framework\Kernel. Pins the live InputInterface and OutputInterface into the container before Symfony Console runs, so downstream classes can resolve them.

```php
class Kernel extends BaseKernel
{
    public function handle($input, $output = null)
    {
        $this->app->instance(InputInterface::class, $input);
        $this->app->instance(OutputInterface::class, $output);

        return parent::handle($input, $output);
    }
}
```

--------------------------------

### finder() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns only the keys in $finderOptions from the config file. Consumed by ConfigurationFactory::finder() and isPathExcluded().

```php
/**
 * Get the finder options.
 *
 * @return array<string, array<int, string>|string>
 */
public function finder()
```

--------------------------------

### Basic run over the current directory

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Run Pint on the current directory with default settings.

```bash
pint
```

--------------------------------

### Prettier worker response delimiters

Source: https://github.com/laravel/pint/blob/main/_autodocs/types.md

Response format on stdout, wrapping the formatted content between start and end delimiters. Errors go to stderr. The worker uses bundled prettierrc.json options with plugins resolved from project root and filepath set.

```text
[PINT_PRETTIER_WORKER_START]<formatted content>[PINT_PRETTIER_WORKER_END]
```

--------------------------------

### Blade and parallel processing

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Enable Blade support and run Pint in parallel with a specified number of processes.

```bash
pint --blade --parallel --max-processes=4
```

--------------------------------

### preset() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns string — $this->preset when set, else config preset, else 'laravel'. Valid values are enforced downstream by ConfigurationResolverFactory::fromIO() (Preset not found. abort).

```php
public function preset()
```

--------------------------------

### cacheFile() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns string|null — the config cache-file value, or null.

```php
public function cacheFile()
```

--------------------------------

### handle() method for Pint command

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Executes the fix process: ensures Prettier is configured, handles stdin input if present, otherwise runs the fixer and renders the summary. Returns an integer exit status (0 or 1) as computed by ElaborateSummary::execute().

```php
public function handle($fixCode, $elaborateSummary, $ensurePrettierIsConfigured)
{
    $ensurePrettierIsConfigured->execute();

    if ($this->hasStdinInput()) {
        return $this->fixStdinInput($fixCode);
    }

    [$totalFiles, $changes] = $fixCode->execute();

    return $elaborateSummary->execute($totalFiles, $changes);
}
```

--------------------------------

### execute method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

No-op when no enabled fixer needs prettier; otherwise runs dependency checks and aborts on failure.

```php
public function execute(): void
```

--------------------------------

### FixCode private helper getInput()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Clones the input definition, appends stop-on-violation, allow-risky, rules, using-cache options, sets them from the resolver, sets diff based on differ type, and nulls the config option. This input is passed to the Runner and worker processes.

```php
private function getInput(ConfigurationResolver $resolver): InputInterface
```

--------------------------------

### ConfigurationFactory::finder() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/factories.md

Creates a PhpCsFixer\Finder with default ignore patterns and forwards pint.json finder keys to the Finder methods. Invalid keys abort with exit 1.

```php
/**
 * Creates the finder instance.
 *
 * @return Finder
 */
public static function finder()
```

--------------------------------

### Issue constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Creates a new Issue instance with path, file, symbol, and payload. The payload is either ['appliedFixers' => list<string>, 'diff' => string] for fixed files or ['source' => \Throwable] for errors.

```php
/**
 * Creates a new Issue instance.
 *
 * @param  string  $path
 * @param  string  $file
 * @param  string  $symbol
 * @param  array<string, list<string>|string|\Throwable>  $payload
 */
public function __construct(
    protected $path,
    protected $file,
    protected $symbol,
    protected $payload
) {
    // ..
}
```

--------------------------------

### Prettier constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Constructor that accepts the project root directory where the JS worker runs; npm packages resolve against it.

```php
public function __construct(protected string $projectRoot)
{
    //
}
```

--------------------------------

### fileExists() method implementation

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Rejects plaintext HTTP URLs with exit 1. For HTTPS, checks the first header from get_headers contains '200 OK'. Otherwise uses file_exists.

```php
protected function fileExists(string $path)
{
    return match (true) {
        str_starts_with($path, 'http://') => abort(1, 'Loading the configuration over plaintext HTTP is not allowed. Use HTTPS.'),
        str_starts_with($path, 'https://') => str_contains(get_headers($path)[0], '200 OK'),
        default => file_exists($path)
    };
}
```

--------------------------------

### ConfigurationFactory::preset() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/factories.md

Creates a PhpCsFixer\Config with the given rules, merging with pint.json rules and adding a cache fingerprint if needed. Configures parallel, finder, risky allowed, cache, and custom fixers.

```php
/**
 * Creates a PHP CS Fixer Configuration with the given array of rules.
 *
 * @param  array<string, array<string, array<int|string, string|int|string[]>|bool|string>|bool>  $rules
 * @return ConfigInterface
 */
public static function preset($rules)
```

--------------------------------

### Fix a specific path in test mode

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Run Pint in test mode on the 'app/' directory to check for formatting issues without making changes.

```bash
pint --test app/
```

--------------------------------

### GitPathsRepository constructor signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Constructor for GitPathsRepository. Takes a project root path, always Project::path() in production wiring.

```php
public function __construct($path)
```

--------------------------------

### Git-based scoping and stdin protocol

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Run Pint on dirty files, diff against origin/main, and format a file from stdin with a filename for editor integration.

```bash
pint --dirty
```

```bash
pint --diff=origin/main
```

```bash
cat app/Helpers.php | pint - --stdin-filename=app/Helpers.php > /tmp/formatted.php
```

--------------------------------

### ProgressOutput constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/output.md

Constructor for App\Output\ProgressOutput. Sets symbolsPerLine based on terminal width minus 4. Requires dispatcher, input, and output parameters.

```php
public function __construct(
    protected $dispatcher,
    protected $input,
    protected $output,
) {
    $this->symbolsPerLine = (new Terminal)->getWidth() - 4;
}
```

--------------------------------

### Constructor and state for EnsurePrettierIsConfigured

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Defines the cacheFingerprints property and constructor that injects Prettier and ConfigurationJsonRepository dependencies.

```php
/**
 * @var array<string, string>
 */
protected array $cacheFingerprints = [];

public function __construct(
    protected Prettier $prettier,
    protected ConfigurationJsonRepository $configuration,
) {
    //
}
```

--------------------------------

### NodePackageManager::runtimeBinary()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the JS runtime used to execute scripts: 'bun' for Bun, 'node' for all others.

```php
public function runtimeBinary(): string
{
    return match ($this) {
        self::Bun => 'bun',
        default => 'node',
    };
}
```

--------------------------------

### PhpBlockFormatting constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/prettier-formatters-maskers.md

Constructor for the post-only formatter that runs Pint over PHP embedded in Blade. Injects the PhpFragmentFormatter dependency.

```php
public function __construct(
    protected PhpFragmentFormatter $formatter,
) {
    //
}
```

--------------------------------

### NodePackageManager::runtimeBinary(): string

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the JS runtime used to execute scripts: 'bun' for Bun, 'node' for all others.

```APIDOC
## NodePackageManager::runtimeBinary(): string

### Description
Returns the JS runtime used to execute scripts.

### Method
Instance method

### Signature
```php
public function runtimeBinary(): string
```

### Returns
- **string** - `bun` for `Bun`, `node` for all others.

### Example
```php
echo $manager->runtimeBinary(); // 'node' (or 'bun' for Bun projects)
```
```

--------------------------------

### FixCode private helper getParallelConfig()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Returns a ParallelConfig based on the resolver and --parallel/--max-processes options. Uses resolver config when parallel is off or max-processes < 1, otherwise creates a new config overriding only the process count.

```php
private function getParallelConfig(ConfigurationResolver $resolver): ParallelConfig
```

--------------------------------

### Emitted argv for pint worker command

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/overrides.md

Shows the command line format produced by ProcessFactory, including optional flags for dry-run, diff, stop-on-violation, and configuration options.

```text
php <main-script> worker --port <port> --identifier <id>
  [--dry-run] [--diff] [--stop-on-violation]
  [--allow-risky <v>] [--config <v>] [--rules <v>] [--using-cache <v>] [--cache-file <v>]
```

--------------------------------

### format() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Formats a PHP document that already opens with '<?php'. When $fragment is true, additionally removes FRAGMENT_DENYLIST fixers. Returns the formatted code, or the input unchanged if tokenization fails.

```php
/**
 * Format a PHP document that already opens with "<?php".
 */
public function format(string $code, bool $fragment = false): string
```

--------------------------------

### resolveExtend() method implementation

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Merges a single parent config (extend → relative path) under the current file using array_replace_recursive(parent, child). Throws LogicException if nested extend chains exist.

```php
private function resolveExtend(array $configuration)
{
    $path = realpath(dirname($this->path).DIRECTORY_SEPARATOR.$configuration['extend']);

    $extended = json_decode(file_get_contents($path), true);

    if (isset($extended['extend'])) {
        throw new \LogicException('Pint configuration cannot extend from more than 1 file.');
    }

    return array_replace_recursive($extended, $configuration);
}
```

--------------------------------

### Output to file with checkstyle format

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Use the PSR-12 preset, output in checkstyle format, and write the report to a file. JSON reports go to stdout, while errors go to stderr.

```bash
pint --preset=psr12 --format=checkstyle --output-to-file=report.xml
```

--------------------------------

### GitPathsRepository dirty() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns absolute paths of PHP files with uncommitted changes. Runs 'git status --short -- '**.php''; a failed process aborts with exit 1 and message 'The [--dirty] option is only available when using Git.' Deleted files are dropped, renamed files resolve to new name after ' -> ', results are intersected with finder results.

```php
public function dirty()
```

--------------------------------

### Intended invocation of PathsRepository contract

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Shows how to use the PathsRepository contract via the container, as Project::resolveDirtyPaths() does. Failure modes: non-git directory throws ConsoleException with exit 1; git OK but zero files returns empty array, then Project aborts with exit 0 and messages 'No dirty files found.' or 'No files have changed since branching off of <branch>.'

```php
// Via the container (PathsRepository contract) — as Project::resolveDirtyPaths() does:
$paths = app(\App\Contracts\PathsRepository::class)->dirty();
$paths = app(\App\Contracts\PathsRepository::class)->diff('origin/main');

// Failure modes:
//   non-git directory       → ConsoleException, exit 1 ("only available when using Git")
//   git OK but zero files   → [] — Project then aborts with exit 0 ("No dirty files found." /
//                              "No files have changed since branching off of <branch>.")
```

--------------------------------

### Configure Pint CLI options in DefaultCommand::configure()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/command.md

Defines the command's input arguments and options for the Pint CLI. The 'path' argument accepts an array of paths, defaulting to the current working directory. Options include 'blade', 'config', 'no-config', 'preset', 'test', 'bail', 'repair', 'diff', 'dirty', 'format', 'output-to-file', 'output-format', 'stdin-filename', 'cache-file', 'parallel', and 'max-processes'. The 'diff' option suggests default branch values like 'main' and 'master'.

```php
protected function configure()
{
    parent::configure();

    $this
        ->setDefinition(
            [
                new InputArgument('path', InputArgument::IS_ARRAY, 'The path to fix', [(string) getcwd()]),
                new InputOption('blade', '', InputOption::VALUE_NONE, 'Enable the [Pint/laravel_blade] rule to format Blade files'),
                new InputOption('config', '', InputOption::VALUE_REQUIRED, 'The configuration that should be used'),
                new InputOption('no-config', '', InputOption::VALUE_NONE, 'Disable loading any configuration file'),
                new InputOption('preset', '', InputOption::VALUE_REQUIRED, 'The preset that should be used'),
                new InputOption('test', '', InputOption::VALUE_NONE, 'Test for code style errors without fixing them'),
                new InputOption('bail', '', InputOption::VALUE_NONE, 'Test for code style errors without fixing them and stop on first error'),
                new InputOption('repair', '', InputOption::VALUE_NONE, 'Fix code style errors but exit with status 1 if there were any changes made'),
                new InputOption('diff', '', InputOption::VALUE_REQUIRED, 'Only fix files that have changed since branching off from the given branch', null, ['main', 'master', 'origin/main', 'origin/master']),
                new InputOption('dirty', '', InputOption::VALUE_NONE, 'Only fix files that have uncommitted changes'),
                new InputOption('format', '', InputOption::VALUE_REQUIRED, 'The output format that should be used'),
                new InputOption('output-to-file', '', InputOption::VALUE_REQUIRED, 'Output the test results to a file at this path'),
                new InputOption('output-format', '', InputOption::VALUE_REQUIRED, 'The format that should be used when outputting the test results to a file'),
                new InputOption('stdin-filename', null, InputOption::VALUE_REQUIRED, 'File path context for stdin input'),
                new InputOption('cache-file', '', InputArgument::OPTIONAL, 'The path to the cache file'),
                new InputOption('parallel', 'p', InputOption::VALUE_NONE, 'Runs the linter in parallel (Experimental)'),
                new InputOption('max-processes', null, InputOption::VALUE_REQUIRED, 'The number of processes to spawn when using parallel execution'),
            ],
        );
}
```

--------------------------------

### Prettier format method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Public method signature for formatting a file's content. Throws PrettierException on failure.

```php
/**
 * Formats the given file.
 *
 * @throws PrettierException
 */
public function format(string $path, string $content): string
```

--------------------------------

### rules() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns the config rules array ([] when absent). When the container has InputInterface bound and --blade flag is set, forces rules['Pint/laravel_blade'] = true, overriding config.

```php
/**
 * Get the rules options.
 *
 * The "--blade" option is a shortcut that toggles the [Pint/laravel_blade]
 * rule, so it is folded into the configured rules here.
 *
 * @return array<string, mixed>
 */
public function rules()
```

--------------------------------

### hasIncludedPaths() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns bool — whether the config defines a non-empty finder.in.

```php
public function hasIncludedPaths()
```

--------------------------------

### pint CLI flags for blade and parallel processing

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/fixers.md

CLI commands to fold the Pint/laravel_blade rule into rules via --blade flag, and optionally run with parallel processing and max processes. Note that --allow-risky is not needed because Pint sets RiskyAllowed(true) on every config.

```bash
pint --blade                      # CLI flag folds Pint/laravel_blade into rules
pint --blade --parallel --max-processes=4
```

--------------------------------

### Bundled Prettier Configuration (prettierrc.json)

Source: https://github.com/laravel/pint/blob/main/_autodocs/configuration.md

JSON configuration loaded by the JS worker for Blade formatting. Sets parser to 'blade', enables single quotes, and includes required plugins. Requires prettier and plugins to be resolvable from the project root with specified version constraints.

```json
{
    "parser": "blade",
    "singleQuote": true,
    "htmlWhitespaceSensitivity": "css",
    "printWidth": 120,
    "tabWidth": 4,
    "bladePhpFormatting": "off",
    "bladePhpFormattingTargets": [],
    "bladeDirectiveArgSpacing": "none",
    "bladeEchoSpacing": "space",
    "bladeInlineIntentElements": ["svg", "svg:*"],
    "plugins": ["prettier-plugin-blade", "prettier-plugin-tailwindcss"]
}
```

--------------------------------

### format() method implementation

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/blade-formatter.md

Formats Blade content by running pre- and post-formatters around Prettier. Returns the original content if a post-formatter throws UnrestorableContentException, ensuring a half-restored file is never written. Worker failures (PrettierException) propagate and are not discarded.

```php
    /**
     * Format the given content.
     */
    public function format(string $path, string $content): string
    {
        $formatters = collect(static::$formatters)->map(
            fn (string $formatter): PrettierPreFormatter|PrettierPostFormatter => resolve($formatter),
        );

        $masked = $formatters->reduce(
            fn (string $content, PrettierPreFormatter|PrettierPostFormatter $formatter): string => $formatter instanceof PrettierPreFormatter
                ? $formatter->preFormat($content)
                : $content,
            $content,
        );

        $formatted = $this->prettier->format($path, $masked);

        try {
            return $formatters->reduce(
                fn (string $formatted, PrettierPreFormatter|PrettierPostFormatter $formatter): string => $formatter instanceof PrettierPostFormatter
                    ? $formatter->postFormat($formatted)
                    : $formatted,
                $formatted,
            );
        } catch (UnrestorableContentException) {
            // A pre-formatter could not undo its own work, which means prettier lost or
            // duplicated one of its placeholders. Discard the whole run and hand back the
            // untouched file: only the original content is guaranteed to be intact once a
            // masking pass has been given up on.
            return $content;
        }
    }
```

--------------------------------

### GitPathsRepository processFileNames() protected method

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Protected method that prefixes git-reported paths with project path and filters to only files the configured finder would process. On Windows, replaces '/' with DIRECTORY_SEPARATOR. Returns array of absolute paths.

```php
protected function processFileNames(Collection $fileNames)
{
    $processedFileNames = $fileNames
        ->map(function ($file) {
            if (PHP_OS_FAMILY === 'Windows') {
                $file = str_replace('/', DIRECTORY_SEPARATOR, $file);
            }

            return $this->path.DIRECTORY_SEPARATOR.$file;
        })
        ->all();

    $files = array_values(array_map(function ($splFile) {
        return $splFile->getPathname();
    }, iterator_to_array(ConfigurationFactory::finder()
        ->in($this->path)
        ->files()
    )));

    return array_values(array_intersect($files, $processedFileNames));
}
```

--------------------------------

### NodePackageManager::binary(): string

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the CLI binary name for the package manager (npm, yarn, pnpm, bun).

```APIDOC
## NodePackageManager::binary(): string

### Description
Returns the CLI binary name for the package manager.

### Method
Instance method

### Signature
```php
public function binary(): string
```

### Returns
- **string** - The CLI binary name (`npm`, `yarn`, `pnpm`, `bun`).

### Example
```php
echo $manager->binary(); // 'npm'
```
```

--------------------------------

### ConfigurationResolverFactory::fromIO() return shape

Source: https://github.com/laravel/pint/blob/main/_autodocs/types.md

Declares the return type of fromIO() as an array containing a ConfigurationResolver and an integer finder file count.

```php
/**
 * @return array{ConfigurationResolver, int}
 */
public static function fromIO($input, $output)
```

--------------------------------

### FixCode constructor

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Constructor for the FixCode action, injecting error manager, event dispatcher, input, output, and progress output. All parameters are required.

```php
public function __construct(
    protected $errors,
    protected $events,
    protected $input,
    protected $output,
    protected $progress,
) {
    //
}
```

--------------------------------

### Issue::description($testing) method

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Returns the source exception message for error issues, or the comma-joined applied fixer names for fixed files. The $testing parameter is accepted for signature compatibility but not used.

```php
public function description($testing)
{
    if (! empty($this->payload['source'])) {
        return $this->payload['source']->getMessage();
    }

    return collect($this->payload['appliedFixers'])->map(function ($appliedFixer) {
        return $appliedFixer;
    })->implode(', ');
}
```

--------------------------------

### requiredPackages method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Returns npm package to semver constraint map from enabled prettier-dependent fixers.

```php
public function requiredPackages(): array
```

--------------------------------

### cacheFingerprints method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Returns a map of fixer name to md5 fingerprint, populated by execute() and consumed by ConfigurationFactory::preset().

```php
public function cacheFingerprints(): array
```

--------------------------------

### Constants: DENYLIST and FRAGMENT_DENYLIST

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/support.md

Defines fixers that are unsafe on embedded fragments. DENYLIST is always skipped; FRAGMENT_DENYLIST is skipped only for stripped fragments to avoid corruption.

```php
/**
 * Fixers that are unsafe on an embedded fragment and skipped for every run.
 *
 * @var array<int, string>
 */
private const DENYLIST = ['no_closing_tag', 'no_unused_imports', 'Pint/laravel_blade'];

/**
 * Fixers skipped only for stripped fragments, where they corrupt the output.
 *
 * @var array<int, string>
 */
private const FRAGMENT_DENYLIST = ['fully_qualified_strict_types', 'global_namespace_import', 'declare_strict_types'];
```

--------------------------------

### GitPathsRepository diff($branch) method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/repositories.md

Returns absolute paths of PHP files changed since branching off $branch. Runs four git probes; each failing one aborts with 'The [--diff] option is only available when using Git.' Results are split, flattened, deduplicated, and intersected with finder results.

```php
public function diff($branch)
```

--------------------------------

### NodePackageManager::binary()

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/enums.md

Returns the CLI binary name (npm, yarn, pnpm, bun) as the enum value.

```php
public function binary(): string
{
    return $this->value;
}
```

--------------------------------

### FixCode execute() method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Public method that fixes the project resolved by the current input and output. Returns a tuple of total file count and changed files with applied fixers and diff.

```php
/**
 * Fixes the project resolved by the current input and output.
 *
 * @return array{int, array<string, array{appliedFixers: array<int, string>, diff: string}>}
 */
public function execute()
```

--------------------------------

### Built-in Finder Defaults (notName and exclude)

Source: https://github.com/laravel/pint/blob/main/_autodocs/configuration.md

Default file-name patterns and directories excluded by Pint's finder. `*.blade.php` is appended to `notName` only when `rules['Pint/laravel_blade']` is explicitly `false`.

```php
protected static $notName = [
    '_ide_helper_actions.php',
    '_ide_helper_models.php',
    '_ide_helper.php',
    '.phpstorm.meta.php',
];

protected static $exclude = [
    'bootstrap/cache',
    'build',
    'node_modules',
    'storage',
];
```

--------------------------------

### Issue::file() method

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Returns the project-relative file path by stripping the project root from the stored file path.

```php
public function file()
{
    return str_replace($this->path.DIRECTORY_SEPARATOR, '', $this->file);
}
```

--------------------------------

### Issue::code() method

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/value-objects.md

Returns highlighted source (via NunoMaduro\Collision\Highlighter) around the error line for error issues, or the rendered diff for fixed issues. May return null when no diff exists. Reads the file from disk.

```php
public function code()
{
    if (! $this->fixable()) {
        $content = file_get_contents($this->file);

        $exception = $this->payload['source']->getPrevious() ?: $this->payload['source'];

        return (new Highlighter)->highlight($content, $exception->getLine());
    }

    return $this->diff();
}
```

--------------------------------

### CommandsServiceProvider bindMethod for DefaultCommand

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/entry-point-and-container.md

Binds the handle method of DefaultCommand to its three action dependencies: FixCode, ElaborateSummary, and EnsurePrettierIsConfigured.

```php
$this->app->bindMethod([DefaultCommand::class, 'handle'], function ($command) {
    return $command->handle(
        resolve(FixCode::class),
        resolve(ElaborateSummary::class),
        resolve(EnsurePrettierIsConfigured::class)
    );
});
```

--------------------------------

### FixCode::execute() return shape docblock

Source: https://github.com/laravel/pint/blob/main/_autodocs/types.md

Docblock for the execute method, specifying the return type as an array with total files and changed files keyed by path.

```php
/**
 * @return array{int, array<string, array{appliedFixers: array<int, string>, diff: string}>}
 */
public function execute()
```

--------------------------------

### fingerprint method signature

Source: https://github.com/laravel/pint/blob/main/_autodocs/api-reference/actions.md

Computes md5 of dependency versions for a given fixer and probes.

```php
public function fingerprint(HasPrettierDependencies $fixer, array $probes): string
```
Tokens:
Raw