excludePaths config doesn't merge when using different styles

[jshah4517]

Bug report

If you have one config file with excludePaths in one format (single level), and another config file with excludePaths in another format (two levels, with analyse and analyseAndScan options), you get an error that the configuration is invalid when they are used together.

Code snippet that reproduces the problem

We use the Larastan extension (https://github.com/nunomaduro/larastan).

Their parameters includes the following:

    excludePaths:
        - *.blade.php

Our config file looks like the following. We have some directories that we want to scan but not analyse.

includes:
    - ./vendor/nunomaduro/larastan/extension.neon

parameters:
    level: 8
    paths:
        - app/
    excludePaths:
        analyse:
            - app/Plugins/*
        analyseAndScan:
            - */node_modules/*
            - */vendor/*

This gives the following error:

Invalid configuration:
Unexpected option 'parameters › excludePaths › 0', 'parameters › excludePaths › analyseAndScan'.
Invalid configuration:
Unexpected option 'parameters › excludePaths › 0', 'parameters › excludePaths › analyse'.
Invalid configuration:
Unexpected option 'parameters › excludePaths › 0'.

Expected output

It merges the config correctly and uses analyseAndScan as the option for the config that is single level.

[mergeable]

This bug report is missing a link to reproduction on phpstan.org.

It will most likely be closed after manual review.

[ZeWaren]

Until this bug is fixed, here is a dirty workaround.

Here is a PHP file that loads the neon file from larastan and renames the entry so that if fits the other schema style so that the other files can be merged with it:

<?php

/**
 * This file loads the PHPStan neon file from LaraStan, and rename the entry with the excluded paths.
 *
 * See:
 *   phpstan/phpstan: "excludePaths config doesn't merge when using different styles #4561"
 *   https://github.com/phpstan/phpstan/issues/4561
 */

use PHPStan\DependencyInjection\NeonAdapter;

# Load the neon file from LaraStan:
$neonAdapter = new NeonAdapter();
$data = $neonAdapter->load('./vendor/nunomaduro/larastan/extension.neon');

# Replace parameters.excludePaths with parameters.excludePaths.analyseAndScan:
$laraStanExcludedPaths = $data['parameters']['excludePaths'];
unset($data['parameters']['excludePaths']);
$data['parameters']['excludePaths'] = [
    'analyseAndScan' => $laraStanExcludedPaths,
];

# Return the file:
return $data;

The file can be included the same way neon files are included as usual:

includes:
    - ./phpstan_larastan_neon_loader.php

[canvural]

@ZeWaren If it'll make other people's life easier and if there is no BC break, I can accept a PR to Larastan that changes this 👍

[ondrejmirtes]

@canvural There's no combination Larastan can have in its extension.neon, it'd always break someone's config. I haven't thought of this scenario when I allowed multiple different notations for excludePaths. It needs to be fixed and allowed in phpstan/phpstan.

[canvural]

@ondrejmirtes Ah, ok. I understand now.

[ondrejmirtes]

Fixed: phpstan/phpstan-src@e7ac788

Feel free to test dev-master: composer require --dev phpstan/phpstan:dev-master --prefer-dist

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.