vimeo/psalm

Declaring stubs in directory

Open

#9,193 opened on Jan 27, 2023

View on GitHub
 (6 comments) (2 reactions) (0 assignees)PHP (5,369 stars) (668 forks)batch import
Help wantedeasy problemsenhancementgood first issue

Description

Right now, the <stubs> configuration node only supports the <file> node as a child.

This is problematic when:

  • there are multiple files
  • stubs files are generated dynamically

Having experienced both of the above, I think it would be nice if Psalm would support <directory> as <stubs>'s child node. Similar to how <projectFiles> already does.

Alternatively, the <file> node could support a pattern attribute to be used instead of <name>, so instead of

    <stubs>
        <file name="path/to/my/stubs/file1.php" />
        <file name="path/to/my/stubs/file2.php" />
        <file name="path/to/my/stubs/file3.php" />
        <file name="path/to/my/stubs/file4.php" />
    </stubs>

one could do either:

    <stubs>
        <directory name="path/to/my/stubs/" />
    </stubs>

or:

    <stubs>
        <file pattern="path/to/my/stubs/*.php" />
    </stubs>

Both approaches would solve this issue. The pattern attribute available for the StubsAttributeType XML type will enable it for any other usage of the <file> node in configuration.

Contributor guide

Tech stack
None
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Psalm's XML configurationPHP knowledgeUnderstanding of XML schema definitions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine how Psalm currently handles `<stubs>` and `<file>` in the XML config parser and schema. Look at how `<projectFiles>` supports `<directory>` and replicate that pattern for `<stubs>`. Alternatively, investigate adding a `pattern` attribute to `<file>` by modifying the `StubsAttributeType` XML type. Check the Psalm codebase for relevant files like `src/Psalm/Config/FileFilter.php` or `src/Psalm/Config/IssueHandler.php`. Review comments in the issue #9193 for any additional context or maintainer feedback.