Tutoriel d'introduction à npx

Si vous commencez tout juste à apprendre JavaScript ou Node.js, vous avez probablement déjà rencontrénpmpour installer divers outils et bibliothèques. Parfois, nous pouvons simplement vouloir exécuter rapidement un outil pour voir son effet sans l'installer globalement, n'est-ce pas ?

Il existe aussi une autre situation : différents projets ont besoin de différentes versions d'outils en ligne de commande, et l'installation globale provoque toujours des conflits ?

npxC'est un outil puissant né pour résoudre ces problèmes.

npxIl s'agit d'un outil en ligne de commande introduit dans npm 5.2.0 qui vous permet d'exécuter des paquets npm sans installation globale.

En bref,npx est un outil pratique pour exécuter des paquets Node.js,et sa philosophie de conception centrale est :Utiliser temporairement sans installation permanente。

Une métaphore imagée

Imaginez votre boîte à outils maison :

  • npm... est comme votregestionnaire d'entrepôt d'outils. Lorsque vousnpm install -g some-tool, cela équivaut à dire au gestionnaire : achète cet outil et mets-le dans notre garage (environnement global) pour toujours.
  • npx... est comme unservice de courses à la demande. Lorsque vousnpx some-tool, cela équivaut à dire au coursier : va me chercher unsome-toolà utiliser, et rendez-le après usage, ne le mettez pas chez moi.

Utilisationnpx, vous pouvez exécuter n'importe quel paquet du registre npm sans avoir à l'installer d'abord sur votre ordinateur.

Problèmes traditionnels La solution de npx
Installation globale obligatoire Exécuter directement
Conflits de versions Utiliser une version spécifiée à chaque fois
Pollution de l'environnement Nettoyer après utilisation
Commandes locales difficiles à trouver Localiser automatiquement

Pourquoi utiliser npx ?

1. Résoudre la pollution des paquets globaux et les conflits de versions

DansnpxAvant l'apparition de npx, si vous vouliez utiliser des outils en ligne de commande commecreate-react-app、vue-cliles outils d'échafaudage, vous deviez d'abord les installer globalement :npm install -g create-react-app。

Cela pose deux problèmes :

  • Pollution de l'environnement global: le paquet installé occupera votre espace disque pendant longtemps, même si vous ne l'avez pas utilisé depuis un moment.
  • Conflits de versions: si vous développez deux projets, l'un nécessitecreate-react-app@3, un autre nécessitecreate-react-app@5, l'installation globale ne peut conserver qu'une seule version, ce qui empêchera l'un des projets de fonctionner normalement.

npxIl vous permet de spécifier directement une version à exécuter, puis de disparaître après utilisation, évitant parfaitement ces problèmes.

2. Exécuter facilement des paquets installés localement dans un projet

Dans le répertoire du projet, vousnpm install some-cli-toolpaquets installés (apparaîtront dansnode_modules/.bin/répertoire), ne peuvent généralement être invoqués que via des chemins complexes ou des scripts npm. Etnpxil peut intelligemment donner la priorité à l'utilisation de la version locale dans le projet courant, ce qui rend l'invocation très simple.

3. Essayer de nouveaux outils en toute sécurité et facilement

Vous voulez tester un outil en ligne de commande nouvellement publié ? Utilisez simplementnpx new-cool-toolpour l'essayer ! S'il ne convient pas, il ne laissera aucune trace sur votre ordinateur.


Comment fonctionne npx

Lorsque vous exécuteznpx <command>, il trouvera et exécutera la commande selon la logique suivante :

Ce processus est complètement transparent pour l'utilisateur ; il vous suffit de profiter de la commodité qu'il apporte.


Comment utiliser npx ?

Préparation de l’environnement

Assurez-vous que votre version de Node.js est >= 5.2.0. Vous pouvez vérifier avec la commande suivante :

node --version
npm --version
# 如果 npm 版本 >= 5.2.0,npx 就已经可用了
npx --version

Syntaxe de base

npx [选项] <命令>[@版本] [命令的参数...]

Descriptions des paramètres d'option courants

Option Nom complet Description
--no-install Forcez npx à n'utiliser que les paquets existants localement. Si aucun n'est disponible localement, signalez une erreur et ne téléchargez pas.
--ignore-existing Ignorez les paquets existants localement et forcez le téléchargement de la dernière version depuis le dépôt distant.
-p, --package <包名> Spécifiez les paquets à installer. C'est très utile lorsque vous devez utiliser plusieurs paquets en même temps.
-c <命令字符串> Lors de l'utilisation-pLorsque vous spécifiez plusieurs paquets, utilisez-cpour indiquer à npx la commande spécifique à exécuter.
--yes Répondre automatiquement "oui" lorsqu'il est connu qu'une invite serait déclenchée (par exemple, create-react-app demande s'il faut continuer).

Exemples d'applications pratiques

Regardons quelques exemples spécifiques pour voir commentnpxil peut démontrer sa puissance.

Exemple 1 : Exécuter une commande ponctuelle (scénario le plus courant)

Vous voulez utilisercowsayce petit outil amusant pour faire parler une vache dans le terminal, mais vous ne voulez pas l'installer.

Étape 1 : Exécuter directement avec npx

npx cowsay hello

Explication du code:npxIl vérifiera si le paquet localcowsayexiste. Sinon, il télécharge automatiquement depuis npm et nettoie automatiquement après l'exécution de la commande.

Sortie attendue:

npx cowsay hello

Need to install the following packages:
cowsay@1.6.0
Ok to proceed? (y) y
 _______
< hello >
 -------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

Étape 2 : Exécuter avec une version spécifiqueSi vous voulez utiliser une version spécifique :

npx cowsay@1.4.0 hello1.4.0

Sortie :

 ____________
< hello1.4.0 >
 ------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

Exemple 2 : Utiliser un squelette pour créer un projet

Prenons comme exemple la création d'un projet React :

Méthode traditionnelle (désormais déconseillée):

npm install -g create-react-app  # 全局安装
create-react-app my-app          # 使用

Problèmes avec cette méthode d’installation :

  • Installe globalement tout un tas d’outils
  • Confusion des versions
  • L’ordinateur devient de plus en plus surchargé

Méthode moderne (avec npx):

npx create-react-app my-app

Explication du code:npxIl récupérera temporairement la dernière version decreate-react-app, l’utilisera pour construire le squelette du projet, et une fois terminé, il ne laissera pascreate-react-appdans votre environnement global. La prochaine fois que vous créerez un projet, il récupérera toujours la dernière version.

Exemple 3 : Exécuter des outils locaux au projet

Supposons que vous ayez installéwebpackcomme dépendance de développement (npm install webpack --save-dev)。

Invocation traditionnelle (fastidieuse):

# 需要输入冗长的路径
./node_modules/.bin/webpack --version

# 或者在 package.json 中配置 scripts
# "scripts": { "build": "webpack" }
# 然后运行
npm run build

Utilisation de npx (très concise):

npx webpack --version
# 或直接运行构建
npx webpack

Explication du code:npxIl privilégiera intelligemment la recherche dunode_modulessouswebpackà exécuter.

Exemple 4 : Exécuter un script depuis GitHub

npxVous pouvez même exécuter du code provenant de gists ou de dépôts GitHub.

npx https://gist.github.com/username/abcdefg

Veuillez noter que l'exécution de code inconnu provenant d'Internet comporte des risques de sécurité ; assurez-vous que la source est fiable.


Les trois capacités principales de npx

1. Exécuter directement n'importe quel paquet npm

Format général :

npx 包名

Exemple :

npx cowsay hello

Il exécutera directement une petite vache en ligne de commande 🐮

2. Exécuter les dépendances locales du projet

De nombreux outils ne sont installés que dans le projet :

npm install vite

Auparavant, vous deviez :

./node_modules/.bin/vite

Maintenant :

npx vite

Trouve automatiquement les fichiers exécutables locaux pour vous

3. Exécuter avec la dernière version (ne pollue pas le système)

npx create-next-app@latest my-app

Toujours utiliser la dernière version du scaffolding

Pas besoin de mettre à jour les outils globaux


Scénarios npx les plus courants

Création de projets

npx create-react-app my-app
npx create-next-app
npx vue-cli create my-vue
npx degit user/repo

Outils temporaires

npx eslint .
npx prettier --write .
npx serve .

Lancer un serveur de développement

npx vite
npx nodemon app.js

Astuces et considérations avancées

1. Combiner plusieurs paquets

Parfois, une commande doit dépendre de plusieurs paquets. Par exemple, vous souhaitez démarrer un simple serveur HTTP dans un répertoire et en même temps utiliserbrowser-syncpour implémenter le rechargement en direct. Bien que ce ne soit pas courant,npxcela peut se faire :

npx -p http-server -p browser-sync -c 'http-server & browser-sync start --proxy "localhost:8080" --files "**/*"'

Explication du code:

  • -pSpécifiez les paquets à préparer.
  • -cSpécifiez la chaîne de commande complète à exécuter.

2. Considérations

  • Connexion réseau: La première fois que vous exécutez un paquet, il doit être téléchargé depuis le réseau, et la vitesse dépend de votre réseau.
  • Sécurité:npxIl téléchargera et exécutera automatiquement du code.N'exécutez que les sources et les paquets en lesquels vous avez confiance.。
  • Répertoire temporaire: Les paquets téléchargés sont stockés dans le répertoire temporaire du système d'exploitation et peuvent être nettoyés périodiquement par le système.
Autres extensions