Drupal Toolkit

IntelliJ Platform Plugin for Drupal Project Maintainers

A powerful IntelliJ IDEA (PHPStorm, WebStorm) plugin that helps Drupal project maintainers with everyday tasks including project identification, issue management, GitLab integration, code validation, testing, and security audits.

Features

• Project Detection - Automatically detects Drupal project type (module, theme, distribution, custom) from composer.json
• Project Information - Displays Drupal.org statistics (install count, compatibility)
• Issue Management - Browse, filter, and manage project issues from Drupal.org
• Patch Management - Download and apply patches directly from issues
• ddev Integration - Local development environment management
• Git/GitLab Integration - Branch management, commit validation, CI pipeline status
• CI Local Execution - Run GitLab CI jobs locally
• Code Validation - Check for required files (composer.json, README.md, .gitlab-ci.yml)
• Conventional Commits - Validate commit messages

Installation

From JetBrains Marketplace

1. Open Settings → Plugins
2. Search for "Drupal Toolkit"
3. Click Install

Manual Installation

1. Build the plugin: ./gradlew buildPlugin
2. Open Settings → Plugins → ⚙ → Install Plugin from Disk
3. Select build/distributions/drupal-toolkit-*.zip

Development

Prerequisites

• IntelliJ IDEA 2024.2+ (Ultimate or Community)
• JDK 17+
• Gradle 9.0+

Setup

# Clone the repository
git clone https://github.com/drupaltools/drupal-toolkit.git
cd drupal-toolkit

# Open in IntelliJ IDEA
idea .

Development Commands

# Run IDE with plugin installed (for testing)
./gradlew runIde

# Build the plugin
./gradlew buildPlugin

# Run tests
./gradlew test

# Clean build
./gradlew clean build

# Build with verbose output
./gradlew build --info

Using LivePlugin for Hot-Reload

For faster development iteration without restarting the IDE:

1. Install LivePlugin from marketplace
2. Build plugin: ./gradlew buildPlugin
3. In LivePlugin settings, add your built plugin zip from build/distributions/
4. Make code changes → rebuild → click "Reload" in LivePlugin

Project Structure

drupal-toolkit/
├── src/
│   ├── main/
│   │   ├── kotlin/com/github/drupaltools/drupaltoolkit/
│   │   │   ├── api/              # API clients (Drupal.org, GitLab)
│   │   │   ├── detector/        # Project detection
│   │   │   ├── services/         # Business logic (Git, ddev, CI)
│   │   │   ├── settings/         # Plugin settings
│   │   │   ├── toolWindow/       # Tool window UI and panels
│   │   │   └── DrupalToolkitPlugin.kt
│   │   └── resources/
│   │       ├── icons/            # Plugin icons
│   │       └── META-INF/         # Plugin configuration
│   └── test/                    # Unit tests
├── build.gradle.kts
├── gradle.properties
└── README.md

Configuration

Access plugin settings via File → Settings → Tools → Drupal Toolkit

Features (Toggleable)

• Project Info Tab
• Issues Tab
• Validation Tab
• Ddev Tab
• Git Tab
• Testing Tab
• Security Tab
• Help Tab

API Keys (Optional)

• Drupal.org API Key - For fetching project issues
• GitLab Token - For GitLab integration

License

MIT License - see LICENSE for details.

Contributing

Contributions are welcome! Please read our contributing guidelines first.

Links

• GitHub Repository
• Issue Tracker