Saltar a contenido

Configuración de Compatibilidad

Para hacer que un módulo sea compatible con MageObsidian Components, sigue estos pasos. El proceso es el mismo tanto si estás creando un nuevo módulo como si estás añadiendo compatibilidad a uno existente.

Si estás creando un nuevo módulo, consulta la documentación oficial de Magento:
Creación de un módulo en Magento

Una vez que el módulo esté listo, incluye la configuración de compatibilidad como se describe a continuación.

Pasos para Configurar la Compatibilidad

  1. Crear el Archivo de Compatibilidad

    • Nombre del archivo:
      mage_obsidian_compatibility.xml

    • Ruta del archivo:

      Guarda el archivo en la siguiente ubicación: 

      1
      app/code/Vendor/ModuleName/etc/mage_obsidian_compatibility.xml

  2. Agregar el Contenido del Archivo

    • Copia y pega el siguiente contenido en el archivo:

      1
2
3
4
5
6
7
      <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:noNamespaceSchemaLocation="urn:magento:module:MageObsidian_ModernFrontend:etc/xsd/mage_obsidian_compatibility.xsd">
        <features>
            <compatibility>true</compatibility>
        </features>
</config>

Pasos Finales

Después de configurar el archivo de compatibilidad, debes ejecutar los siguientes comandos para integrar el módulo en Magento y generar los metadatos necesarios:

  1. Cargar el Módulo en Magento

    1
    bin/magento setup:upgrade

  2. Generar metadatos para MageObsidian Components

    1
    bin/magento mage-obsidian:frontend:config --generate

Detalles Clave

  • El archivo de compatibilidad debe guardarse en la siguiente ruta:
    Vendor/ModuleName/etc/mage_obsidian_compatibility.xml

  • La declaración xsi:noNamespaceSchemaLocation ya apunta al esquema requerido:
    urn:magento:module:MageObsidian_ModernFrontend:etc/xsd/mage_obsidian_compatibility.xsd

  • El nodo <features> incluye la etiqueta <compatibility>, que debe configurarse como true para indicar compatibilidad con MageObsidian Components.

Opcional: flag universal (convivencia multi-tema)

Por defecto, el layout de un módulo compatible se recolecta solo bajo un tema MageObsidian Components. Bajo un tema legacy (no-Obsidian) su layout se suprime, de modo que habilitar el módulo nunca rompe una tienda que sigue en Luma/Blank. Esto es lo que hace segura una migración por website: el tema activo de cada request decide si el módulo participa.

Configura <universal>true</universal> para que el módulo aplique en todos los temas, legacy incluido:

1
2
3
4
<features>
    <compatibility>true</compatibility>
    <universal>true</universal>
</features>

Úsalo solo en módulos cuyo layout sea agnóstico del tema. Un módulo universal aporta su layout completo a los temas legacy —tanto sus islas Vue como cualquier neutralización de bloques legacy (remove="true")—, así que todo lo específico del tema que contenga también llegará al tema legacy. Omitir el flag (o ponerlo en false) mantiene el comportamiento por defecto, gateado por tema.

Vuelve a ejecutar mage-obsidian:frontend:config --generate después de cambiar el flag para que el contrato lo recoja.

Propósito

Esta configuración asegura que solo los módulos declarados explícitamente como compatibles puedan interactuar con las funcionalidades y la arquitectura de MageObsidian Components, logrando un proceso de desarrollo más organizado y confiable.

Flexibilidad Futura

Esta estructura está diseñada para soportar mejoras futuras. Al actualizar este archivo XML, será posible activar o desactivar nuevas funcionalidades introducidas en MageObsidian Components. Este enfoque ofrece mayor flexibilidad y control sobre el comportamiento de los módulos, permitiendo una adopción fluida de las nuevas características.