Test SDC conversion script and guide with demo_design_system/components/01-atoms/select

Here is the output after running the script

name: Select

status: experimental

group: Atoms

props:

  type: object
  required:
    - options

  properties:
    theme:
      type: string
      title: Theme
      description: 'Theme: light, dark.'
      default: light
      enum:
        - light
        - dark

    is_multiple:
      type: boolean
      title: Is multiple.

    options:
      type: array
      title: Options
      description: 'Options:'
      items:
        type: object

        properties:
          type:
            type: string
            title: Type
            description: 'Option type: option group (optgroup) or option (option).'

          label:
            type: string
            title: Label
            description: Option label.

          value:
            type: string
            title: Value
            description: Option value.

          selected:
            type: string
            title: Selected
            description: Flag whether option is selected.

          options:
            type: array
            title: Options
            description: 'Array of options (applies to optgroup type):'

    is_invalid:
      type: boolean
      title: Denote if the control is invalid.

    is_disabled:
      type: boolean
      title: Denote if the control is disabled.

    is_required:
      type: boolean
      title: Denote if the control is required.

    attributes:
      type: string
      title: Attributes
      description: Additional attributes.

    modifier_class:
      type: string
      title: Modifier class
      description: Additional classes.

 *   - options: [array] Array of options (applies to optgroup type):
 *     - label: [string] Option label.
 *     - value: [string] Option value.
 *     - is_selected: [string] Flag whether option is selected.
 *     - is_disabled: [string] Flag whether option is disabled.

The script didnot convert the properties inside the nested options field (Options -> Options). Current output is

options:
  type: array
  title: Options
  description: 'Array of options (applies to optgroup type):'

I think it should have been like

options:
  type: array
  title: Options
  description: 'Array of options (applies to optgroup type):'
  items:
    label:
      type: string
      title: Label
      description: Option label.

    value:
      type: string
      title: Value
      description: Option value.

    is_selected:
      type: string
      title: Selected
      description: Flag whether option is selected.

    is_disabled:
      type: string
      title: Selected
      description: Flag whether option is disabled.

Also, fields like selected, options.options.is_selected, options.options.is_disabled are documented as string fields in the twig file. But shouldn't these be boolean fields? (The logic in the twig confirms the same)

{% if sub_option.is_selected %}selected="selected"{% endif %} 
{% if sub_option.is_disabled %}disabled{% endif %}

Thanks 🙏 can you compare your work against the recent dev changes? There was just a commit of all baseline yaml and readme files. It would be helpful to compare your results against that to see if they align or the files should be updated with some of your suggestions

I will check script today for above mentioned issue by Akhil.

Thanks!

Marking postponed until we have the updated script.

Looks like the script isn't quite right but we are leaving this postponed because we need to understand more about arrays and nesting in the yaml files before moving forward.

I don't think we'll update the script in the future at this point (TBD) and we need to wait on XB to support arrays:

🐛 Arrays in SDDS SDC YAMLs are causing fatal errors in XB Postponed

so closing this as fixed for the testing. Thanks!