Extension AEM Brackets

Présentation

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 fournit également une prise en charge du langage HTL (HTML Template Language), qui élimine la complexité de JSP pour faciliter et sécuriser le développement de composants.

chlimage_1-53

Fonctions

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

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

En outre, Brackets propose de nombreuses fonctionnalités utiles pour les développeurs de front-end AEM :

  • Prise en charge des fichiers Photoshop pour extraire les informations d’un fichier PSD, comme des calques, des mesures, des couleurs, des polices, du texte, etc.
  • Conseils relatifs au code du fichier PSD pour réutiliser facilement cette information extraite dans le code.
  • Prise en charge du préprocesseur CSS, comme LESS et SCSS.
  • Et des centaines d’extensions supplémentaires qui répondent à des besoins plus précis.

Installation

Brackets

L’extension AEM Brackets prend en charge les versions 1.0 ou ultérieures.

Téléchargez la dernière version de Brackets à partir de crochets.io.

L’extension

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

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

  2. Entrez AEM dans la barre de recherche et recherchez l’extension AEM Brackets.

    chlimage_1-54

  3. Cliquez sur Installer.

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

Prise en main

Le projet de modules de contenu

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

Le projet doit contenir au moins :

  1. un dossier jcr_root (par ex. myproject/jcr_root)

  2. un fichier filter.xml (par ex. myproject/META-INF/vault/filter.xml); pour plus d’informations sur la structure du fichier filter.xml, consultez 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.

REMARQUE

Si vous ne disposez pas de votre propre projet avec un module de contenu, vous pouvez essayer l’ exemple HTL TodoMVC. Sur GitHub, cliquez sur Télécharger ZIP, extrayez les fichiers localement, puis, comme indiqué ci-dessus, ouvrez le dossier jcr_root dans Brackets. Suivez ensuite les étapes ci-dessous pour configurer les paramètres du projet, puis téléchargez enfin l’ensemble du module vers votre instance de développement AEM en effectuant une exportation du module de contenu comme indiqué plus bas dans la section Synchronisation complète des modules de contenu .

Après ces étapes, vous devriez pouvoir accéder à l’URL /content/todo.html sur votre instance de développement AEM et vous pouvez commencer à apporter des modifications au code dans Brackets et 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

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 ce faire, accédez au menu AEM et sélectionnez Paramètres du projet….

chlimage_1-55

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

  1. L’URL du serveur (par ex. http://localhost:4502)
  2. Permet de tolérer les serveurs qui ne possèdent pas de certificat HTTPS valide (ne cochez pas, sauf si nécessaire).
  3. Le nom d’utilisateur qui a servi à synchroniser le contenu (par exemple admin)
  4. Mot de passe de l’utilisateur (par exemple, admin)

Synchronisation du contenu

L’extension AEM Brackets fournit les types suivants de synchronisation de contenu 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

Ne synchronise que les changements de Brackets vers l’instance d’AEM, mais jamais l’inverse.

Synchronisation bidirectionnelle manuelle

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

chlimage_1-56

REMARQUE

Si l’entrée sélectionnée se trouve 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 modules de contenu

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

chlimage_1-57

État de la synchronisation

L’extension AEM Brackets comporte une icône de notification dans la barre d’outils à 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
  • bleu - 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é

En cliquant sur l’icône de notification, vous ouvrez la boîte de dialogue du rapport d’état de la synchronisation qui répertorie tous les états de chaque fichier synchronisé.

chlimage_1-58

REMARQUE

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.

En outre, les fichiers .vltignore sont pris en charge pour exclure le contenu de la synchronisation vers et depuis le référentiel.

Modification du code HTL

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

  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

Dans une expression ${}, les noms de variable courants sont renseignés automatiquement.

Informations supplémentaires

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’organisation Adobe Systems Incorporated :

N’hésitez pas à apporter votre contribution !

Sur cette page