ModuleMaker.sh

#!/usr/bin/env bash
set -euo pipefail

if [ "$#" -lt 2 ]; then
  echo "Usage: $0 <module_machine_name> \"Human Name\""
  exit 1
fi

RAW="$1"
NAME="$2"

# -------------------------------
# Normalize machine name
# -------------------------------

STEP1="$(printf '%s' "$RAW" | sed -E 's/([a-z0-9])([A-Z])/\1_\2/g')"
STEP2="$(printf '%s' "$STEP1" | tr ' -' '_')"
STEP3="$(printf '%s' "$STEP2" | sed -E 's/[^a-zA-Z0-9_]//g')"
STEP4="$(printf '%s' "$STEP3" | sed -E 's/_+/_/g')"
MODULE="$(printf '%s' "$STEP4" | tr '[:upper:]' '[:lower:]')"

[ -z "$MODULE" ] && { echo "Invalid module name."; exit 1; }

CUSTOM_DIR="modules/custom"
MODULE_PATH="$CUSTOM_DIR/$MODULE"
BASE_NS="Drupal\\$MODULE"
LOGGER_SERVICE="logger.channel.$MODULE"

studly() {
  local m="$1"
  local out=""
  IFS='_' read -r -a parts <<< "$m"
  for part in "${parts[@]}"; do
    [ -z "$part" ] && continue
    first="$(printf '%s' "$part" | cut -c1 | tr '[:lower:]' '[:upper:]')"
    rest="$(printf '%s' "$part" | cut -c2-)"
    out="${out}${first}${rest}"
  done
  printf '%s' "$out"
}

CLASS_PREFIX="$(studly "$MODULE")"

CONTROLLER_CLASS="${CLASS_PREFIX}Controller"
SERVICE_CLASS="${CLASS_PREFIX}Service"
FORM_CLASS="${CLASS_PREFIX}SettingsForm"
BLOCK_CLASS="${CLASS_PREFIX}Block"
EVENT_CLASS="${CLASS_PREFIX}Event"
SUBSCRIBER_CLASS="${CLASS_PREFIX}Subscriber"

echo "Creating module: $MODULE"
echo "Namespace: $BASE_NS"

[ -d "$MODULE_PATH" ] && { echo "Module already exists."; exit 1; }

mkdir -p \
  "$MODULE_PATH/src/Controller" \
  "$MODULE_PATH/src/Service" \
  "$MODULE_PATH/src/Form" \
  "$MODULE_PATH/src/Block" \
  "$MODULE_PATH/src/Event" \
  "$MODULE_PATH/src/EventSubscriber" \
  "$MODULE_PATH/config/schema"

# ---------------------------------------------------
# info.yml
# ---------------------------------------------------

cat > "$MODULE_PATH/$MODULE.info.yml" <<EOF
name: '$NAME'
type: module
description: '$NAME'
core_version_requirement: ^9 || ^10 || ^11
package: Custom
configure: $MODULE.settings
EOF

# ---------------------------------------------------
# module + install
# ---------------------------------------------------

touch "$MODULE_PATH/$MODULE.module"
touch "$MODULE_PATH/$MODULE.install"

# ---------------------------------------------------
# permissions
# ---------------------------------------------------

cat > "$MODULE_PATH/$MODULE.permissions.yml" <<EOF
administer $MODULE:
  title: 'Administer $NAME'
  description: 'Configure $NAME.'
EOF

# ---------------------------------------------------
# routing
# ---------------------------------------------------

cat > "$MODULE_PATH/$MODULE.routing.yml" <<EOF
$MODULE.main:
  path: '/$MODULE'
  defaults:
    _controller: '$BASE_NS\\Controller\\$CONTROLLER_CLASS::content'
    _title: '$NAME'
  requirements:
    _permission: 'access content'

$MODULE.settings:
  path: '/admin/config/custom/$MODULE'
  defaults:
    _form: '$BASE_NS\\Form\\$FORM_CLASS'
    _title: '$NAME settings'
  requirements:
    _permission: 'administer $MODULE'
EOF

# ---------------------------------------------------
# menu links
# ---------------------------------------------------

cat > "$MODULE_PATH/$MODULE.links.menu.yml" <<EOF
$MODULE.settings:
  title: '$NAME settings'
  route_name: $MODULE.settings
  parent: system.admin_config
EOF

# ---------------------------------------------------
# services
# ---------------------------------------------------

cat > "$MODULE_PATH/$MODULE.services.yml" <<EOF
services:
  $MODULE.service:
    class: $BASE_NS\\Service\\$SERVICE_CLASS

  $MODULE.subscriber:
    class: $BASE_NS\\EventSubscriber\\$SUBSCRIBER_CLASS
    arguments: ['@$LOGGER_SERVICE']
    tags:
      - { name: event_subscriber }

  $LOGGER_SERVICE:
    parent: logger.channel_base
    arguments: ['$MODULE']
EOF

# ---------------------------------------------------
# Controller
# ---------------------------------------------------

cat > "$MODULE_PATH/src/Controller/$CONTROLLER_CLASS.php" <<EOF
<?php

namespace $BASE_NS\Controller;

use Drupal\Core\Controller\ControllerBase;

class $CONTROLLER_CLASS extends ControllerBase {

  public function content() {
    return [
      '#markup' => \$this->t('$NAME is installed.'),
    ];
  }

}
EOF

# ---------------------------------------------------
# Service
# ---------------------------------------------------

cat > "$MODULE_PATH/src/Service/$SERVICE_CLASS.php" <<EOF
<?php

namespace $BASE_NS\Service;

class $SERVICE_CLASS {

  public function status(): string {
    return '$NAME service active.';
  }

}
EOF

# ---------------------------------------------------
# Form
# ---------------------------------------------------

cat > "$MODULE_PATH/src/Form/$FORM_CLASS.php" <<EOF
<?php

namespace $BASE_NS\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

class $FORM_CLASS extends ConfigFormBase {

  protected function getEditableConfigNames(): array {
    return ['$MODULE.settings'];
  }

  public function getFormId(): string {
    return '${MODULE}_settings_form';
  }

  public function buildForm(array \$form, FormStateInterface \$form_state): array {
    \$config = \$this->config('$MODULE.settings');

    \$form['message'] = [
      '#type' => 'textfield',
      '#title' => \$this->t('Message'),
      '#default_value' => \$config->get('message') ?? '',
    ];

    return parent::buildForm(\$form, \$form_state);
  }

  public function submitForm(array &\$form, FormStateInterface \$form_state): void {
    \$this->config('$MODULE.settings')
      ->set('message', \$form_state->getValue('message'))
      ->save();

    parent::submitForm(\$form, \$form_state);
  }

}
EOF

# ---------------------------------------------------
# Block
# ---------------------------------------------------

cat > "$MODULE_PATH/src/Plugin/Block/$BLOCK_CLASS.php" <<EOF
<?php

namespace $BASE_NS\Plugin\Block;

use Drupal\Core\Block\BlockBase;

/**
 * @Block(
 *   id = "${MODULE}_${BLOCK_CLASS}",
 *   admin_label = @Translation("$NAME Block")
 * )
 */
class $BLOCK_CLASS extends BlockBase {

  public function build(): array {
    return [
      '#markup' => "$NAME block rendered.",
    ];
  }

}
EOF

# ---------------------------------------------------
# Event
# ---------------------------------------------------

cat > "$MODULE_PATH/src/Event/$EVENT_CLASS.php" <<EOF
<?php

namespace $BASE_NS\Event;

use Symfony\Contracts\EventDispatcher\Event;

class $EVENT_CLASS extends Event {

  public const EVENT_NAME = '$MODULE.event';

}
EOF

# ---------------------------------------------------
# Subscriber
# ---------------------------------------------------

cat > "$MODULE_PATH/src/EventSubscriber/$SUBSCRIBER_CLASS.php" <<EOF
<?php

namespace $BASE_NS\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Psr\Log\LoggerInterface;

class $SUBSCRIBER_CLASS implements EventSubscriberInterface {

  protected LoggerInterface \$logger;

  public function __construct(LoggerInterface \$logger) {
    \$this->logger = \$logger;
  }

  public static function getSubscribedEvents(): array {
    return [];
  }

}
EOF

# ---------------------------------------------------
# Schema
# ---------------------------------------------------

cat > "$MODULE_PATH/config/schema/$MODULE.schema.yml" <<EOF
$MODULE.settings:
  type: config_object
  label: '$NAME settings'
  mapping:
    message:
      type: string
      label: 'Message'
EOF

echo
echo "Module $MODULE created cleanly."
echo "Run: drush cr && drush en $MODULE"