doc / installation

Installer l'extension

Trois méthodes sont possibles, selon les contraintes de votre poste. Vous pouvez notamment essayer l'extension sans installer Node, Git ni aucun autre outil de développement.

Depuis le store d'extensions de votre navigateur — bientôt disponible

L'extension n'a pas encore été soumise au Chrome Web Store ni à Firefox Add-ons. Il n'existe donc pour l'instant aucune fiche permettant de l'installer directement depuis un store. En attendant leur publication, utilisez l'archive de release décrite ci-dessous.

pourquoi c'est important — et pas seulement plus pratique

Une extension installée depuis un store se met à jour automatiquement.

Une extension chargée manuellement depuis une archive ZIP reste sur la version installée tant que vous ne la mettez pas à jour vous-même. Pour un essai individuel, ce n'est généralement pas gênant. À l'échelle d'une équipe, en revanche, on peut rapidement se retrouver avec plusieurs versions différentes sans même s'en rendre compte. C'est pour cette raison que l'installation depuis les stores figure déjà ici : dès qu'elle sera disponible, ce sera la méthode recommandée pour un déploiement en équipe.

Depuis une archive ZIP de release — sans Node ni Git

C'est la méthode la plus simple sur un poste verrouillé où vous ne pouvez pas installer d'environnement de développement. Chaque release taguée fournit deux archives prêtes à charger : une pour les navigateurs basés sur Chromium et une pour Firefox.

1Téléchargez l'archive correspondant à votre navigateurOuvrez la liste des releases — utilisez bien la liste complète plutôt que /releases/latest, qui n'inclut pas les préversions. Téléchargez …-chromium.zip ou …-firefox.zip.
2Décompressez l'archive dans un emplacement permanentÉvitez de laisser le dossier extrait dans vos téléchargements. Les navigateurs basés sur Chromium chargent l'extension depuis ce dossier à chaque démarrage. Si vous le déplacez ou le supprimez par la suite, l'extension cessera de fonctionner.
3Chrome, Edge, Brave et les autres navigateurs basés sur ChromiumOuvrez chrome://extensions. Activez le Mode développeur, choisissez Charger l'extension non empaquetée, puis sélectionnez le dossier extrait qui contient directement manifest.json.
4FirefoxOuvrez about:debugging#/runtime/this-firefox. Choisissez Charger un module temporaire, puis sélectionnez directement le fichier manifest.json — pas le dossier. Firefox supprime les modules temporaires lorsque le navigateur est fermé.

une limite importante

Une extension installée de cette manière ne se met pas à jour automatiquement.

Cette méthode convient parfaitement pour essayer l'extension ou pour les postes sur lesquels vous ne pouvez pas installer les outils de compilation. En revanche, ce n'est pas une solution de distribution à long terme. Vous resterez sur la version installée jusqu'à ce que vous répétiez manuellement la procédure. Pour un déploiement à l'échelle d'une équipe, privilégiez les stores dès que les fiches seront disponibles.

Depuis les sources

Choisissez cette méthode si vous voulez examiner le code que vous exécutez ou contribuer au projet.

git clone https://github.com/reefact/conventional-comments-toolkit
cd conventional-comments-toolkit

npm ci
npm run build:extension     // → packages/extension/dist-ext

Chargez ensuite dist-ext en suivant la procédure correspondant à votre navigateur : l'étape 3 ci-dessus pour les navigateurs basés sur Chromium, ou l'étape 4 pour Firefox. La version Firefox est générée en même temps, dans son propre sous-dossier.

Node 20 ou une version plus récente est nécessaire. Le dépôt contient également un guide Windows/PowerShell détaillé, depuis l'installation de Node jusqu'au chargement de l'extension dans le navigateur.

Autorisez les domaines où vous faites vos revues

Fraîchement installée, l'extension n'est active nulle part — github.com compris. Elle ne détient d'accès permanent à aucun site : vous autorisez chaque domaine individuellement, et vous pouvez retirer cette autorisation de la même façon. La page d'options s'ouvre d'elle-même la première fois pour le dire, et vous propose une visite guidée que vous pouvez interrompre à tout moment ou rejouer plus tard.

1Ouvrez les réglages de l'extensionLa page s'ouvre seule juste après l'installation. Vous pouvez la rouvrir à tout moment depuis l'icône de l'extension, dans la barre d'outils de votre navigateur.
2Activez un domaine que l'extension connaît déjàgithub.com et Azure DevOps Services disposent chacun de leur propre carte : un clic demande l'autorisation à votre navigateur puis, une fois que vous l'avez accordée, enregistre la plateforme qui héberge ce domaine — vous n'avez donc jamais à la préciser pour ceux-là.
3Ajoutez tout autre domaine, et indiquez sa plateformeUne instance GitHub Enterprise Server, un Azure DevOps Server, une organisation visualstudio.com ou un serveur de configuration interne se saisissent à la main. L'extension ne peut pas savoir si devops.acme.internal héberge Azure DevOps ou GitHub Enterprise Server. Le choix de la plateforme lui permet d'activer l'adaptateur approprié.
4Accordez l'autorisation demandée par le navigateurC'est votre navigateur qui vous demande si l'extension peut accéder à ce domaine. Vous choisissez de l'autoriser ou non. Chaque domaine autorisé porte ensuite un bouton « Retirer » dans la page d'options, et les contrôles de votre navigateur permettent toujours de révoquer cette autorisation.

si vous mettez à jour depuis la 1.0.0-beta.10 ou une version antérieure

L'extension se tait sur github.com jusqu'à ce que vous l'autorisiez.

Les versions précédentes embarquaient une permission sur github.com, active dès l'installation et révocable depuis nulle part à l'intérieur de l'extension. Ce domaine passe désormais par la même autorisation en un clic que les autres, qu'aucune mise à jour ne peut accorder à votre place : un navigateur n'accorde une permission de site qu'à la suite d'une action explicite de votre part. La page d'options s'ouvre d'elle-même pour le dire — mais seulement si la mise à jour ne vous laisse aucun domaine en service. Si vous en aviez déjà un autre configuré, l'extension continue d'y fonctionner, et rien ne signale que github.com s'est tu.

Vérifier que tout fonctionne

Ouvrez une pull request sur un domaine que vous avez autorisé, et commencez à rédiger un commentaire de revue. Une rangée de labels doit apparaître au-dessus du champ de saisie, accompagnée d'un indicateur d'état en dessous. Tapez ?i, puis appuyez sur Tab. Le raccourci doit être remplacé par : issue:.

Si rien n'apparaît, la page de diagnostic présente les trois causes les plus fréquentes.