Skip to content

Commit a9bbf62

Browse files
committed
Implement PR 60 from @gwharton
1 parent 7097c27 commit a9bbf62

File tree

4 files changed

+59
-18
lines changed

4 files changed

+59
-18
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
## [2.5.9] - 05 June 2025
10+
### Fixed
11+
- Add option to skip license validation in composer.json #62 @iranimij
12+
- Remove `Composer\Console\Input\InputArgument` #61 @frqnck
13+
- Add $moduleName to output messages where not currently implemented #60 @gwharton
14+
915
## [2.5.8] - 02 June 2025
1016
### Fixed
1117
- Suggest composer output CLI based on current composer.json

Console/Command/ScanCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ private function outputTable(OutputInterface $output, array $messages = []): int
184184
'Message',
185185
'Group',
186186
'Suggestion',
187-
'module'
187+
'Module'
188188
]);
189189

190190
foreach ($messages as $message) {

Scan/ScanComposerRequirements.php

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public function scan(string $moduleName, array $components)
5959
/**
6060
* @param Component $component
6161
* @param array $requirements
62+
* @param string $moduleName
6263
* @return void
6364
*/
6465
private function scanComponentWithComposerRequirements(
@@ -78,19 +79,26 @@ private function scanComponentWithComposerRequirements(
7879
return;
7980
}
8081

81-
$packageName = !empty($component->getPackageName()) ? $component->getPackageName() : $component->getComponentName();
82+
$packageName = !empty($component->getPackageName()) ? $component->getPackageName(
83+
) : $component->getComponentName();
8284

8385
$version = $component->getPackageVersion();
84-
$message = 'No composer dependency found for "' . $packageName . '"';
86+
$message = 'No composer dependency found for "'.$packageName.'"';
8587
$suggestion = sprintf('Current version is %s. ', $version);
8688
if ($this->composerProvider->shouldSuggestVersion($packageName)) {
8789
$suggestion .= sprintf('Perhaps use %s?', $this->composerProvider->getSuggestedVersion($version));
8890
}
8991

90-
$this->messageBucket->add($message, MessageGroupLabels::GROUP_MISSING_COMPOSER_DEP, $suggestion, $moduleName);
92+
$this->messageBucket->add(
93+
$message,
94+
MessageGroupLabels::GROUP_MISSING_COMPOSER_DEP,
95+
$suggestion,
96+
$moduleName
97+
);
9198
}
9299

93100
/**
101+
* @param string $moduleName
94102
* @param string $requirement
95103
* @param string $requirementVersion
96104
* @param Component[] $components
@@ -103,17 +111,21 @@ private function scanComposerRequirementWithComponents(
103111
array $components
104112
) {
105113
$this->checkIfRequirementIsNeeded($moduleName, $requirement, $components);
106-
$this->checkIfComposerRequirementUsesWildCard($requirement, $requirementVersion);
107-
$this->checkPhpVersion($requirement, $requirementVersion);
114+
$this->checkIfComposerRequirementUsesWildCard($moduleName, $requirement, $requirementVersion);
115+
$this->checkPhpVersion($moduleName, $requirement, $requirementVersion);
108116
}
109117

110118
/**
119+
* @param string $moduleName
111120
* @param string $requirement
112121
* @param array $components
113122
* @return void
114123
*/
115-
private function checkIfRequirementIsNeeded(string $moduleName, string $requirement, array $components)
116-
{
124+
private function checkIfRequirementIsNeeded(
125+
string $moduleName,
126+
string $requirement,
127+
array $components
128+
) {
117129
if ($this->runtimeConfig->isHideNeedless()) {
118130
return;
119131
}
@@ -130,12 +142,21 @@ private function checkIfRequirementIsNeeded(string $moduleName, string $requirem
130142
return;
131143
}
132144

133-
$message = 'Composer requirement "' . $requirement . '" possibly not needed';
145+
$message = 'Composer requirement "'.$requirement.'" possibly not needed';
134146
$this->messageBucket->add($message, MessageGroupLabels::GROUP_UNNECESSARY_COMPOSER_DEP);
135147
}
136148

137-
private function checkIfComposerRequirementUsesWildCard(string $requirement, string $requirementVersion)
138-
{
149+
/**
150+
* @param string $moduleName
151+
* @param string $requirement
152+
* @param string $requirementVersion
153+
* @return void
154+
*/
155+
private function checkIfComposerRequirementUsesWildCard(
156+
string $moduleName,
157+
string $requirement,
158+
string $requirementVersion
159+
) {
139160
if (preg_match('/^ext-/', $requirement)) {
140161
return;
141162
}
@@ -145,22 +166,31 @@ private function checkIfComposerRequirementUsesWildCard(string $requirement, str
145166
}
146167

147168
$version = $this->composerProvider->getVersionByComposerName($requirement);
148-
$message = 'Composer requirement "' . $requirement . '" set to wildcard version';
169+
$message = 'Composer requirement "'.$requirement.'" set to wildcard version';
149170
$suggestion = 'Current version is set to *. ';
150171
if ($this->composerProvider->shouldSuggestVersion($requirement)) {
151172
$suggestion .= sprintf('Perhaps use %s?', $this->composerProvider->getSuggestedVersion($version));
152173
}
153174

154-
$this->messageBucket->add($message, MessageGroupLabels::GROUP_WILDCARD_VERSION, $suggestion);
175+
$this->messageBucket->add(
176+
$message,
177+
MessageGroupLabels::GROUP_WILDCARD_VERSION,
178+
$suggestion,
179+
$moduleName
180+
);
155181
}
156182

157183
/**
184+
* @param string $moduleName
158185
* @param string $requirement
159186
* @param string $requirementVersion
160187
* @return void
161188
*/
162-
private function checkPhpVersion(string $requirement, string $requirementVersion)
163-
{
189+
private function checkPhpVersion(
190+
string $moduleName,
191+
string $requirement,
192+
string $requirementVersion
193+
) {
164194
if ($requirement !== 'php') {
165195
return;
166196
}
@@ -170,8 +200,13 @@ private function checkPhpVersion(string $requirement, string $requirementVersion
170200
return;
171201
}
172202

173-
$message = 'Required PHP version "' . $requirementVersion . '" does not match your current PHP version ' . $currentVersion;
174-
$this->messageBucket->add($message, MessageGroupLabels::GROUP_UNMET_REQUIREMENT);
203+
$message = 'Required PHP version "'.$requirementVersion.'" does not match your current PHP version '.$currentVersion;
204+
$this->messageBucket->add(
205+
$message,
206+
MessageGroupLabels::GROUP_UNMET_REQUIREMENT,
207+
'',
208+
$moduleName
209+
);
175210
}
176211

177212
/**

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "yireo/magento2-extensionchecker",
33
"license": "OSL-3.0",
44
"type": "magento2-module",
5-
"version": "2.5.8",
5+
"version": "2.5.9",
66
"homepage": "https://github.com/yireo/Yireo_ExtensionChecker",
77
"description": "Scan the code of a Magento module",
88
"keywords": [

0 commit comments

Comments
 (0)