Modules

Détail de la commande web-ext

Cette page liste toutes les commandes et options disponibles sous l'outil de ligne de commandes web-ext.

Commandes

Web-ext possède les commandes suivantes disponibles ; Les options spécifiques à ces commandes sont incluses dans les sous-sections.

web-ext build

Compresser les fichiers avec une extension .zip, en ignorant les fichiers qui sont communément désirée dans les paquets, tels que .git et autre artifacts. Le nom du fichier .zip est extrait du champ de name dans l'extension manifest.

--as-needed

Reconstruisez l'extension chaque fois que vous éditez et enregistrez un fichier source. Cela vous permet de créer en continu un package avec le code source le plus à jour.

Variable d'environnement : $WEB_EXT_AS_NEEDED=true

web-ext docs

Ouvre la documentation web-ext dans le navigateur par défaut de l'utilisateur.

web-ext lint

Indique les erreurs dans le manifest de l'extension ou dans d'autres fichiers de code source. Consultez le projet addons-linter pour plus d'informations sur le type de règles utilisées pour valider la source d'extension.

--output, -o

Le type de sortie à générer lors du rapport sur les erreurs. Choix : json ou texte.

Variable d'environnement : $WEB_EXT_OUTPUT

--metadata

Affichez seulement les métadonnées sur l'extension dans JSON.

Variable d'environnement : $WEB_EXT_METADATA=true

--pretty

Formatez la sortie JSON afin qu'elle soit plus facile à lire. Cela ne s'applique que lorsque --output est réglé sur json.

Variable d'environnement : $WEB_EXT_PRETTY=true

--self-hosted

Déclare que votre extension sera auto-hébergée. Cela désactive les messages liés à l'hébergement de addons.mozilla.org.

Variable d'environnement : $WEB_EXT_SELF_HOSTED=true

--boring

Désactive les caractères de coque colorés afin que la sortie ne contienne que du texte brut.

Variable d'environnement : $WEB_EXT_BORING=true

--warnings-as-errors, -w

Traitez les avertissements comme les erreurs en sortant non NULL pour les avertissements.

Variable d'environment : $WEB_EXT_WARNINGS_AS_ERRORS=true

web-ext run

Crée et installe temporairement une extension sur Firefox afin qu'elle puisse être testée. Par défaut, cela surveillera également tous les fichiers sources d'extension et rechargera l'extension dans Firefox à mesure que les fichiers changent.

--firefox, -f

Vous permet de spécifier une version particulière de Firefox pour exécuter l'extension. La valeur peut être un chemin absolu vers l'exécutable de Firefox ou elle peut être une chaîne d'alias. Si cela n'est pas spécifié, il tentera d'exécuter l'extension dans l'installation par défaut de Firefox sur le système.

Voici un exemple de spécifier un chemin complet vers un exécutable Firefox sous  Windows :

--firefox="C:\Program Files\Mozilla Firefox\firefox.exe"

Voici un exemple de spécification d'un chemin exécutable sur Mac OS :

--firefox=/Applications/FirefoxNightly.app/Contents/MacOS/firefox-bin

Vous pouvez également utiliser les alias, comme ceci:

--firefox=beta

 Voici tous les alias disponibles et les exécutables mappés pour:

Alias Firefox exécutable
firefox La version de Firefox
beta La version beta de Firefox
nightly La version nocturne de Firefox
firefoxdeveloperedition La version développeur de Firefox

Variable d'environnement : $WEB_EXT_FIREFOX

--firefox-profile, -p

Permet de spécifier un profil de base de Firefox pour exécuter l'extension. Ceci est spécifié comme une chaîne contenant votre nom de profil ou un chemin absolu vers son répertoire. Le profil que vous spécifiez est copié dans un nouveau profil temporaire et certains paramètres sont ajoutés pour que Web-ext fonctionne.

Si un profil n'est pas spécifié, il exécutera l'extension en utilisant un nouveau profil temporaire.

Variable d'environnement : $WEB_EXT_FIREFOX_PROFILE

--keep-profile-changes

Avec cette option, toute modification apportée au répertoire de profil (spécifié par --firefox-profile) sera enregistrée. will be saved. Sans cette option, les modifications de profil ne seront pas sauvegardées.

Cette option rend le profil spécifié par --firefox-profile complètement insécurisé pour une utilisation quotidienne. Il désactive les mises à jour automatiques et permet des connexions à distance silencieux, entre autres choses. Plus précisément, cela modifiera de manière destructive le profil requis pour que Web-ext opère.

Variable d'environnement : $WEB_EXT_KEEP_PROFILE_CHANGES=true

--no-reload

Ne chargez pas automatiquement l'extension dans le navigateur pendant que vous éditez et enregistrez les fichiers source.

Variable d'environnement : $WEB_EXT_NO_RELOAD=true

--pre-install

Préinstallez l'extension dans le profil avant de démarrer le navigateur. C'est une façon de supporter les versions antérieures à Firefox 49 car elles ne prennent pas en charge l'installation à distance. La spécification de cette option implique --no-reload.

Variable d'environnement : $WEB_EXT_PRE_INSTALL=true

--pref

Personnalisez les préférences de Firefox sans créer ou modifier le profil. Utilisez le signe égal pour définir les valeurs, par exemple:

--pref general.useragent.locale=fr-FR

Vous pouvez spécifier cette option plusieurs fois pour définir plus d'une préférence.

Variable d'environnement : $WEB_EXT_PREF

--browser-console, -bc

Cela ouvre automatiquement la console du navigateur au démarrage afin que vous puissiez voir les messages du journal pour votre extension. Exemple :

web-ext run --browser-console

Variable d'environnement : $WEB_EXT_BROWSER_CONSOLE=true

--start-url

Cela ouvrira automatiquement un onglet à l'URL spécifiée lorsque le navigateur démarrera. Exemple:

web-ext run --start-url www.mozilla.com

Vous pouvez cette option plusieurs fois pour ouvrir plusieurs onglets. Exemple :

web-ext run --start-url www.mozilla.com --start-url developer.mozilla.org

Variable d'environnement : $WEB_EXT_START_URL

web-ext sign

Compresse en une extension et signe là afin qu'elle puisse être auto-hébergée. Cela créera un fichier .xpi signé au lieu d'un fichier .zip. Vous devrez créer des informations d'accès à l'API pour exécuter cette commande.

--api-key

La clé API (JWT issuer) pour accéder à l'API addons.mozilla.org API. Cela devrait toujours être une chaîne.

Variable d'environnement : $WEB_EXT_API_KEY

--api-secret

La clé API (JWT secret) de ddons.mozilla.org API. Cela devrait toujours être une chaîne.

Variable d'environnement : $WEB_EXT_API_SECRET

--api-url-prefix

Le préfixe d'URL de l'API signé. Cela devrait toujours être une chaîne. Si ce n'est pas spécifié, cela dépendra par défaut de https://addons.mozilla.org/api/v3 qui est l'API de production.

Variable d'environnement : $WEB_EXT_API_URL_PREFIX

--api-proxy

Un hôte proxy à utiliser pour toutes les connexions API. Exemple : https://yourproxy:6000. En savoir plus sur  la façon dont les demandes de proxy fonctionnent. Il existe un section distincte sur la  signature dans un environnement restreint si l'approche par proxy ne fonctionne pas pour vour.

Variable d'environnement : $WEB_EXT_API_PROXY

--timeout

Nombre de milles-secondes à attendre avant d'abandonner une réponse du service Web de Mozilla. Cela devrait toujours être un nombre.

Variable d'environnement : $WEB_EXT_TIMEOUT

--id

Une chaîne d'identifiant personnalisée pour l'extension. Cela n'a aucun effet si l'extension déclare déjà un identifiant dans son manifest. Cette option peut être utile pour signer des versions d'une extension exisiting que vous possédez.

Variable d'environnement : $WEB_EXT_ID

Options globales

web-ext  possède les options globales suivantes pouvant s'appliquer à plusieurs commandes.

--artifacts-dir, -a

Spécifie un répertoire particulier pour enregistrer des artifacts dans, par exemple, le fichier .zip, une fois que vous avez construit une extension. Cela peut être spécifié comme un chemin relatif ou absolu, et doit toujours être une chaîne.

Note : si cela n'est pas spécifié, la valeur par défaut est le chemin relatif ./web-ext-artifacts.

Variable d'environnement : $WEB_EXT_ARTIFACTS_DIR

--ignore-files, -i

Une liste de modèles glob pour définir quels fichiers doivent être ignorés par la construction, l'exécution, peluche et d'autres commandes.  Si vous spécifiez des chemins relatifs, ils seront relatifs à votre --source-dir.

Voici un exemple d'ignorance de tout fichier dans votre répertoire --source-dir (où ces sous-répertoires) qui se termine par le suffixe .api-key:

web-ext build --ignore-files "**/*.api-key"

Vous pouvez spécifier plusieurs motifs en les séparant par des espaces :

web-ext build --ignore-files path/to/first.js path/to/second.js

Par défaut, sans l'utilisation de --ignore-files, les règles suivantes sont appliquées :

  • Tout fichier se terminant par .xpi ou .zip est ignoré
  • Tout fichier caché (qui commence par un point) est ignoré
  • Tout répertoire nommé node_modules est ignoré

Lorsque vous spécifiez des motifs personnalisés en utilisant --ignore-files, ils sont appliqués en ajoutant ern plus des modèles par défaut.

Note : L'ordre est important : vous devez spécifier la commande web-ext avant de spécifier l'option --ignore-files.

Variable d'environnement : $WEB_EXT_IGNORE_FILES

--help, -h

Liste toutes les commandes disponibles et les options disponibles pour l'outil web-ext.

Note : Vous pouvez lister les options disponibles pour une commande spécifique en incluant le nom de la commande lorsque vous demandez de l'aide, par exemple web-ext --help run

--source-dir, -s

Spécifie le répertoire du code source de l'extension, par exemple lors de la construction ou l'exécution d'une extension. Cela peut être spécifié comme un chemin relatif ou absolu, et doit toujours être une chaîne.

Note : Si cela n'est pas spécifié, la valeur par défaut est le répertoire que vous êtes actuellement dans votre terminal.

Variable d'environnement : $WEB_EXT_SOURCE_DIR

--verbose, -v

Affiche la sortie verbale lorsque les commandes sont exécutées.

Variable d'environnement : $WEB_EXT_VERBOSE=true

--version

Affiche le numéro de version de l'outil web-ext installé.

Options des paramètres des variables d'environnement

Les variables d'environnement peuvent être définies pour n'importe quelle option. Comme :

  1. Prenez le nom de l'option.
  2. Retirez les deux tirets au début.
  3. Convertissez les tirets restants en soulignements.
  4. Capitaliser les lettres.
  5. Préfixer le résultat avec $WEB_EXT_.

Donc, par exemple, au lieu de spécifier l'option source suivante chaque fois que vous souhaitez exécuter l'extension :

web-ext run --source-dir=/path/to/my/extension

Vous pouvez définir le répertoire source comme une variable d'environnement comme ceci :

WEB_EXT_SOURCE_DIR=/path/to/my/extension

Ensuite, vous pouvez simplement spécifier la commande run sans options :

web-ext run

Une option de ligne de commande remplacera toujours la variable d'environnement. Par exemple, cela ignore la variable d'environnement :

web-ext run --source-dir=/another/path/to/source

Pour définir une option de drapeau  vrai / faux (qui n'a pas de valeur sur la ligne de commande), définissez-le sur une chaîne littérale soit vrai ou faux. Exemple :

WEB_EXT_VERBOSE=true

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,