Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Inspired by #1938570: Make views active config save format match the default yml file (order and quotes)
Problem/Motivation
Some active config files (like sites/default/files/config__rzyR0s0KXhc9jjr4I7HQl3nK300t-85ew12vzYGO2A/active/something.else.whatever.yml) are saved with a different format than the default yml files (under core modules config directories like core/modules/something/config/something.else.whatever.yml).
Proposed resolution
check the files by resaving configurations, and diffing them.
open issues for ones that differ, and add to the list of issues in the issue summary.
make a comment here and update the issue summary for ones that are confirmed to match.
Remaining tasks
make a list of ones that need to be checked.
Sub-Issues
- #1938570: Make views active config save format match the default yml file (order and quotes)
- #1928082: Make usage of book.settings:allowed_types consistent
- #1942110: Make breakpoint active config save format match the default yml file.
- #1942120: Make Contact module active config save format match the default yml file.
- #1942130: Make Forum module active config save format match the default yml file.
- #1942134: Make Image module active config save format match the default yml file.
- #1942144: Make Language module active config save format match the default yml file.
- #1942148: Make Locale module active config save format match the default yml file.
- #1942152: Make Menu module active config save format match the default yml file.
- #1942154: Make OpenID module active config save format match the default yml file.
- #1942168: Make System module active config save format match the default yml file.
- #1942170: Make Taxonomy module active config save format match the default yml file.
- #1942174: Make Toolbar module active config save format match the default yml file.
- #1942178: Make User module active config save format match the default yml file.
Files checked that are ok and do not need issues
- action.settings.yml
- aggregator.settings.yml
- book.settings.yml
- dblog.settings.yml
- file.settings.yml
- field.settings.yml
- node.settings.yml
- search.settings.yml
- filter.format.php_code.yml
- rest.settings.yml
- shortcut.settings.yml
- simpletest.settings.yml
- statistic.settings.yml
- text.settings.yml
- tracker.settings.yml
- update.settings.yml
Files checked that are not very sure or need further review
- translation.settings.yml
- translation_entity.settings.yml
User interface changes
No UI changes.
API changes
No API changes.
Steps to reproduce#
- Install as usual
- Install the module that needs check and visit the module's config folder for the configuration file name
- find the same file in sites/default/files/config_[hash]/active folder.
- Compare both files with some diff tool
Coding standards#
- Do not use double quotes for strings, use single quotes.
- Use single quotes for label values even if they are one word for consistency.
- Never use quotes for key definitions and types (in Drupal, key names and types are strings by definition and should not have spaces).
- In Drupal, integer values contained YAML config data files are cast to string and therefore are wrapped in single quotes.
- Watch your indentation levels. This is not a code style requirement per say, since it is important to use proper indentation in YAML so you get the desired schema structure.
Comments
Comment #1
YesCT CreditAttribution: YesCT commentedI think the meta can be a task, and the sub issues will be bugs.
Comment #2
YesCT CreditAttribution: YesCT commentedComment #3
gddComment #3.0
vijaycs85Updated issue summary with coding standard and step to check.
Comment #3.1
vijaycs85Updated issue summary updating # key
Comment #3.2
vijaycs85Updated issue summary - # update
Comment #3.3
vijaycs85Updated issue summary.
Comment #3.4
vijaycs85Updating modules that are ok
Comment #3.5
vijaycs85Adding additional issues and files
Comment #3.6
vijaycs85Updated issue summary with HTML fix
Comment #3.7
vijaycs85Updated issue summary with HTML fix
Comment #4
YesCT CreditAttribution: YesCT commentedTrying to figure out where the standards come from
http://drupal.org/node/1905070 is the d.o doc page pointed to from the change record (http://drupal.org/node/1905120) form the issue #1866610: Introduce Kwalify-inspired schema format for configuration
Comment #5
YesCT CreditAttribution: YesCT commentedrelated/follow-up #1945246: Can Symfony .yml exporter export integer/boolean values *without* quotes in configuration files?
Comment #6
YesCT CreditAttribution: YesCT commentedrelated #1948284: [policy no patch] config save format and default yml file format and coding standards
Comment #7
YesCT CreditAttribution: YesCT commenteddblog is listed as not needing an issue.. but I think: #1930226: Update integer/boolean values with quotes in configuration files.
Comment #7.0
YesCT CreditAttribution: YesCT commentedUpdating minor ucfirst
Comment #8
YesCT CreditAttribution: YesCT commentedComment #9
YesCT CreditAttribution: YesCT commentednote #2378503: Save configuration in a consistent order was opened and is related.
Comment #19
quietone CreditAttribution: quietone at PreviousNext commentedAll the child issues have been fixed so I am closing this.