Fix indentation consistency in core's yaml files.

Thanks for picking this up! It was indeed fixed by my IDE and at first it accidentally ended up in my patches.

It seems like this would be automated in #2591827: Add YAML linting to core coding standards checks.

# Laminas Feed reader plugins. Plugin instances should not be shared.
  feed.reader.dublincoreentry:

# Laminas Feed writer plugins. Plugins should be set as prototype scope.
  feed.writer.atomrendererfeed:

These "headings" are used to refer to multiple services below, not just the first one, which I guess is why they were put at the top level. Maybe we need some line breaks instead to help with this?

Agree with @longwave on additional line breaks for added legibility and consistency. Other comments not noted here - particularly those pertaining to deprecations - are particularly confusing without whitespace to help delineate which service(s) they pertain to.

The existing comments for the first few groups of services (cache_context.*) establish a helpful pattern of a line break immediately following the final line of the last service the comment is relevant to.

The attached patch standardizes all comments to that pattern and fixes the indentation concerns noted above in core.services.yml

The patch needs first to land in the most current branch. At the moment that is 9.1. For that branch does the current patch not apply. Therefore the current patch need to be rerolled.

I'll work on rerolling the patch :)

Rerolling the patch from #5 for 9.1. Sorry @leolando.tan I have already created the patch.

Remove Needs Reroll tag

Thanks for re-rolling @himanshu_sindhwani

The updated patch applies cleanly to 9.1.x

Patch no longer applies, another reroll needed. When a reroll is made remember to add the interdiff, or a diff, if that fails. It makes reviews much easier. See Creating an interdiff

Working on patch re-roll. will update asap.

Patch rerolled. Sorry @narendra.rajwar27 If you are working then you should have assigned this issue to your self.

@Vidushi Mehta, thanks for the re-roll, Unfortunately it's not complete re-roll. Patch #16 is missing some changes from #10

So adding updated patch.
Thanks

Re-roll for 9.2.x.

Small identation error that I missed reviewing the patch.

Hello, i have checked patch #20. I looked into it and din't find any violation of the indention, so I'm moving the issue to RTBC.

Need to rewrap the comment here. comments are extending 80 characters.

916:      # @todo Try to combine those tags together, see https://www.drupal.org/node/2915772.

971:  # password stretching.
972:  # @todo increase by 1 every Drupal version in order to counteract increases in
973:  # the speed and power of computers available to crack the hashes. The current
974:  # password hashing method was introduced in Drupal 7 with a log2 count of 15.

1175:    # list of bundles in the entity parameter, under "bundle" key as a sequence,

1653:    # We use '.' instead of '%app.root%' as the path for non-namespaced template

Sorry, for letting it pass. I'm adding a patch with the fix.

The fix works as intended, but adds whitespace in the process. Sending patch fixing this.

Hello everyone, I've just reviewed patch #24 and everything is okay. I'm moving it to RTBC.

For other coding standards issues, we've usually required new coder rules to be added alongside committing the patches.

Currently there's no YAML linting in core, but there is an old issue to add it here. #2591827: Add YAML linting to core coding standards checks

Moving back to needs review for now.

Let's postpone on linting being added to core.

No longer postponed, #2591827: Add YAML linting to core coding standards checks was comitted.

patch no longer applies, we need a patch for 9.x and 10.x

Added reroll of patch #30 on Drupal 9.5.x. and 10.1.x.

Neither patch in #34 applies.

Also, edified to learn about the existence of core/scripts/dev/commit-code-check.sh

It sure would be great to have that as a more visible tool.

Adding re-rolled patch for Drupal 9.5.x.

Triaging issues for the Drupalcon Prague 2022 here. This is a good candidate for novice.

Also the fix should go in Drupal 10.1.x first and then backported.

If more work is needed it would be great to open a merge request and continue the changes there.

Setting to NW...

Hello, sorry fot his merge, i'm working on it to solve the problem.'

Hi, I managed to solve the MR problem, I made the changes based on the patch sent in #34 by @ravi.shankar, as I ran the phpcs command to see the errors and they didn't show up.
I hope that everything is right.
And i'll move this issue to needs review

I Just checked it and the changes on the yml files are looking ok now

We can now scope this issue to automatically fix all the indentation issues for all of core's yaml files.

We need to add

    "yml/indent": ["error", 2]

to core/.eslintrc.json and then run the fixer. Once we do that we can then introduce new yaml rules to the eslintrc.json and improve all of core's yaml and ensure we don't introduce new errors in the future.

I am working on the suggestion given by @alexpott.

I have added the "yml/indent": ["error", 2] in the core/.eslintrc.json and created a patch for that. Now as per @alexpott next step is to run the fixer. @alexpott can you please guide how can we run the fixer and which library is required to run that?

@lalitware here's how to do this:

cd core
yarn install
yarn run lint:yaml --fix

I am working on it.

Thank you very much @alexpott for helping me out. I ran the fixer and all the yaml files are modified. I have created the patch for that.

Thank you very much @alexpott for helping me out. I ran the fixer and all the yaml files are modified. I have created the patch for that. Please ignore patch in #49. I have corrected the comment number on patch.

Setting to needs review so the tests will run.

Need to copy assets/scaffold/files/default.services.yml to sites/default/default.services.yml to fix the last test fail.

Working on suggestion given by @alexpott in above comment.

Created patch after making 3 changes:

1. Added the "yml/indent": ["error", 2] in the core/.eslintrc.json
2. Ran the fixer
3. Copied assets/scaffold/files/default.services.yml to sites/default/default.services.yml

All code changes look good to me.
The rule has been added to eslint.
The testbot is green.
For me it is RTBC.

Saving issue credit

Committed and pushed b29f980b79 to 10.1.x and a484c5ddd2 to 10.0.x. Thanks!
Committed 3b17df9 and pushed to 9.5.x. Thanks!

diff --git a/core/modules/config_translation/migrations/d7_field_instance_option_translation.yml b/core/modules/config_translation/migrations/d7_field_instance_option_translation.yml
index 656107cd29..984f2c6a57 100644
--- a/core/modules/config_translation/migrations/d7_field_instance_option_translation.yml
+++ b/core/modules/config_translation/migrations/d7_field_instance_option_translation.yml
@@ -19,9 +19,9 @@ process:
     method: getFieldType
   entity_type: entity_type
   field_name: field_name
-  #  # The bundle needs to be statically mapped in order to support comment types
-  #  # that might already exist before this migration is run. See
-  #  # d7_comment_type.yml for more information.
+  # The bundle needs to be statically mapped in order to support comment types
+  # that might already exist before this migration is run. See
+  # d7_comment_type.yml for more information.
   bundle:
     plugin: static_map
     source: bundle
diff --git a/core/modules/file/migrations/d6_file.yml b/core/modules/file/migrations/d6_file.yml
index d58ad93d26..51db2fdc6c 100644
--- a/core/modules/file/migrations/d6_file.yml
+++ b/core/modules/file/migrations/d6_file.yml
@@ -37,8 +37,8 @@ source:
 process:
   # If you are using both this migration and d6_user_picture_file in a custom
   # migration and executing migrations incrementally, it is strongly
-  # recommended that you remove the fid mapping to avoid potential ID
-  # conflicts. For that reason, this mapping is commented out by default.
+  # recommended that you remove the fid mapping to avoid potential ID conflicts.
+  # For that reason, this mapping is commented out by default.
   # fid: fid
   filename: filename
   source_full_path:
diff --git a/core/modules/system/tests/modules/dialog_renderer_test/dialog_renderer_test.services.yml b/core/modules/system/tests/modules/dialog_renderer_test/dialog_renderer_test.services.yml
index 63ce8a894c..332a261c5b 100644
--- a/core/modules/system/tests/modules/dialog_renderer_test/dialog_renderer_test.services.yml
+++ b/core/modules/system/tests/modules/dialog_renderer_test/dialog_renderer_test.services.yml
@@ -1,6 +1,6 @@
 services:
-  # Provide 2 main content renderer services that use the same class but
-  # behave differently depending on the 2nd argument.
+  # Provide 2 main content renderer services that use the same class but behave
+  # differently depending on the 2nd argument.
   main_content_renderer.wide_modal:
     class: Drupal\dialog_renderer_test\Render\MainContent\WideModalRenderer
     arguments: ['@title_resolver', '@renderer', 'wide']

Reflowed some comments on commit.

diff --git a/core/core.services.yml b/core/core.services.yml
index 6a6332c7d7..7d83bb12f8 100644
--- a/core/core.services.yml
+++ b/core/core.services.yml
@@ -1455,7 +1455,8 @@ services:
       - [setStandalone, ['\Laminas\Feed\Writer\StandaloneExtensionManager']]
     arguments: ['feed.writer.']
     deprecated: The "%service_id%" service is deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. Use \Laminas\Feed\Writer\StandaloneExtensionManager or create your own service. See https://www.drupal.org/node/3258440
-# Laminas Feed reader plugins. Plugin instances should not be shared.
+
+  # Laminas Feed reader plugins. Plugin instances should not be shared.
   feed.reader.dublincoreentry:
     class: Laminas\Feed\Reader\Extension\DublinCore\Entry
     shared: false
@@ -1496,7 +1497,8 @@ services:
     class: Laminas\Feed\Reader\Extension\Podcast\Feed
     shared: false
     deprecated: The "%service_id%" service is deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. You should use \Drupal::service('feed.bridge.reader')->get('Podcast\Feed') instead. See https://www.drupal.org/node/2979042
-# Laminas Feed writer plugins. Plugins should be set as prototype scope.
+
+  # Laminas Feed writer plugins. Plugins should be set as prototype scope.
   feed.writer.atomrendererfeed:
     class: Laminas\Feed\Writer\Extension\Atom\Renderer\Feed
     shared: false
diff --git a/core/modules/field_ui/field_ui.services.yml b/core/modules/field_ui/field_ui.services.yml
index b4c23ddf6e..0ee8964f38 100644
--- a/core/modules/field_ui/field_ui.services.yml
+++ b/core/modules/field_ui/field_ui.services.yml
@@ -3,7 +3,7 @@ services:
     class: Drupal\field_ui\Routing\RouteSubscriber
     arguments: ['@entity_type.manager']
     tags:
-     - { name: event_subscriber }
+      - { name: event_subscriber }
   field_ui.route_enhancer:
     alias: route_enhancer.entity_bundle
     deprecated: The "%alias_id%" service is deprecated in drupal:9.4.0 and is removed from drupal:10.0.0. Use the "route_enhancer.entity_bundle" service instead. See https://www.drupal.org/node/3245017
diff --git a/core/modules/hal/hal.services.yml b/core/modules/hal/hal.services.yml
index 38ffb22612..156fbc23fc 100644
--- a/core/modules/hal/hal.services.yml
+++ b/core/modules/hal/hal.services.yml
@@ -18,10 +18,10 @@ services:
     tags:
       - { name: normalizer, priority: 20 }
   serializer.normalizer.timestamp_item.hal:
-   class: Drupal\hal\Normalizer\TimestampItemNormalizer
-   tags:
-     # Priority must be higher than serializer.normalizer.field_item.hal.
-     - { name: normalizer, priority: 20 }
+    class: Drupal\hal\Normalizer\TimestampItemNormalizer
+    tags:
+      # Priority must be higher than serializer.normalizer.field_item.hal.
+      - { name: normalizer, priority: 20 }
   serializer.normalizer.entity.hal:
     class: Drupal\hal\Normalizer\ContentEntityNormalizer
     arguments: ['@hal.link_manager', '@entity_type.manager', '@module_handler', '@entity_type.repository', '@entity_field.manager']

I think this needs a release note as it affects anyone who uses our eslint config.