DocumentationAEM 6.4Guide de développement

Extension AEM Brackets aem-brackets-extension

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Developer
CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

du commerce électronique overview

L’extension AEM Brackets offre un workflow fluide pour modifier les composants AEM et les bibliothèques clientes. Elle tire parti de la puissance de l’éditeur de code Brackets qui donne accès aux fichiers et calques Photoshop depuis l’éditeur de code. La synchronisation simplifiée (aucun Maven ou File Vault requis) grâce à l’extension améliore le rendement des développeurs et permet également aux développeurs de front-end ayant des connaissances AEM limitées de participer à des projets. Cette extension prend également en charge le langage de modèle HTML (HTL) qui élimine la complexité des JSP pour faciliter et sécuriser le développement de composants.

chlimage_1-53

Fonctions features

Les principales fonctionnalités de l’extension AEM Brackets sont les suivantes :

  • La synchronisation automatisée des fichiers modifiés avec l’instance de développement AEM
  • La synchronisation bidirectionnelle manuelle des fichiers et des dossiers
  • La synchronisation complète des packages de contenu du projet
  • Le remplissage du code HTL pour les expressions et les instructions de bloc data-sly-*

En outre, Brackets s’accompagne de nombreuses fonctionnalités utiles pour les développeurs de polices AEM :

  • Prise en charge des fichiers Photoshop pour extraire des informations d’un fichier de PSD, comme des calques, des mesures, des couleurs, des polices, du texte, etc.
  • Conseils sur le code du PSD, pour réutiliser facilement ces informations extraites dans le code.
  • Prise en charge de préprocesseurs CSS, comme LESS et SCSS.
  • Et des centaines d’extensions supplémentaires qui répondent à des besoins plus spécifiques.

Installation installation

Brackets brackets

L’extension AEM Brackets prend en charge Brackets version 1.0 ou ultérieure.

Téléchargez la dernière version de Brackets sur Brackets.io.

L’extension the-extension

Pour installer l’extension, procédez comme suit :

  1. Ouvrez Brackets. Dans le menu Fichier, sélectionnez Extension Manager…

  2. Entrée AEM dans la barre de recherche et recherchez Extension AEM Brackets.

    chlimage_1-54

  3. Cliquez sur Installer.

  4. Fermez la boîte de dialogue et l’Extension Manager une fois l’installation terminée.

Prise en main getting-started

Le projet Content-Package the-content-package-project

Une fois l’extension installée, vous pouvez commencer à développer AEM composants en ouvrant un dossier content-package à partir de votre système de fichiers avec Brackets.

Le projet doit contenir au moins :

  1. un dossier jcr_root (par exemple, myproject/jcr_root) ;

  2. un fichier filter.xml (par exemple myproject/META-INF/vault/filter.xml). Pour plus de détails sur la structure du fichier filter.xml, reportez-vous à la définition du filtre d’espace de travail.

Dans le menu Fichier de Brackets, choisissez Ouvrir le dossier… et choisissez le dossier jcr_root ou le dossier du projet parent.

NOTE
Si votre projet n’a pas de package de contenu, vous pouvez essayer d’appliquer l’exemple HTL TodoMVC. Sur GitHub, cliquez sur Télécharger le fichier ZIP, extrayez les fichiers localement et, comme indiqué ci-dessus, ouvrez le dossier jcr_root dans Brackets. Suivez ensuite les étapes ci-dessous pour configurer les paramètres du projet et enfin téléchargez le package entier vers votre instance de développement AEM en exportant le package de contenu comme indiqué plus bas dans la section Synchronisation complète des packages de contenu du projet.
Après ces étapes, vous devriez être en mesure d’accéder à l’URL /content/todo.html sur votre instance de développement AEM, d’apporter des modifications au code dans Brackets et de voir comment, après une actualisation dans le navigateur Web, les modifications ont été immédiatement synchronisées avec le serveur AEM.

Paramètres du projet project-settings

Pour synchroniser le contenu avec une instance de développement AEM dans les deux sens, vous devez définir les paramètres du projet. Pour cela, accédez au menu AEM et choisissez Paramètres du projet…

chlimage_1-55

Les paramètres du projet permettent de définir :

  1. l’URL du serveur (par exemple http://localhost:4502) ;
  2. s’il faut accepter les serveurs sans certificat HTTPS valide (ne pas cocher, sauf si nécessaire) ;
  3. le nom d’utilisateur qui a servi à synchroniser le contenu (par exemple admin) ;
  4. le mot de passe de l’utilisateur (par exemple admin).

Synchronisation du contenu synchronizing-content

L’extension AEM Brackets fournit les types de synchronisation de contenu suivants pour les fichiers et dossiers autorisés par les règles de filtrage définies dans filter.xml :

Synchronisation automatisée des fichiers modifiés automated-synchronization-of-changed-files

Cela synchronise uniquement les modifications de Brackets vers l’instance AEM, mais jamais l’inverse.

Synchronisation bidirectionnelle manuelle manual-bidirectional-synchronization

Dans l’Explorateur de projet, ouvrez le menu contextuel en cliquant avec le bouton droit de la souris sur un fichier ou un dossier, et accédez aux options Exporter vers le serveur ou Importer depuis le serveur.

chlimage_1-56

NOTE
Si l’entrée sélectionnée se situe en dehors du dossier jcr_root, les entrées du menu contextuel Exporter vers le serveur et Importer depuis le serveur sont désactivées.

Synchronisation complète des packages de contenu full-content-package-synchronization

Dans le menu AEM, les options Exporter le package de contenu ou Importer le package de contenu permettent de synchroniser l’ensemble du projet avec le serveur.

chlimage_1-57

État de synchronisation synchronization-status

L’extension AEM Brackets comporte une icône de notification dans la barre d’outils située à droite de la fenêtre Brackets, qui indique l’état de la dernière synchronisation :

  • vert : tous les fichiers ont été synchronisés avec succès
  • blue : une opération de synchronisation est en cours
  • jaune : certains fichiers n’ont pas été synchronisés
  • rouge : aucun des fichiers n’a été synchronisé

Cliquez sur l’icône de notification pour ouvrir la boîte de dialogue Rapport d’état de synchronisation qui répertorie tous les états de chaque fichier synchronisé.

chlimage_1-58

NOTE
Seul le contenu marqué comme inclus par les règles de filtrage de filter.xml est synchronisé, quelle que soit la méthode de synchronisation appliquée.
De plus, les fichiers .vltignore sont pris en charge pour exclure le contenu de la synchronisation bidirectionnelle avec le référentiel.

Modification du code HTL editing-htl-code

L’extension AEM Brackets propose également une fonction de remplissage automatique pour faciliter l’écriture d’attributs et d’expressions HTL.

Remplissage automatique des attributs attribute-auto-completion

  1. Dans un attribut HTML, tapez sly. L’attribut est automatiquement rempli sur data-sly-.
  2. Sélectionnez l’attribut HTL dans la liste déroulante.

Remplissage automatique des expressions expression-auto-completion

Dans une expression ${}, les noms communs des variables sont remplis automatiquement.

Informations supplémentaires more-information

L’extension AEM Brackets est un projet open source, hébergé sur GitHub par l’entreprise Adobe Marketing Cloud, sous licence Apache, version 2.0 :

L’éditeur de code Brackets est également un projet open source, hébergé sur GitHub par l’entreprise Adobe Systems Incorporated :

N’hésitez pas à apporter votre contribution !

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e