Skip to content

MANUAL.md

Latest commit

 

History

History
219 lines (141 loc) · 4.39 KB

MANUAL.md

File metadata and controls

219 lines (141 loc) · 4.39 KB

Drupal Toolkit - User Manual

A powerful IntelliJ IDEA (PHPStorm, WebStorm) plugin for Drupal project maintainers.

Installation

Option 1: From JetBrains Marketplace

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

Option 2: Manual Installation

  1. Build the plugin: ./gradlew buildPlugin
  2. Download the zip from build/distributions/
  3. Open Settings → Plugins → ⚙ → Install Plugin from Disk
  4. Select the zip file and restart IDE

Getting Started

1. Open a Drupal Project

The plugin works with Drupal projects that have a composer.json file.

2. Access the Tool Window

  • Menu: View → Tool Windows → Drupal Toolkit
  • Shortcut: Ctrl+Shift+A → type "Drupal Toolkit"

Features

Project Detection

Automatically detects the Drupal project type:

  • Module (type: project-module)
  • Theme (type: project-theme)
  • Distribution (type: project-distribution)
  • Core (Drupal core itself)
  • Custom (custom project, not on Drupal.org)

Project Information

Displays stats from Drupal.org:

  • Machine name and type
  • Version and compatibility
  • Link to Drupal.org project page

Issues Browser

Browse issues from Drupal.org:

  • Filter by status, priority, component
  • Paginated list (20 per page)
  • Click to open issue in browser
  • Apply Patch: Download and apply patches from issues

Validation

Checks for required files:

  • composer.json
  • README.md or README.txt
  • .gitlab-ci.yml
  • *.info.yml (for modules/themes)

DDEV Integration

Manage local DDEV instances:

  • Start/Stop/Restart - Control DDEV
  • Describe - View project config
  • Logs - View container logs
  • SSH - Open terminal in container

Requirements:

  • DDEV installed (ddev --version)
  • Project has .ddev/config.yaml

Git/GitLab Integration

Git operations and GitLab integration:

  • Fetch - Pull latest changes
  • Create Branch - Create new branch
  • Commit - Stage and commit with conventional commit validation
  • Push - Push to remote
  • Shows current branch
  • Lists recent commits
  • Shows open merge requests from GitLab
  • Shows CI pipeline status

Requirements:

  • GitLab API token (optional, for GitLab features)

CI Local Execution

Run GitLab CI jobs locally:

  1. Click Run All CI Jobs in Pipelines tab
  2. Select a job from the dropdown
  3. Watch output in the text area

Settings

Access via Settings → Tools → Drupal Toolkit

Feature Toggles

Enable/disable tabs in the tool window:

  • Project Detection
  • Project Information
  • Issues Browser
  • Patch Management
  • DDEV Integration
  • GitLab Integration
  • Validation Tools
  • Testing Tools
  • Security Audit
  • AI Assistant
  • Help & Onboarding
  • Show Debug Messages - Enable debug notifications

API Configuration

  • GitLab Token - For GitLab API access (optional)

General Settings

  • Default Drupal Version - Default version for new projects
  • DDEV Path - Custom path to DDEV binary (optional)

Debug Mode

Enable debug messages to troubleshoot:

  1. Go to Settings → Tools → Drupal Toolkit
  2. Enable Show Debug Messages
  3. Click Apply

Debug messages show:

  • API calls being made
  • Errors and warnings
  • Plugin activity

Messages appear as IDE notifications.

Keyboard Shortcuts

Action Windows/Linux macOS
Open Tool Window Ctrl+Shift+A Cmd+Shift+A
Refresh Project Ctrl+R Cmd+R

Troubleshooting

No Project Detected

  • Ensure you're in a Drupal project with composer.json
  • Check the composer.json has valid project type

DDEV Not Working

GitLab Features Not Working

  • Add GitLab token in Settings → Drupal Toolkit → API Configuration
  • Token requires read_api scope

Plugin Not Showing

  • Check Settings → Plugins - ensure enabled
  • Check Settings → Tools - ensure Drupal Toolkit configured
  • Review Event Log: View → Tool Windows → Event Log

Building from Source

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

# Build plugin
./gradlew buildPlugin

# Run in IDE
./gradlew runIde

# Run tests
./gradlew test

License

GPL v2 - See LICENSE file.