sdc_devel

Provides development aids to Single-Directory Components developers.

Features

Component validator

Validate for errors and best practices:

• Component definition (YAML) with advanced checks and logic
• Component template (Twig) with static check of the syntax and the usage

With a drush command

 $ vendor/bin/drush sdcv --install my_theme
 [notice] Start validation of my_theme...
  ----------------- 
  Component          Severity   Message
 ----------------- 
local-tasks          Warning    Deprecated Twig filter: `spaceless`. The spaceless filter is deprecated as o
page                 Warning    Use slots instead of hard embedding a component in the template with `embed`
form-element-label   Error      Unknown variable: `title_display`.
form-element-label   Warning    The exact same as just testing the variable, empty is not needed. 
dropdown-menu        Error      Array of empty object. 
dropdown-menu        Warning    `is iterable` test is too ambiguous. Use `is sequence` or `is mapping`.               

In the admin UI

As a PHPUnit Kernel test

A test Kernel class to extend is enough to run the Validator with PHPUnit.

use Drupal\Tests\sdc_devel\Kernel\SdcDevelComponentKernelTestBase;
use PHPUnit\Framework\Attributes\CoversNothing;

#[CoversNothing]
final class ComponentValidatorTest extends SdcDevelComponentKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    '_my_module_with_component_',
  ];

  /**
   * {@inheritdoc}
   */
  protected static $themes = [
    '_my_theme_with_component_',
  ];
}

UI Suite Initiative

This module, was previously know as ui_patterns_devel and part of UI Patterns 2 codebase.

SDC Devel can be used as standalone, but shines with other UI Suite modules. Together, they provide a a full API to implement full design systems while preserving and improving the Drupal site building experience:

Similar projects

Component Libraries: Devel also provides a component definition validator, focused on JSON schema validation.