module-scaffold

Drupal Module Scaffolding

Create a new Drupal module following best practices.

Usage: /module-scaffold [module_name]

If a module name is provided as an argument, use it directly. Otherwise, prompt the user for requirements.

Step 1: Research First

Before creating a custom module, ask the developer:

1. "What functionality do you need?"
2. "Have you searched drupal.org for existing modules that provide this?"
3. "Would you like me to search for contrib alternatives first?"

If developer hasn't researched:

• Offer to search drupal.org/project/project_module
• Look for modules with: security coverage, active maintenance, D10/11 compatibility
• Only proceed with custom module if no suitable contrib exists

Step 2: Gather Requirements

Ask the developer for:

1. Module machine name (e.g., my_module)
   • Must be lowercase, underscores only, start with letter
2. Module human name (e.g., "My Module")
3. Module description (one sentence)
4. What the module needs:
   • Custom service?
   • Custom block plugin?
   • Custom form (config or regular)?
   • Custom controller/page?
   • Custom permissions?
   • Event subscriber?
   • Custom entity? (complex - confirm needed)

Step 3: Generate Structure

Always Create

my_module.info.yml

name: 'Module Name'
type: module
description: 'Module description.'
core_version_requirement: ^10 || ^11
package: Custom

my_module.module

<?php

/**
 * @file
 * Primary module hooks for My Module.
 */

If Service Needed

my_module.services.yml

services:
  my_module.example:
    class: Drupal\my_module\Service\ExampleService
    arguments: ['@entity_type.manager', '@current_user']

src/Service/ExampleService.php

<?php

namespace Drupal\my_module\Service;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Session\AccountProxyInterface;

/**
 * Example service with dependency injection.
 */
final class ExampleService {

  public function __construct(
    protected EntityTypeManagerInterface $entityTypeManager,
    protected AccountProxyInterface $currentUser,
  ) {}

  /**
   * Example method.
   */
  public function doSomething(): void {
    // Implementation here.
  }

}