Votre première WebExtension

Créez un nouveau répertoire et déplacez-vous à l'intérieur. Par exemple, vous pouvez utiliser les commandes suivantes dans votre ligne de commande/terminal :

mkdir borderify
cd borderify

Créez un nouveau fichier nommé manifest.json directement dans le répertoire borderify et ajoutez-y le contenu qui suit :

{
  "manifest_version": 2,
  "name": "Borderify",
  "version": "1.0",

  "description": "Ajoute une bordure rouge pleine sur l'ensemble des pages web mozilla.org.",

  "icons": {
    "48": "icons/border-48.png"
  },

  "content_scripts": [
    {
      "matches": ["*://*.mozilla.org/*"],
      "js": ["borderify.js"]
    }
  ]
}

• Les trois premières clés : manifest_version, name et version sont obligatoires et contiennent des métadonnées fondamentales nécessaires au module.
• La clé description est optionnelle, mais recommandée : elle s'affiche dans le gestionnaire de modules.
• La clé icons est optionnelle, mais recommandée : elle permet d'établir l'icône de l'extension qui s'affichera dans le gestionnaire de modules.

La clé la plus intéressante ici est content_scripts, qui demande à Firefox de charger un script dans toutes les pages web dont l'URL correspond à un motif de correspondance de domaines spécifique. Dans notre cas, nous demandons à Firefox de charger un script appelé borderify.js dans toutes les pages HTTP ou HTTPS servies depuis le domaine mozilla.org et tous ses sous-domaines.

• En savoir plus sur les scripts de contenu.
• En savoir plus sur les motifs de correspondance.

"browser_specific_settings": {
  "gecko": {
    "id": "borderify@example.com"
  }
}

Le module doit posséder une icône qui sera affichée dans le gestionnaire de modules du navigateur. Le fichier manifest.json utilisé ici fournit une icône icons/border-48.png.

Créez le répertoire icons directement sous le répertoire borderify et ajoutez-y une icône nommée border-48.png. Vous pouvez utiliser celle-ci, qui est tirée du répertoire d'icônes Google Material Design et est utilisable à condition de respecter les termes de la licence Creative Commons Attribution-ShareAlike.

Si vous décidez de fournir votre propre icône, sa taille devra être de 48x48 pixels. Il est aussi possible de fournir une icône de 96x96 pixels, adaptée à l'affichage en haute résolution et, dans ce cas, elle devra être spécifiée par la propriété 96 de l'objet icons dans le fichier manifest.json :

"icons": {
  "48": "icons/border-48.png",
  "96": "icons/border-96.png"
}

Une alternative est de fournir un fichier SVG qui sera automatiquement mis à la bonne échelle. (On notera cependant que si vous utilisez une icône SVG qui contient du texte, vous pouvez le vectoriser à l'aide de l'outil « convertir en chemin » dans votre éditeur SVG pour que la taille et la position du texte restent cohérentes lors du redimensionnement.)

• En savoir plus sur la spécification d'icône.

Enfin, créez un fichier nommé borderify.js directement dans le répertoire borderify et insérez-y le code qui suit :

document.body.style.border = "5px solid red";

Ce script sera chargé dans chaque page où le domaine correspond au motif fourni par la clé content_scripts du manifeste (manifest.json). Ce script a un accès direct au document contrairement à des scripts chargés par la page elle-même.

• En savoir plus sur les scripts de contenu.

D'abord, vérifiez de nouveau que les bons fichiers sont au bon endroit :

borderify/
    icons/
        border-48.png
    borderify.js
    manifest.json

Ouvrez dans Firefox la page about:debugging. Cliquez sur « Ce Firefox », cliquez sur « Chargez un module complémentaire temporaire… », puis sélectionnez n'importe quel fichier dans le répertoire de votre extension.

Le module complémentaire est dorénavant installé et persistera jusqu'à ce que vous redémarriez Firefox.

Une autre alternative est d'exécuter l'extension depuis la ligne de commande à l'aide de l'outil web-ext.

Rendez-vous sur une page web du domaine mozilla.org. Vous devriez y voir une bordure rouge qui entoure la page :

Expérimentez un peu en modifiant le script de contenu, en changeant par exemple la couleur de la bordure ou en altérant le contenu de la page. Puis sauvegardez le script de contenu et rechargez les fichiers du module en cliquant sur le bouton « Recharger » dans about:debugging. Les changements sont immédiats.

• En savoir plus sur le chargement des extensions.

Afin que d'autres personnes puissent utiliser votre module, il vous faut l'empaqueter et le soumettre à la signature de Mozilla. Pour en apprendre plus, voir Publier votre extension (en anglais).

Maintenant que vous avez eu une introduction au processus de développement d'une WebExtension pour Firefox, voici quelques suggestions pour la suite :

• Rédiger une extension plus complexe
• En lire davantage sur l'anatomie d'une extension
• Explorer les exemples d'extension
• Découvrir ce dont vous avez besoin pour développer, tester et publier votre extension
• Poursuivre votre apprentissage