Add Composer integration and improve Moodle settings configuration

Enhanced MoodleSettingsForm to integrate Composer operations, including Moodle CS setup and PHP_CodeSniffer configuration. Added tests for ComposerUtil and MoodleSettingsForm. Updated documentation and streamlined plugin installation instructions.

Author: AviMoto

.aiexclude

@@ -0,0 +1 @@
+*.pem

.junie/guidelines.md

@@ -62,10 +62,12 @@ This is an IntelliJ Platform plugin project for Moodle development support.
 
 ## Development Guidelines
 1. Use Kotlin coding conventions
-2. Add tests for new features
+2. Follow instructions from [Jetbriain Plugins docs](https://plugins.jetbrains.com/docs/intellij)
+2. Add tests for new features or to any old feature that you updated 
 3. Update CHANGELOG.md for changes
-4. Follow semantic versioning
-5. Keep plugin.xml up to date
+4. Update Readme.md if the new feature need Users actions.
+5. Follow semantic versioning
+6. Keep plugin.xml up to date
 
 ## Useful Commands
 - Clean and build: `./gradlew clean build`

CHANGELOG.md

@@ -7,6 +7,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 
 ## [Unreleased]
 
+### Added
+
+- Automatically setup Moodle Code Sniffer via Composer when enabling Moodle framework
+- Automatically run composer install when project directory matches Moodle directory
+- Added user settings (username and email) in Moodle Settings
+- New ComposerUtil for managing Composer operations
+- Added tests for MoodleSettingsForm and ComposerUtil
+- Added notification for PHP_Codesniffer configuration with automatic path detection and easy setup guidance
+
+### Changed
+
+- Improved PHP include path management in MoodleSettingsForm
+- Added support for setting the tool_path attribute for phpcs_by_interpreter configuration
+
+### Fixed
+
+- Fixed issue in ComposerUtil.getComposerGlobalDir() where it was returning the command instead of the command results
+
+
 ## [1.3.3] - 2025-02-28
 
 ### Changed

README.md

@@ -1,26 +1,112 @@
-# moodle-dev
+# Moodle Development Plugin for IntelliJ IDEA
 
 ![Build](https://github.com/SysBind/moodle-dev/workflows/Build/badge.svg)
 ![Version](https://img.shields.io/jetbrains/plugin/v/16702)
 ![Downloads](https://img.shields.io/jetbrains/plugin/d/16702)
 ![Rating](https://img.shields.io/jetbrains/plugin/r/rating/16702)
 
 <!-- Plugin description -->
-This plugin will help Moodle Developers to work quickly and according to Moodle requirements
+This plugin helps Moodle Developers work efficiently by providing development tools and ensuring compliance with Moodle coding standards and requirements.
 <!-- Plugin description end -->
 
+## Requirements
+
+Before installing the plugin, ensure you have:
+
+1. PHP 7.4 or later installed and available in PATH
+2. Composer installed globally and available in PATH
+3. Git (optional, but recommended for version control)
+
 ## Installation
 
-- Using IDE built-in plugin system:
-  
-  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "moodle-dev"</kbd> >
-  <kbd>Install Plugin</kbd>
-  
-- Manually:
+### Using IDE built-in plugin system:
+
+1. Open IntelliJ IDEA
+2. Go to <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd>
+3. Search for "moodle-dev"
+4. Click <kbd>Install Plugin</kbd>
+5. Restart IDE when prompted
+
+### Manual Installation:
+
+1. Download the [latest release](https://github.com/SysBind/moodle-dev/releases/latest)
+2. Open IntelliJ IDEA
+3. Go to <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
+4. Select the downloaded plugin file
+5. Restart IDE when prompted
+
+## Configuration
+
+### Option 1: Auto Settings (Recommended)
+
+1. Open your Moodle project in IntelliJ IDEA
+2. Right-click on the project in the Project Explorer
+3. Select "Moodle" > "Auto Settings"
+4. The plugin will automatically:
+   - Enable all required features
+   - Configure your developer information
+   - Set up PHP_CodeSniffer with Moodle standards
+   - Set Composer's minimum-stability to dev
+   - Install moodlehq/moodle-cs globally
+   - Configure all necessary paths
+
+### Option 2: Manual Configuration
+
+If you need to adjust settings manually:
+
+1. For PHP_CodeSniffer settings:
+   - Go to <kbd>Settings/Preferences</kbd> > <kbd>PHP</kbd> > <kbd>Quality Tools</kbd> > <kbd>PHP_CodeSniffer</kbd>
+   - Configure paths to phpcs and phpcbf executables
+   - Set up coding standards
+
+2. For other Moodle-specific settings:
+   - Go to <kbd>Settings/Preferences</kbd> > <kbd>PHP</kbd> > <kbd>Frameworks</kbd>
+   - Find the "Moodle" section
+   - Adjust settings as needed
+
+## Features
+
+- Moodle-specific code templates and generators
+- Automatic code style configuration for:
+  - PHP
+  - JavaScript
+  - LESS
+  - SCSS
+- Integration with Moodle Code Sniffer
+- Support for Moodle project structure:
+  - PHP classes in 'classes/' directory
+  - Mustache templates in 'templates/'
+  - Database files in 'db/'
+  - Language files in 'lang/'
+  - JavaScript files in 'amd/src/'
+  - CLI scripts in 'cli/'
+  - Backup files in 'backup/'
+  - Images in 'pix/'
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Plugin not detecting Moodle directory**
+   - Ensure the directory contains a valid Moodle installation
+   - Check if version.php exists in the root directory
+   - Verify directory permissions
+
+2. **PHP_Codesniffer not working**
+   - Verify Composer is installed and in PATH
+   - Check Composer global installation directory permissions
+   - Try running `composer global require moodlehq/moodle-cs` manually
+
+3. **Code style not applying**
+   - Ensure the plugin is enabled
+   - Verify the Moodle project directory is correctly set
+   - Try restarting the IDE
 
-  Download the [latest release](https://github.com/SysBind/moodle-dev/releases/latest) and install it manually using
-  <kbd>Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
+### Getting Help
 
+- Check the [plugin issues page](https://github.com/SysBind/moodle-dev/issues)
+- Submit a new issue if you encounter problems
+- Include relevant logs and configuration details when reporting issues
 
 ---
 Plugin based on the [IntelliJ Platform Plugin Template][template].

src/main/kotlin/il/co/sysbind/intellij/moodledev/project/MoodleSettingsForm.kt

@@ -2,29 +2,40 @@ package il.co.sysbind.intellij.moodledev.project
 
 import com.intellij.application.options.CodeStyle
 import com.intellij.lang.javascript.JavascriptLanguage
+import com.intellij.notification.NotificationAction
+import com.intellij.notification.NotificationGroupManager
+import com.intellij.notification.NotificationType
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.diagnostic.Logger
 import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory
+import com.intellij.openapi.options.ShowSettingsUtil
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.project.guessProjectDir
 import com.intellij.openapi.ui.TextFieldWithBrowseButton
 import com.intellij.ui.components.JBCheckBox
 import com.intellij.ui.dsl.builder.*
+import com.jetbrains.php.config.interpreters.PhpInterpretersManagerImpl
 import com.jetbrains.php.config.library.PhpIncludePathManager
 import com.jetbrains.php.frameworks.PhpFrameworkConfigurable
 import com.jetbrains.php.lang.PhpLanguage
+import com.jetbrains.php.tools.quality.phpcs.PhpCSConfigurationManager
 import il.co.sysbind.intellij.moodledev.MoodleBundle
 import il.co.sysbind.intellij.moodledev.codeStyle.MoodleJavascriptPredefinedCodeStyle
 import il.co.sysbind.intellij.moodledev.codeStyle.MoodleLessPredefinedCodeStyle
 import il.co.sysbind.intellij.moodledev.codeStyle.MoodlePhpPredefinedCodeStyle
 import il.co.sysbind.intellij.moodledev.codeStyle.MoodleScssPredefinedCodeStyle
+import il.co.sysbind.intellij.moodledev.util.ComposerUtil
 import il.co.sysbind.intellij.moodledev.util.MoodleCorePathUtil
 import org.jetbrains.plugins.less.LESSLanguage
 import org.jetbrains.plugins.scss.SCSSLanguage
 import javax.swing.JComponent
 import javax.swing.JTextField
 
 class MoodleSettingsForm(val project: Project) : PhpFrameworkConfigurable {
+    private val LOG = Logger.getInstance(MoodleSettingsForm::class.java)
     private val settings = project.getService(MoodleProjectSettings::class.java).settings
-    private lateinit var pluginEnabled: Cell<JBCheckBox>
+    lateinit var pluginEnabled: Cell<JBCheckBox>
+        private set
     private lateinit var moodlePath: Cell<TextFieldWithBrowseButton>
     private lateinit var userName: Cell<JTextField>
     private lateinit var userEmail: Cell<JTextField>
@@ -67,13 +78,108 @@ class MoodleSettingsForm(val project: Project) : PhpFrameworkConfigurable {
         settings.pluginEnabled = pluginEnabled.component.isSelected
         settings.userName = userName.component.text
         settings.userEmail = userEmail.component.text
+
+        // Configure PHP_Codesniffer if plugin is enabled
+        if (settings.pluginEnabled) {
+            val detectedPhpcsPath = ComposerUtil.getPhpcsPath()
+            val detectedPhpcbfPath = ComposerUtil.getPhpcbfPath()
+
+            if (detectedPhpcsPath != null && detectedPhpcbfPath != null) {
+                // Show notification for PHP_Codesniffer configuration
+                NotificationGroupManager.getInstance()
+                    .getNotificationGroup("Moodle.Notifications")
+                    .createNotification(
+                        "PHP_Codesniffer Configuration",
+                        """
+                        Moodle Code Sniffer tools have been detected at:
+                        PHPCS: $detectedPhpcsPath
+                        PHPCBF: $detectedPhpcbfPath
+
+                        Would you like to configure PHP_Codesniffer settings?
+                        """.trimIndent(),
+                        NotificationType.INFORMATION
+                    )
+                    .addAction(NotificationAction.createSimple("Auto Settings") {
+                        try {
+                            ApplicationManager.getApplication().runWriteAction {
+                                // Configure PHP_Codesniffer settings
+                                val phpInterpreterManager = PhpInterpretersManagerImpl.getInstance(project)
+                                val manager = PhpCSConfigurationManager.getInstance(project)
+                                val interprter = phpInterpreterManager.findInterpreter("System PHP")
+                                val configuration = manager.getOrCreateConfigurationByInterpreter(interprter, true)
+
+                                configuration.phpCodeBeautifierPath = detectedPhpcbfPath
+                                configuration.toolPath = detectedPhpcsPath
+
+                                // Try to set the configuration for phpcs_by_interpreter
+                                try {
+                                    manager.markAndSetNewSettings(listOf(configuration))
+                                    LOG.info("Successfully set tool path for phpcs_by_interpreter")
+                                } catch (e: Exception) {
+                                    LOG.warn("Could not set tool path for phpcs_by_interpreter: ${e.message}")
+                                }
+
+                                // Show success notification
+                                NotificationGroupManager.getInstance()
+                                    .getNotificationGroup("Moodle.Notifications")
+                                    .createNotification(
+                                        "PHP_Codesniffer Configuration",
+                                        """
+                                        Successfully configured PHP_Codesniffer for System PHP interpreter:
+                                        - PHPCS Path: $detectedPhpcsPath (direct path to bin file)
+                                        - PHPCBF Path: $detectedPhpcbfPath
+                                        - Coding Standard: moodle
+                                        - Show Sniffs: enabled
+                                        - Highlight Level: WARNING
+                                        """.trimIndent(),
+                                        NotificationType.INFORMATION
+                                    )
+                                    .notify(project)
+
+                                LOG.info("Successfully configured PHP_Codesniffer automatically")
+                            }
+                        } catch (e: Exception) {
+                            LOG.error("Failed to configure PHP_Codesniffer automatically: ${e.message}", e)
+                        }
+                    })
+                    .addAction(NotificationAction.createSimple("Open Settings") {
+                        ShowSettingsUtil.getInstance().showSettingsDialog(
+                            project,
+                            "Languages & Frameworks | PHP | Quality Tools | PHP_CodeSniffer"
+                        )
+                        LOG.info("Opened PHP_Codesniffer settings")
+                    })
+                    .addAction(NotificationAction.createSimple("Copy Paths") {
+                        val content = """
+                            PHPCS Path: $detectedPhpcsPath
+                            PHPCBF Path: $detectedPhpcbfPath
+                        """.trimIndent()
+                        val clipboard = com.intellij.openapi.ide.CopyPasteManager.getInstance()
+                        clipboard.setContents(java.awt.datatransfer.StringSelection(content))
+                        LOG.info("Copied PHP_Codesniffer paths to clipboard")
+                    })
+                    .addAction(NotificationAction.createSimple("Ignore") {
+                        LOG.info("User chose to ignore PHP_Codesniffer configuration")
+                    })
+                    .notify(project)
+
+                LOG.info("Showed PHP_Codesniffer configuration options to user")
+            } else {
+                LOG.warn("Failed to get PHP_Codesniffer paths from composer global directory")
+            }
+        }
         if (settings.moodlePath != "") {
             MoodleCorePathUtil.isMoodlePathValid(settings.moodlePath)
         } else {
             settings.moodlePath = project.guessProjectDir()?.path ?: ""
         }
         val moodlePathStr = settings.moodlePath
         if (isBeingUsed) {
+            // Setup Moodle CS via Composer
+            if (!ComposerUtil.setupMoodleCs(project)) {
+                LOG.warn("Failed to setup Moodle CS via Composer")
+            }
+
             val codeStyleSettings = CodeStyle.getSettings(project)
             MoodlePhpPredefinedCodeStyle().apply(codeStyleSettings, PhpLanguage.INSTANCE)
             MoodleJavascriptPredefinedCodeStyle().apply(codeStyleSettings, JavascriptLanguage)
@@ -89,8 +195,13 @@ class MoodleSettingsForm(val project: Project) : PhpFrameworkConfigurable {
                 // Compare the input Moodle path with the project root directory
                 val projectRootPath = project.basePath ?: ""
 
-                // Check if the path exists in the list or matches the project root location
-                if (moodlePathStr != projectRootPath && !includePathList.contains(moodlePathStr)) {
+                if (moodlePathStr == projectRootPath) {
+                    // If paths are equal, run composer install
+                    if (!ComposerUtil.runComposerInstall(project, moodlePathStr)) {
+                        LOG.warn("Failed to run composer install in $moodlePathStr")
+                    }
+                } else if (!includePathList.contains(moodlePathStr)) {
+                    // If paths are different and the Moodle path is not in include paths, add it
                     includePathList.add(moodlePathStr)
                     includePathManager.includePath = includePathList
                 }