[MAGNOLIA-8034] Default file watcher configuration should include .yml Created: 18/Mar/21  Updated: 05/Aug/21

Status: Accepted
Project: Magnolia
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Unassigned
Resolution: Unresolved Votes: 1
Labels: light-development, tech-debt
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:

 Description   

Currently if a develop names a file with a .yml extension, the file will not be picked up. It will only pick up files with a .yaml extension.

In the development ecosystem at large it is common for developers to use .yaml and .yml. It causes confusion and obstacles for devlopers when they try to use Magnolia and don't understand why their definitions are not being loaded.

 

To reproduce:

  • create or copy a valid dialog definition file and name it 'canyouseeme.yml' and place it in a light modules 'dialogs/components' directory.
  • Note that Magnolia does not detect it.
  • Rename it to 'canyouseeme.yaml'
  • Note that Magnoila detects it.


 Comments   
Comment by Senol Tas [ 18/Mar/21 ]

Just to add to the importance. I recently started to work with Magnolia and spend an significant amount of time to resolve this issue. Even though .yaml is kind of the official extension through docker and other systems using .yml as default it might happen many developers.

It would be nice to have:

  - A warning, when a file is picked up but will be ignored by the file watcher

  - support yaml and .yml by default, but (if that's somehow possible) log a warning either if .yml and .yaml are mixed in one module or just warning to state that .yaml would be default..

Generated at Mon Feb 12 04:29:02 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.