Twig disallows dashes in variable names, so SDC should disallow it in prop names

Hi Wim,

Thanks for this valuable feedback. It makes sense for props (and also slots) machine names to follow machine_name data type : [#2954832]

With:

  constraints:
    Regex: '/^[a-z0-9_]+$/'
    Length:
      max: 64

So:

foo ✅
foo1 ✅
111 ✅
foo_bar ✅
foo-bar ❌
foo bar ❌

We can enforce it to patternProperties in JSON Schema.

I started looking into making this. On the surface this seems to be the responsibility of Drupal/Core/Theme/ComponentPluginManager.php. That would be a place where we could later the schema validation logic of a Component definitition.

But the configuration shown above seems to be a solution that can be applied to each individual component schema definition. As in, it would be the responsibility of the developer to include the schema constraint per property.

Are you saying it's possible to modify the schema of a component, through the same config-based fix, that would impact the default definition of any property the component might have?

#3++ … except … that

#4: No, @pdureau is proposing to update https://git.drupalcode.org/project/sdc/-/raw/1.x/src/metadata.schema.json … which interestingly lives outside Drupal core 😱😅 (Is there an issue to change that? Was that a conscious choice? I cannot find docs covering that. 🤔)

@wim-leers the schema lives here now: https://git.drupalcode.org/project/drupal/-/tree/11.x/core/assets/schema...

Thanks for that... added an XB issue as a result:

📌 Update components to use core metadata.schema.json instead of old SDC module one Active

@pdureau, I am not so familiar with the *.schema.json syntax etc but we currently have the following:

"props": {
  "$ref": "http://json-schema.org/draft-04/schema#"
},
"slots": {
  "$ref": "#/$defs/slotDefinition"
},

So, where could these constraints be added in the schema.json file?

Hello Panagiotis,

This would be my (non tested) proposal for slots. Remove the - from /"$defs"/slotDefinition/patternProperties/"^[a-zA-Z0-9_-]$". So: /"$defs"/slotDefinition/patternProperties/"^[a-zA-Z0-9_]$"

Unfortunately, I don't think it is possible to enforce it for props because we are edelegating the schema to http://json-schema.org/draft-04/schema#

I performed Novice Triage on this issue. I added the Novice issue tag and the Needs issue summary update issue tag so that the notes provided by @pdureau can be added to the issue summary to clarify the scope of the issue.

During DrupalCon Atlanta Kwiseman helped me update the proposed resolution.

pdureau → credited kwiseman → .

@lirak : can you do a MR please?

Added 🐛 Disable additionalProperties in slots, props in SDC json schema Active as related.

The patternProperties regexp means that properties that match that regexp will require those validation rules. But not that properties MUST match that regexp.