Skip to content

Commit 74b909a

Browse files
ondrejmirtesondrejmirtes
committed
Introduce --tmp-file and --instead-of CLI options for easier running PHPStan from editor/IDE
1 parent a06aaa4 commit 74b909a

21 files changed

+296
-11
lines changed

‎.github/workflows/e2e-tests.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,21 @@ jobs:
189189
echo "$OUTPUT"
190190
../bashunit -a contains 'Result cache not used because the metadata do not match: projectConfig, scannedFiles' "$OUTPUT"
191191
../bashunit -a contains 'Instantiated class ResultCacheE2EGenerated\Foo not found.' "$OUTPUT"
192+
- script: |
193+
cd e2e/editor-mode
194+
OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw")
195+
echo "$OUTPUT"
196+
../bashunit -a contains 'Bar.php:10:Parameter #1 $s of method EditorModeE2E\Bar::requireString() expects string, int given. [identifier=argument.type]' "$OUTPUT"
197+
../bashunit -a contains 'Foo.php:10:Method EditorModeE2E\Foo::doFoo() should return int but returns string. [identifier=return.type]' "$OUTPUT"
198+
../bashunit -a contains 'Result cache is saved.' "$OUTPUT"
199+
200+
OUTPUT=$(../bashunit -a exit_code "1" "../../bin/phpstan analyse -vv --error-format raw --tmp-file differentFoo.php --instead-of src/Foo.php")
201+
echo "$OUTPUT"
202+
../bashunit -a contains 'differentFoo.php:10:Method EditorModeE2E\Foo::doFoo() should return float but returns string. [identifier=return.type]' "$OUTPUT"
203+
../bashunit -a not_contains 'Foo.php:10:Method EditorModeE2E\Foo::doFoo() should return int but returns string. [identifier=return.type]' "$OUTPUT"
204+
../bashunit -a contains 'Bar.php:10:Parameter #1 $s of method EditorModeE2E\Bar::requireString() expects string, float given. [identifier=argument.type]' "$OUTPUT"
205+
../bashunit -a contains 'Result cache restored. 2 files will be reanalysed.' "$OUTPUT"
206+
../bashunit -a contains 'Result cache was not saved because of --tmp-file and --instead-of CLI options passed (editor mode).' "$OUTPUT"
192207
- script: |
193208
cd e2e/trait-caching
194209
../../bin/phpstan analyze --no-progress --level 8 --error-format raw data/

‎conf/config.neon

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -660,6 +660,8 @@ services:
660660
usedLevel: %usedLevel%
661661
generateBaselineFile: %generateBaselineFile%
662662
cliAutoloadFile: %cliAutoloadFile%
663+
singleReflectionFile: %singleReflectionFile%
664+
singleReflectionInsteadOfFile: %singleReflectionInsteadOfFile%
663665

664666
-
665667
class: PHPStan\DependencyInjection\Reflection\ClassReflectionExtensionRegistryProvider
@@ -2196,6 +2198,7 @@ services:
21962198
composerAutoloaderProjectPaths: %composerAutoloaderProjectPaths%
21972199
analysedPathsFromConfig: %analysedPathsFromConfig%
21982200
playgroundMode: %sourceLocatorPlaygroundMode%
2201+
singleReflectionFile: %singleReflectionFile%
21992202

22002203
-
22012204
implement: PHPStan\Reflection\BetterReflection\BetterReflectionProviderFactory
@@ -2243,6 +2246,7 @@ services:
22432246
currentPhpVersionRichParser: @currentPhpVersionRichParser
22442247
currentPhpVersionSimpleParser: @currentPhpVersionSimpleParser
22452248
php8Parser: @php8Parser
2249+
singleReflectionFile: %singleReflectionFile%
22462250
autowired: false
22472251

22482252
phpstanDiagnoseExtension:

‎conf/parametersSchema.neon

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,3 +251,7 @@ parametersSchema:
251251
analysedPathsFromConfig: listOf(string())
252252
usedLevel: string()
253253
cliAutoloadFile: schema(string(), nullable())
254+
255+
# internal - editor mode
256+
singleReflectionFile: schema(string(), nullable())
257+
singleReflectionInsteadOfFile: schema(string(), nullable())

‎e2e/editor-mode/differentFoo.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
namespace EditorModeE2E;
4+
5+
class Foo
6+
{
7+
8+
public function doFoo(): float
9+
{
10+
return 'foo';
11+
}
12+
13+
}

‎e2e/editor-mode/phpstan.neon

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
parameters:
2+
paths:
3+
- src
4+
level: 8

‎e2e/editor-mode/src/Bar.php

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php
2+
3+
namespace EditorModeE2E;
4+
5+
class Bar
6+
{
7+
8+
public function doFoo(Foo $foo): void
9+
{
10+
$this->requireString($foo->doFoo());
11+
}
12+
13+
public function requireString(string $s): void
14+
{
15+
16+
}
17+
18+
}

‎e2e/editor-mode/src/Foo.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
namespace EditorModeE2E;
4+
5+
class Foo
6+
{
7+
8+
public function doFoo(): int
9+
{
10+
return 'foo';
11+
}
12+
13+
}

‎src/Analyser/ResultCache/ResultCacheManager.php

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ final class ResultCacheManager
6767
* @param string[] $bootstrapFiles
6868
* @param string[] $scanFiles
6969
* @param string[] $scanDirectories
70+
* @param array<string, string> $fileReplacements
7071
*/
7172
public function __construct(
7273
private ExportedNodeFetcher $exportedNodeFetcher,
@@ -83,6 +84,7 @@ public function __construct(
8384
private array $bootstrapFiles,
8485
private array $scanFiles,
8586
private array $scanDirectories,
87+
private array $fileReplacements,
8688
private bool $checkDependenciesOfProjectExtensionFiles,
8789
)
8890
{
@@ -369,6 +371,9 @@ private function getMetaKeyDifferences(array $cachedMeta, array $currentMeta): a
369371
*/
370372
private function exportedNodesChanged(string $analysedFile, array $cachedFileExportedNodes): ?bool
371373
{
374+
if (array_key_exists($analysedFile, $this->fileReplacements)) {
375+
$analysedFile = $this->fileReplacements[$analysedFile];
376+
}
372377
$fileExportedNodes = $this->exportedNodeFetcher->fetchNodes($analysedFile);
373378

374379
$cachedSymbols = [];
@@ -443,6 +448,13 @@ public function process(AnalyserResult $analyserResult, ResultCache $resultCache
443448
return false;
444449
}
445450

451+
if (count($this->fileReplacements) > 0) {
452+
if ($output->isVeryVerbose()) {
453+
$output->writeLineFormatted('Result cache was not saved because of --tmp-file and --instead-of CLI options passed (editor mode).');
454+
}
455+
return false;
456+
}
457+
446458
foreach ($errorsByFile as $errors) {
447459
foreach ($errors as $error) {
448460
if (!$error->hasNonIgnorableException()) {
@@ -561,6 +573,10 @@ private function mergeErrors(ResultCache $resultCache, array $freshErrorsByFile)
561573
{
562574
$errorsByFile = $resultCache->getErrors();
563575
foreach ($resultCache->getFilesToAnalyse() as $file) {
576+
if (array_key_exists($file, $this->fileReplacements)) {
577+
unset($errorsByFile[$file]);
578+
$file = $this->fileReplacements[$file];
579+
}
564580
if (!array_key_exists($file, $freshErrorsByFile)) {
565581
unset($errorsByFile[$file]);
566582
continue;
@@ -579,6 +595,10 @@ private function mergeLocallyIgnoredErrors(ResultCache $resultCache, array $fres
579595
{
580596
$errorsByFile = $resultCache->getLocallyIgnoredErrors();
581597
foreach ($resultCache->getFilesToAnalyse() as $file) {
598+
if (array_key_exists($file, $this->fileReplacements)) {
599+
unset($errorsByFile[$file]);
600+
$file = $this->fileReplacements[$file];
601+
}
582602
if (!array_key_exists($file, $freshLocallyIgnoredErrorsByFile)) {
583603
unset($errorsByFile[$file]);
584604
continue;
@@ -597,6 +617,10 @@ private function mergeCollectedData(ResultCache $resultCache, array $freshCollec
597617
{
598618
$collectedDataByFile = $resultCache->getCollectedData();
599619
foreach ($resultCache->getFilesToAnalyse() as $file) {
620+
if (array_key_exists($file, $this->fileReplacements)) {
621+
unset($collectedDataByFile[$file]);
622+
$file = $this->fileReplacements[$file];
623+
}
600624
if (!array_key_exists($file, $freshCollectedDataByFile)) {
601625
unset($collectedDataByFile[$file]);
602626
continue;
@@ -637,6 +661,10 @@ private function mergeDependencies(ResultCache $resultCache, ?array $freshDepend
637661

638662
$newDependencies = $cachedDependencies;
639663
foreach ($resultCache->getFilesToAnalyse() as $file) {
664+
if (array_key_exists($file, $this->fileReplacements)) {
665+
unset($newDependencies[$file]);
666+
$file = $this->fileReplacements[$file];
667+
}
640668
if (!array_key_exists($file, $freshDependencies)) {
641669
unset($newDependencies[$file]);
642670
continue;
@@ -656,6 +684,10 @@ private function mergeExportedNodes(ResultCache $resultCache, array $freshExport
656684
{
657685
$newExportedNodes = $resultCache->getExportedNodes();
658686
foreach ($resultCache->getFilesToAnalyse() as $file) {
687+
if (array_key_exists($file, $this->fileReplacements)) {
688+
unset($newExportedNodes[$file]);
689+
$file = $this->fileReplacements[$file];
690+
}
659691
if (!array_key_exists($file, $freshExportedNodes)) {
660692
unset($newExportedNodes[$file]);
661693
continue;
@@ -675,6 +707,10 @@ private function mergeLinesToIgnore(ResultCache $resultCache, array $freshLinesT
675707
{
676708
$newLinesToIgnore = $resultCache->getLinesToIgnore();
677709
foreach ($resultCache->getFilesToAnalyse() as $file) {
710+
if (array_key_exists($file, $this->fileReplacements)) {
711+
unset($newLinesToIgnore[$file]);
712+
$file = $this->fileReplacements[$file];
713+
}
678714
if (!array_key_exists($file, $freshLinesToIgnore)) {
679715
unset($newLinesToIgnore[$file]);
680716
continue;
@@ -694,6 +730,10 @@ private function mergeUnmatchedLineIgnores(ResultCache $resultCache, array $fres
694730
{
695731
$newUnmatchedLineIgnores = $resultCache->getUnmatchedLineIgnores();
696732
foreach ($resultCache->getFilesToAnalyse() as $file) {
733+
if (array_key_exists($file, $this->fileReplacements)) {
734+
unset($newUnmatchedLineIgnores[$file]);
735+
$file = $this->fileReplacements[$file];
736+
}
697737
if (!array_key_exists($file, $freshUnmatchedLineIgnores)) {
698738
unset($newUnmatchedLineIgnores[$file]);
699739
continue;
@@ -933,6 +973,9 @@ private function getMeta(array $allAnalysedFiles, ?array $projectConfigArray): a
933973

934974
private function getFileHash(string $path): string
935975
{
976+
if (array_key_exists($path, $this->fileReplacements)) {
977+
$path = $this->fileReplacements[$path];
978+
}
936979
if (array_key_exists($path, $this->fileHashes)) {
937980
return $this->fileHashes[$path];
938981
}

‎src/Analyser/ResultCache/ResultCacheManagerFactory.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
interface ResultCacheManagerFactory
66
{
77

8-
public function create(): ResultCacheManager;
8+
/**
9+
* @param array<string, string> $fileReplacements
10+
*/
11+
public function create(array $fileReplacements): ResultCacheManager;
912

1013
}

‎src/Command/AnalyseApplication.php

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,17 @@ public function analyse(
4646
bool $debug,
4747
?string $projectConfigFile,
4848
?array $projectConfigArray,
49+
?string $tmpFile,
50+
?string $insteadOfFile,
4951
InputInterface $input,
5052
): AnalysisResult
5153
{
5254
$isResultCacheUsed = false;
53-
$resultCacheManager = $this->resultCacheManagerFactory->create();
55+
$fileReplacements = [];
56+
if ($tmpFile !== null && $insteadOfFile !== null) {
57+
$fileReplacements = [$insteadOfFile => $tmpFile];
58+
}
59+
$resultCacheManager = $this->resultCacheManagerFactory->create($fileReplacements);
5460

5561
$ignoredErrorHelperResult = $this->ignoredErrorHelper->initialize();
5662
$fileSpecificErrors = [];
@@ -71,6 +77,8 @@ public function analyse(
7177
$files,
7278
$debug,
7379
$projectConfigFile,
80+
$tmpFile,
81+
$insteadOfFile,
7482
$stdOutput,
7583
$errorOutput,
7684
$input,
@@ -169,6 +177,8 @@ private function runAnalyser(
169177
array $allAnalysedFiles,
170178
bool $debug,
171179
?string $projectConfigFile,
180+
?string $tmpFile,
181+
?string $insteadOfFile,
172182
Output $stdOutput,
173183
Output $errorOutput,
174184
InputInterface $input,
@@ -212,7 +222,7 @@ private function runAnalyser(
212222
}
213223
}
214224

215-
$analyserResult = $this->analyserRunner->runAnalyser($files, $allAnalysedFiles, $preFileCallback, $postFileCallback, $debug, true, $projectConfigFile, $input);
225+
$analyserResult = $this->analyserRunner->runAnalyser($files, $allAnalysedFiles, $preFileCallback, $postFileCallback, $debug, true, $projectConfigFile, $tmpFile, $insteadOfFile, $input);
216226

217227
if (!$debug) {
218228
$errorOutput->getStyle()->progressFinish();

‎src/Command/AnalyseCommand.php

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ protected function configure(): void
9898
new InputOption('allow-empty-baseline', null, InputOption::VALUE_NONE, 'Do not error out when the generated baseline is empty'),
9999
new InputOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Memory limit for analysis'),
100100
new InputOption('xdebug', null, InputOption::VALUE_NONE, 'Allow running with Xdebug for debugging purposes'),
101+
new InputOption('tmp-file', null, InputOption::VALUE_REQUIRED, '(Editor mode) Edited file used in place of --instead-of file'),
102+
new InputOption('instead-of', null, InputOption::VALUE_REQUIRED, '(Editor mode) File being replaced by --tmp-file'),
101103
new InputOption('fix', null, InputOption::VALUE_NONE, 'Launch PHPStan Pro'),
102104
new InputOption('watch', null, InputOption::VALUE_NONE, 'Launch PHPStan Pro'),
103105
new InputOption('pro', null, InputOption::VALUE_NONE, 'Launch PHPStan Pro'),
@@ -147,12 +149,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
147149

148150
$allowEmptyBaseline = (bool) $input->getOption('allow-empty-baseline');
149151

152+
$tmpFile = $input->getOption('tmp-file');
153+
$insteadOfFile = $input->getOption('instead-of');
154+
150155
if (
151156
!is_array($paths)
152157
|| (!is_string($memoryLimit) && $memoryLimit !== null)
153158
|| (!is_string($autoloadFile) && $autoloadFile !== null)
154159
|| (!is_string($configuration) && $configuration !== null)
155160
|| (!is_string($level) && $level !== null)
161+
|| (!is_string($tmpFile) && $tmpFile !== null)
162+
|| (!is_string($insteadOfFile) && $insteadOfFile !== null)
156163
|| (!is_bool($allowXdebug))
157164
) {
158165
throw new ShouldNotHappenException();
@@ -171,6 +178,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
171178
$level,
172179
$allowXdebug,
173180
$debugEnabled,
181+
$tmpFile,
182+
$insteadOfFile,
174183
);
175184
} catch (InceptionNotSuccessfulException $e) {
176185
return 1;
@@ -181,6 +190,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
181190
return $inceptionResult->handleReturn(1, null, $this->analysisStartTime);
182191
}
183192

193+
if ($inceptionResult->getEditorModeTmpFile() !== null) {
194+
if ($generateBaselineFile !== null) {
195+
$inceptionResult->getStdOutput()->getStyle()->error('Editor mode options --tmp-file and --instead-of cannot be used when generating the baseline.');
196+
return $inceptionResult->handleReturn(1, null, $this->analysisStartTime);
197+
}
198+
if ($fix) {
199+
$inceptionResult->getStdOutput()->getStyle()->error('Editor mode options --tmp-file and --instead-of cannot be used with PHPStan Pro.');
200+
return $inceptionResult->handleReturn(1, null, $this->analysisStartTime);
201+
}
202+
}
203+
184204
$errorOutput = $inceptionResult->getErrorOutput();
185205
$obsoleteDockerImage = $_SERVER['PHPSTAN_OBSOLETE_DOCKER_IMAGE'] ?? 'false';
186206
if ($obsoleteDockerImage === 'true') {
@@ -306,6 +326,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
306326
$debug,
307327
$inceptionResult->getProjectConfigFile(),
308328
$inceptionResult->getProjectConfigArray(),
329+
$inceptionResult->getEditorModeTmpFile(),
330+
$inceptionResult->getEditorModeInsteadOfFile(),
309331
$input,
310332
);
311333
} catch (Throwable $t) {

0 commit comments

Comments
 (0)