Automate generation of Drupal Entities from Drupal Spec Tool

acquia / drupal-spec-tool

A tool for specifying Drupal architecture details and generating automated tests for them.

GNU General Public License v2.0

149 stars 36 forks source link

Automate generation of Drupal Entities from Drupal Spec Tool #46

Open vyasamit2007 opened 4 years ago

vyasamit2007 commented 4 years ago

Description

Drupal spec tool currently generates only test cases, We aim to extend this tool to build Drupal entities using the architecture defined in the DST sheet.

High-level technical architecture

Create a new composer plugin which will provide a command(s).
This command will read and collect data from the DST sheet using Google Sheet APIs
This will depend on Drupal and will create Drupal entities.

Note: This is still in the ideation stage and the low-level details are yet to be finalized.

TravisCarden commented 4 years ago

Hi, @vyasamit2007. Thanks so much for working on this! It's a feature I've always wanted but never found time to work on. A couple of notes for you:

The new command(s) should be a Drush command(s). We'll want to use the CLI tool most people are already using, and we'll want to take advantage of its feature set, especially site alias handling. We'll ultimately need to release it as a separate package so that composer/installers can put both components in the right place. I'll coordinate that when the time comes.
You can find an example of interacting with the Google Sheet in nickwilde1990/drupal-spec-tool-commands

tgifford-webfirst commented 3 years ago

Another alternative would be to generate the config files, e.g.

{entity_type}.type.{bundle}.yml
core.entity_form_display.{entity_type}.{bundle}.default.yml
core.entity_view_display.{entity_type}.{bundle}.default.yml
core.entity_view_display.{entity_type}.{bundle}.teaser.yml
field.field.{entity_type}.{bundle}.{field_name}.yml
(optional) core.base_field_override.{entity_type}.{bundle}.status.yml
etc.

And rely on devs to diff/merge.

vyasamit2007 commented 2 years ago

We have come up with a new tool Drupal Entity Generator (DEG) https://github.com/acquia-pso/dst-entity-generate. This is a tool to build Drupal entities using the architecture defined in the Google spreadsheet. We recommend using a Drupal Spec Tool for creating the Google spreadsheet to define the content architecture for your Drupal site.

We can close this issue because that tool does exactly what is intended in the original thread here.

tgifford-webfirst commented 2 years ago

Link? https://github.com/acquia-pso/dst-entity-generate

monaw commented 1 year ago

Note: Drupal Entity Generator is currently using the older version v4.0.1 of the Drupal Spec Tool...

vyasamit2007 commented 1 year ago

Note: Drupal Entity Generator is currently using the older version v4.0.1 of the Drupal Spec Tool...

Created issue under DEG repo - https://github.com/acquia-pso/dst-entity-generate/issues/204