[Magento 2] - Boas práticas

m2-good-habits.md

M2 - Boas práticas no desenvolvimento

Sobre

Vantagens

• Padronizar o padrão de desenvolver, facilitando futuras alterações/manutenções

Desvantagens

• Tempo de aprendizado do padrão/boa prática utilizada.

Backend

Nomenclatura de nomes dos plugins.

• Inicio com a identificação do módulo e em seguida uma breve descrição do que ele faz. _<módulo>::<descrição>

Hibrido_Tax::order_view_tax_list

    <type name="Magento\Sales\Block\Adminhtml\Order\View\Items\Renderer\DefaultRenderer">
        <plugin name="Hibrido_Tax::order_view_tax_list" type="Hibrido\Tax\Plugin\Block\Sales\Adminhtml\Order\View\Items\DefaultRenderer" />
    </type>

Nomenclatura de eventos.

• Inicio com a identificação do módulo e em seguida uma breve descrição do que ele faz.

<módulo><descrição>

    <event name="sales_quote_save_after">
        <observer name="hibrido_reservations_sales_quote_item_qty_set_after" instance="Hibrido\Reservations\Observer\ReservationsItemQtySetObserver" />
    </event>

Frontend

Sobrescrever o JS todo.

• Arquivo: /app/code///view/adminhtml/requirejs-config.js

var config = {
    map:{
        "*":{
            "mage/adminhtml/form":"Hibrido_AdminOrderScreens/js/mage/adminhtml/form-rewrite"
        }
    }
}

• Arquivo: form.js está sendo reescrito para form-rewrite.js
  • Nomenclatura: <VENDOR_MODULE>/js/<FODERS/FILE-NAME>-rewrite.js

Alterar funções do js.

• Arquivo: /app/code///view/adminhtml/requirejs-config.js

var config = {
    config:{
        mixins:{
            "MageWorx_OrderEditor/js/order/edit/form/items/grid":{
                "Hibrido_CreditPurchaseLimit/js/grid-mixin":true
            }
        }
    }
}

• Arquivo: grid.js está sendo reescrito para grid-mixin.js
  • Nomenclatura: <VENDOR_MODULE>/js/<FODERS/FILE-NAME>-mixin.js
    • O Correto ficaria: "Hibrido_CreditPurchaseLimit/js/order/edit/form/items/grid-mixin":true

Importar variáveis de less para dentro do meu arquivo.

?

Conversar

• CodeSniffer https://devdocs.magento.com/guides/v2.4/ext-best-practices/extension-coding/common-programming-bp.html

• Magento coding standard https://github.com/magento/magento-coding-standard

Curiosidades

• Admin pattern Library https://devdocs.magento.com/guides/v2.4/pattern-library/bk-pattern.html

• Permissão de acesso https://devdocs.magento.com/guides/v2.4/ext-best-practices/tutorials/create-access-control-list-rule.html

• Performance best practices https://devdocs.magento.com/guides/v2.4/performance-best-practices/introduction.html -> A Parte do JS avançado.

• PHP Mess Detector https://phpmd.org/

• Design Patterns https://sourcemaking.com/design_patterns

References

https://www.magentoassociation.org/commerce-co-op/full-article/best-practices-for-magento-2-programming-1