add Hyvä compatibility checker command #59
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- New command: mageforge:hyva:compatibility:check (aliases: m:h:c:c, hyva:check) - Scans Magento modules for Hyvä theme incompatibilities - Detects RequireJS, Knockout.js, jQuery, UI Components usage - Options: --show-all, --third-party-only, --include-vendor, --detailed - Service layer: CompatibilityChecker, ModuleScanner, IncompatibilityDetector - Exit code 1 for critical issues, 0 for success - Updated CI/CD workflow and documentation
- Changed default behavior from 0 modules to third-party modules (18) - Without flags: Scans third-party only (excludes Magento_*) - With --include-vendor: Scans all 394 modules including Magento core - Updated documentation to reflect new default behavior
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive Hyvä theme compatibility checker command to MageForge, enabling developers to scan Magento modules for incompatibilities with the Hyvä theme framework. The command detects RequireJS, Knockout.js, jQuery, and UI Components usage that would be problematic in a Hyvä environment.
Key changes:
- New CLI command with multiple aliases (mageforge:hyva:compatibility:check, m:h:c:c, hyva:check)
- Service layer architecture with three dedicated classes for scanning, detection, and orchestration
- Pattern-based detection for JavaScript, XML, and PHTML files with severity classification
- Multiple filtering options and detailed reporting capabilities
- CI/CD integration and comprehensive documentation
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 25 comments.
Show a summary per file
| File | Description |
|---|---|
| src/etc/di.xml | Registers the new CompatibilityCheckCommand in Magento's dependency injection configuration |
| src/Console/Command/Hyva/CompatibilityCheckCommand.php | Main command class implementing the CLI interface with options for filtering and detailed output |
| src/Service/Hyva/CompatibilityChecker.php | Orchestrator service that coordinates module scanning and result formatting |
| src/Service/Hyva/ModuleScanner.php | Service for recursively scanning module directories and checking for Hyvä compatibility packages |
| src/Service/Hyva/IncompatibilityDetector.php | Pattern matching service that detects incompatible code patterns in various file types |
| docs/commands.md | Comprehensive documentation of the new command including usage examples, patterns detected, and recommendations |
| .github/workflows/magento-compatibility.yml | Updated CI workflow to test the new command with help output validation |
| 'severity' => self::SEVERITY_WARNING, | ||
| ], | ||
| [ | ||
| 'pattern' => '/mage\//', |
There was a problem hiding this comment.
The pattern for detecting Magento RequireJS module references (/mage\//) on line 40 is too broad. This will match any occurrence of the string "mage/" including in comments, strings, or URLs. Consider using a more specific pattern that checks for RequireJS context, such as within define() or require() calls, or as part of a path string in quotes.
Suggested change
| 'pattern' => '/mage\//', | |
| 'pattern' => '/(?:define|require)\s*\(\s*\[[^\]]*["\']mage\/[^"\']*["\']/', |
dermatz
changed the title
- Interactive mode activated when no options provided - Multi-select menu for scan options: * Show all modules * Include Magento core modules * Detailed file-level issues - Displays selected configuration before scan - Falls back to direct mode if interactive fails - Consistent with theme:build command UX
- New option: Show only incompatible modules (pre-selected by default) - Improves UX by filtering out compatible modules - Users can still choose 'Show all' for complete overview - Configuration display updated to reflect selection
Contributor
Co-authored-by: Copilot <[email protected]>
Contributor
Co-authored-by: Copilot <[email protected]>
* Initial plan * Add actual execution tests for Hyvä compatibility checker command Co-authored-by: dermatz <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: dermatz <[email protected]> Co-authored-by: Mathias Elle <[email protected]>
#61) * Initial plan * Clarify exit code documentation for Hyvä compatibility checker Co-authored-by: dermatz <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: dermatz <[email protected]> Co-authored-by: Mathias Elle <[email protected]>
dermatz
changed the title
9 tasks
Co-authored-by: Copilot <[email protected]>
Collaborator
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
7 tasks
Contributor
Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: Mathias Elle <[email protected]>
Co-authored-by: Copilot <[email protected]>
Comment on lines
372
to
374
| // Additional check: try to detect if running in a proper TTY | ||
| $sttyOutput = shell_exec('stty -g 2>/dev/null'); | ||
| return !empty($sttyOutput); |
There was a problem hiding this comment.
The shell_exec call at line 373 executes a system command without proper validation or sanitization. While 'stty -g 2>/dev/null' is a static string here, using shell_exec can be risky. Consider using a safer alternative or at least document why this approach is necessary for TTY detection.
Suggested change
| // Additional check: try to detect if running in a proper TTY | |
| $sttyOutput = shell_exec('stty -g 2>/dev/null'); | |
| return !empty($sttyOutput); | |
| // Additional check: detect if running in a proper TTY without using shell_exec | |
| if (\function_exists('stream_isatty')) { | |
| return @\stream_isatty(STDIN); | |
| } | |
| if (\function_exists('posix_isatty')) { | |
| return @\posix_isatty(\STDIN); | |
| } | |
| // Conservative default if no TTY-detection functions are available | |
| return false; |
Collaborator
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Contributor
…terns, enhance security (#65) * Initial plan * Apply code review feedback: fix duplicate di.xml, improve regex patterns, safer environment handling Co-authored-by: dermatz <[email protected]> * Replace error suppression with explicit exception handling in TTY detection Co-authored-by: dermatz <[email protected]> * Fix RequireJS pattern regex to properly match module references Co-authored-by: dermatz <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: dermatz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.