Add enforced config dependencies on export

Created on 29 November 2022, over 2 years ago

Updated 12 July 2023, almost 2 years ago

Problem/Motivation

When exporting config to a module, I usually also want that config to be dependent on the module. That is, the config should only be present when the module is installed, and removed when it is uninstalled.

Drupal provides a way to define additional config dependencies using the enforced key. https://www.drupal.org/node/2404447 →

Without an enforced dependency on the module, you will not be able to reinstall the module after uninstalling it, because the module config will already exist in the active configuration.

What I have been doing is manually adding the enforced dependencies to the exported config and then importing them back to the site. However this is quite tedious and I wonder if there is any way it can be automated.

Steps to reproduce

1. Use config devel to export some config to a custom module.
2. Uninstall the custom module. Note that the exported config is still present in the active config.
3. Try to install the module again.
4. Installation will fail with an error.

Proposed resolution

Perhaps add the enforced dependency automatically on export. But I am not sure whether this will have unintended consequences.

Remaining tasks

User interface changes

API changes

Data model changes

✨ Feature request

Status

Active

Version

1.0

Component

Code

Created by

🇭🇰Hong Kong phparkle

Live updates comments and jobs are added and updated live.

Incomplete comments

Merge Requests

!10Add enforced config dependencies on export
Open
🇦🇲Armenia murz
updated about 1 month ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment almost 2 years ago →
🇮🇹Italy kopeboy Milan
Very interested in this as well!
There must be a way of automating the "enforced" string in the yamls?!
A good place for adding this feature is either here or in config_enforce_devel (which has a UI on every config form!)
First commit to issue fork.
Merge request !10Issue #3324338: Add enforced config dependencies on export → (Open) created by murz
Comment about 1 month ago →
🇦🇲Armenia murz Yerevan, Armenia
I very need this feature for my custom modules, so implemented the functionality and created a MR https://git.drupalcode.org/project/config_devel/-/merge_requests/10 - please review.
Comment 10 days ago →
🇦🇲Armenia murz Yerevan, Armenia
Attach a static patch file with those changes, to make it possible to use in composer until 🐛 GitLab Merge Requests Unable to Generate Incremental Patch Files Active is resolved.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024