Comment écrire des scripts Shell dans Node avec la bibliothèque zx de Google

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre l’écriture de scripts shell assez difficile.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il dispose de fonctionnalités linguistiques intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Il y a quelques conditions requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et Node.js.
• Vous devez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js

>= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion des stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

ls`;

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre les scripts shell assez difficiles à utiliser.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il possède des fonctions de langage intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Quelques conditions sont requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et de Node.js.
• Vous devrez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js >= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion de stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

import { $ } from "zx";

await $`ls`;

Et voici le résultat de l’exécution de ce code :

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

La syntaxe JavaScript de l’exemple ci-dessus peut sembler un peu bizarre. Elle utilise une fonctionnalité du langage appelée  » tagged template literals ». Fonctionnellement, c’est la même chose que d’écrire await $("ls").

Le zx de Google fournit plusieurs autres fonctions utilitaires pour faciliter la création de scripts shell, telles que :

• cd(). Ceci nous permet de changer notre répertoire de travail actuel.
• question(). Il s’agit d’une enveloppe autour du module readline de Node.js. Il permet de solliciter l’entrée de l’utilisateur de manière simple.

En plus des fonctions utilitaires que zx fournit, il met également à notre disposition plusieurs bibliothèques populaires, telles que :

• craie. Cette bibliothèque nous permet d’ajouter de la couleur à la sortie de nos scripts.
• minimaliste. Une bibliothèque qui analyse les arguments de la ligne de commande. Ils sont ensuite exposés sous un objet argv.
• récupérer. Une implémentation Node.js populaire de l’API Fetch. Nous pouvons l’utiliser pour effectuer des requêtes HTTP.
• fs-extra. Une bibliothèque qui expose le module fs de base de Node.js, ainsi qu’un certain nombre de méthodes supplémentaires pour faciliter le travail avec un système de fichiers.

Maintenant que nous savons ce que zx nous apporte, créons notre premier script shell avec lui.

Hello World avec zx de Google

Tout d’abord, créons un nouveau projet :

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

Ensuite, nous pouvons installer la bibliothèque zx:

npm install --save-dev zx

Remarque : la documentation de zxsuggère d’installer la bibliothèque de manière globale avec npm. En l’installant plutôt en tant que dépendance locale de notre projet, nous pouvons nous assurer que zx est toujours installée, ainsi que contrôler la version que nos scripts shell utilisent.

Attente de

haut niveau
Afin d’utiliser le top-level await dans Node.js – await en dehors d’une fonction asynchrone – nous devons écrire notre code dans des modules ECMAScript (ES), qui prennent en charge le top-level await. Nous pouvons indiquer que tous les modules d’un projet sont des modules ES en ajoutant "type" : "module" dans notre package.json, ou nous pouvons définir l’extension de fichier des scripts individuels sur .mjs. Nous utiliserons l’extension de fichier .mjs pour les exemples de cet article.

Exécution d’une commande et capture de sa sortie

Créons un nouveau script nommé hello-world.mjs. Nous ajouterons une ligne shebang, qui indique au noyau du système d’exploitation (OS) d’exécuter le script avec le programme node:

#! /usr/bin/envnode

Maintenant, nous allons ajouter du code qui utilise zx pour exécuter une commande.

Dans le code suivant, nous lançons une commande pour exécuter le programme ls. Le programme ls listera les fichiers dans le répertoire de travail actuel (le répertoire dans lequel se trouve le script). Nous allons capturer la sortie standard du processus de la commande, la stocker dans une variable et ensuite l’enregistrer dans le terminal :

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

Remarque : la documentation de zx suggère de mettre /usr/bin/env zx dans la ligne shebang de nos scripts, mais nous utilisons plutôt /usr/bin/env node. Ceci est dû au fait que nous avons installé zx comme une dépendance locale de notre projet. Nous importons ensuite explicitement les fonctions et les objets que nous voulons utiliser à partir du paquet zx. Cela permet d’indiquer clairement d’où proviennent les dépendances utilisées dans notre script.

Nous utiliserons ensuite chmod pour rendre le script exécutable :

chmod u+x hello-world.mjs

Exécutons notre script :

./hello-world.mjs

Nous devrions maintenant voir la sortie suivante :

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

Vous remarquerez quelques éléments dans la sortie de notre script shell :

• La commande que nous avons exécutée(ls) est incluse dans la sortie.
• La sortie de la commande est affichée deux fois.
• Il y a une nouvelle ligne supplémentaire à la fin de la sortie.

zx fonctionne en mode verbeux par défaut. Il affiche la commande que vous passez à la fonction $ et affiche également la sortie standard de cette commande. Nous pouvons modifier ce comportement en ajoutant la ligne de code suivante avant d’exécuter la commande ls:

$.verbose = false;

La plupart des programmes de ligne de commande, tels que ls, affichent un caractère de nouvelle ligne à la fin de leur sortie pour rendre la sortie plus lisible dans le terminal. C’est une bonne chose pour la lisibilité, mais comme nous stockons la sortie dans une variable, nous ne voulons pas de cette nouvelle ligne supplémentaire. Nous pouvons nous en débarrasser avec la fonction JavaScript String#trim():

- const output = (await 

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre les scripts shell assez difficiles à utiliser.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il possède des fonctions de langage intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Quelques conditions sont requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et de Node.js.
• Vous devrez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js >= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion de stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

import { $ } from "zx";

await $`ls`;

Et voici le résultat de l’exécution de ce code :

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

La syntaxe JavaScript de l’exemple ci-dessus peut sembler un peu bizarre. Elle utilise une fonctionnalité du langage appelée  » tagged template literals ». Fonctionnellement, c’est la même chose que d’écrire await $("ls").

Le zx de Google fournit plusieurs autres fonctions utilitaires pour faciliter la création de scripts shell, telles que :

• cd(). Ceci nous permet de changer notre répertoire de travail actuel.
• question(). Il s’agit d’une enveloppe autour du module readline de Node.js. Il permet de solliciter l’entrée de l’utilisateur de manière simple.

En plus des fonctions utilitaires que zx fournit, il met également à notre disposition plusieurs bibliothèques populaires, telles que :

• craie. Cette bibliothèque nous permet d’ajouter de la couleur à la sortie de nos scripts.
• minimaliste. Une bibliothèque qui analyse les arguments de la ligne de commande. Ils sont ensuite exposés sous un objet argv.
• récupérer. Une implémentation Node.js populaire de l’API Fetch. Nous pouvons l’utiliser pour effectuer des requêtes HTTP.
• fs-extra. Une bibliothèque qui expose le module fs de base de Node.js, ainsi qu’un certain nombre de méthodes supplémentaires pour faciliter le travail avec un système de fichiers.

Maintenant que nous savons ce que zx nous apporte, créons notre premier script shell avec lui.

Hello World avec zx de Google

Tout d’abord, créons un nouveau projet :

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

Ensuite, nous pouvons installer la bibliothèque zx:

npm install --save-dev zx

Remarque : la documentation de zxsuggère d’installer la bibliothèque de manière globale avec npm. En l’installant plutôt en tant que dépendance locale de notre projet, nous pouvons nous assurer que zx est toujours installée, ainsi que contrôler la version que nos scripts shell utilisent.

Attente de

haut niveau
Afin d’utiliser le top-level await dans Node.js – await en dehors d’une fonction asynchrone – nous devons écrire notre code dans des modules ECMAScript (ES), qui prennent en charge le top-level await. Nous pouvons indiquer que tous les modules d’un projet sont des modules ES en ajoutant "type" : "module" dans notre package.json, ou nous pouvons définir l’extension de fichier des scripts individuels sur .mjs. Nous utiliserons l’extension de fichier .mjs pour les exemples de cet article.

Exécution d’une commande et capture de sa sortie

Créons un nouveau script nommé hello-world.mjs. Nous ajouterons une ligne shebang, qui indique au noyau du système d’exploitation (OS) d’exécuter le script avec le programme node:

#! /usr/bin/envnode

Maintenant, nous allons ajouter du code qui utilise zx pour exécuter une commande.

Dans le code suivant, nous lançons une commande pour exécuter le programme ls. Le programme ls listera les fichiers dans le répertoire de travail actuel (le répertoire dans lequel se trouve le script). Nous allons capturer la sortie standard du processus de la commande, la stocker dans une variable et ensuite l’enregistrer dans le terminal :

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

Remarque : la documentation de zx suggère de mettre /usr/bin/env zx dans la ligne shebang de nos scripts, mais nous utilisons plutôt /usr/bin/env node. Ceci est dû au fait que nous avons installé zx comme une dépendance locale de notre projet. Nous importons ensuite explicitement les fonctions et les objets que nous voulons utiliser à partir du paquet zx. Cela permet d’indiquer clairement d’où proviennent les dépendances utilisées dans notre script.

Nous utiliserons ensuite chmod pour rendre le script exécutable :

chmod u+x hello-world.mjs

Exécutons notre script :

./hello-world.mjs

Nous devrions maintenant voir la sortie suivante :

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

Vous remarquerez quelques éléments dans la sortie de notre script shell :

• La commande que nous avons exécutée(ls) est incluse dans la sortie.
• La sortie de la commande est affichée deux fois.
• Il y a une nouvelle ligne supplémentaire à la fin de la sortie.

zx fonctionne en mode verbeux par défaut. Il affiche la commande que vous passez à la fonction $ et affiche également la sortie standard de cette commande. Nous pouvons modifier ce comportement en ajoutant la ligne de code suivante avant d’exécuter la commande ls:

$.verbose = false;

La plupart des programmes de ligne de commande, tels que ls, affichent un caractère de nouvelle ligne à la fin de leur sortie pour rendre la sortie plus lisible dans le terminal. C’est une bonne chose pour la lisibilité, mais comme nous stockons la sortie dans une variable, nous ne voulons pas de cette nouvelle ligne supplémentaire. Nous pouvons nous en débarrasser avec la fonction JavaScript String#trim():

- const output = (await 

import { $ } from "zx";

attendez 

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

$ ls

mkdir zx-shell-scripts
cd zx-shell-scripts

npm

npm install

#! /usr/bin/env

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre le scriptage de l’interpréteur de commandes assez maladroit.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il dispose de fonctionnalités linguistiques intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Il y a quelques conditions requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et Node.js.
• Vous devez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js

>= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion des stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

ls`;

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre les scripts shell assez difficiles à utiliser.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il possède des fonctions de langage intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Quelques conditions sont requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et de Node.js.
• Vous devrez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js >= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion de stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

import { $ } from "zx";

await $`ls`;

Et voici le résultat de l’exécution de ce code :

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

La syntaxe JavaScript de l’exemple ci-dessus peut sembler un peu bizarre. Elle utilise une fonctionnalité du langage appelée  » tagged template literals ». Fonctionnellement, c’est la même chose que d’écrire await $("ls").

Le zx de Google fournit plusieurs autres fonctions utilitaires pour faciliter la création de scripts shell, telles que :

• cd(). Ceci nous permet de changer notre répertoire de travail actuel.
• question(). Il s’agit d’une enveloppe autour du module readline de Node.js. Il permet de solliciter l’entrée de l’utilisateur de manière simple.

En plus des fonctions utilitaires que zx fournit, il met également à notre disposition plusieurs bibliothèques populaires, telles que :

• craie. Cette bibliothèque nous permet d’ajouter de la couleur à la sortie de nos scripts.
• minimaliste. Une bibliothèque qui analyse les arguments de la ligne de commande. Ils sont ensuite exposés sous un objet argv.
• récupérer. Une implémentation Node.js populaire de l’API Fetch. Nous pouvons l’utiliser pour effectuer des requêtes HTTP.
• fs-extra. Une bibliothèque qui expose le module fs de base de Node.js, ainsi qu’un certain nombre de méthodes supplémentaires pour faciliter le travail avec un système de fichiers.

Maintenant que nous savons ce que zx nous apporte, créons notre premier script shell avec lui.

Hello World avec zx de Google

Tout d’abord, créons un nouveau projet :

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

Ensuite, nous pouvons installer la bibliothèque zx:

npm install --save-dev zx

Remarque : la documentation de zxsuggère d’installer la bibliothèque de manière globale avec npm. En l’installant plutôt en tant que dépendance locale de notre projet, nous pouvons nous assurer que zx est toujours installée, ainsi que contrôler la version que nos scripts shell utilisent.

Attente de

haut niveau
Afin d’utiliser le top-level await dans Node.js – await en dehors d’une fonction asynchrone – nous devons écrire notre code dans des modules ECMAScript (ES), qui prennent en charge le top-level await. Nous pouvons indiquer que tous les modules d’un projet sont des modules ES en ajoutant "type" : "module" dans notre package.json, ou nous pouvons définir l’extension de fichier des scripts individuels sur .mjs. Nous utiliserons l’extension de fichier .mjs pour les exemples de cet article.

Exécution d’une commande et capture de sa sortie

Créons un nouveau script nommé hello-world.mjs. Nous ajouterons une ligne shebang, qui indique au noyau du système d’exploitation (OS) d’exécuter le script avec le programme node:

#! /usr/bin/envnode

Maintenant, nous allons ajouter du code qui utilise zx pour exécuter une commande.

Dans le code suivant, nous lançons une commande pour exécuter le programme ls. Le programme ls listera les fichiers dans le répertoire de travail actuel (le répertoire dans lequel se trouve le script). Nous allons capturer la sortie standard du processus de la commande, la stocker dans une variable et ensuite l’enregistrer dans le terminal :

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

Remarque : la documentation de zx suggère de mettre /usr/bin/env zx dans la ligne shebang de nos scripts, mais nous utilisons plutôt /usr/bin/env node. Ceci est dû au fait que nous avons installé zx comme une dépendance locale de notre projet. Nous importons ensuite explicitement les fonctions et les objets que nous voulons utiliser à partir du paquet zx. Cela permet d’indiquer clairement d’où proviennent les dépendances utilisées dans notre script.

Nous utiliserons ensuite chmod pour rendre le script exécutable :

chmod u+x hello-world.mjs

Exécutons notre script :

./hello-world.mjs

Nous devrions maintenant voir la sortie suivante :

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

Vous remarquerez quelques éléments dans la sortie de notre script shell :

• La commande que nous avons exécutée(ls) est incluse dans la sortie.
• La sortie de la commande est affichée deux fois.
• Il y a une nouvelle ligne supplémentaire à la fin de la sortie.

zx fonctionne en mode verbeux par défaut. Il affiche la commande que vous passez à la fonction $ et affiche également la sortie standard de cette commande. Nous pouvons modifier ce comportement en ajoutant la ligne de code suivante avant d’exécuter la commande ls:

$.verbose = false;

La plupart des programmes de ligne de commande, tels que ls, affichent un caractère de nouvelle ligne à la fin de leur sortie pour rendre la sortie plus lisible dans le terminal. C’est une bonne chose pour la lisibilité, mais comme nous stockons la sortie dans une variable, nous ne voulons pas de cette nouvelle ligne supplémentaire. Nous pouvons nous en débarrasser avec la fonction JavaScript String#trim():

- const output = (await 

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre les scripts shell assez difficiles à utiliser.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il possède des fonctions de langage intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Quelques conditions sont requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et de Node.js.
• Vous devrez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js >= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion de stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

import { $ } from "zx";

await $`ls`;

Et voici le résultat de l’exécution de ce code :

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

La syntaxe JavaScript de l’exemple ci-dessus peut sembler un peu bizarre. Elle utilise une fonctionnalité du langage appelée  » tagged template literals ». Fonctionnellement, c’est la même chose que d’écrire await $("ls").

Le zx de Google fournit plusieurs autres fonctions utilitaires pour faciliter la création de scripts shell, telles que :

• cd(). Ceci nous permet de changer notre répertoire de travail actuel.
• question(). Il s’agit d’une enveloppe autour du module readline de Node.js. Il permet de solliciter l’entrée de l’utilisateur de manière simple.

En plus des fonctions utilitaires que zx fournit, il met également à notre disposition plusieurs bibliothèques populaires, telles que :

• craie. Cette bibliothèque nous permet d’ajouter de la couleur à la sortie de nos scripts.
• minimaliste. Une bibliothèque qui analyse les arguments de la ligne de commande. Ils sont ensuite exposés sous un objet argv.
• récupérer. Une implémentation Node.js populaire de l’API Fetch. Nous pouvons l’utiliser pour effectuer des requêtes HTTP.
• fs-extra. Une bibliothèque qui expose le module fs de base de Node.js, ainsi qu’un certain nombre de méthodes supplémentaires pour faciliter le travail avec un système de fichiers.

Maintenant que nous savons ce que zx nous apporte, créons notre premier script shell avec lui.

Hello World avec zx de Google

Tout d’abord, créons un nouveau projet :

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

Ensuite, nous pouvons installer la bibliothèque zx:

npm install --save-dev zx

Remarque : la documentation de zxsuggère d’installer la bibliothèque de manière globale avec npm. En l’installant plutôt en tant que dépendance locale de notre projet, nous pouvons nous assurer que zx est toujours installée, ainsi que contrôler la version que nos scripts shell utilisent.

Attente de

haut niveau
Afin d’utiliser le top-level await dans Node.js – await en dehors d’une fonction asynchrone – nous devons écrire notre code dans des modules ECMAScript (ES), qui prennent en charge le top-level await. Nous pouvons indiquer que tous les modules d’un projet sont des modules ES en ajoutant "type" : "module" dans notre package.json, ou nous pouvons définir l’extension de fichier des scripts individuels sur .mjs. Nous utiliserons l’extension de fichier .mjs pour les exemples de cet article.

Exécution d’une commande et capture de sa sortie

Créons un nouveau script nommé hello-world.mjs. Nous ajouterons une ligne shebang, qui indique au noyau du système d’exploitation (OS) d’exécuter le script avec le programme node:

#! /usr/bin/envnode

Maintenant, nous allons ajouter du code qui utilise zx pour exécuter une commande.

Dans le code suivant, nous lançons une commande pour exécuter le programme ls. Le programme ls listera les fichiers dans le répertoire de travail actuel (le répertoire dans lequel se trouve le script). Nous allons capturer la sortie standard du processus de la commande, la stocker dans une variable et ensuite l’enregistrer dans le terminal :

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

Remarque : la documentation de zx suggère de mettre /usr/bin/env zx dans la ligne shebang de nos scripts, mais nous utilisons plutôt /usr/bin/env node. Ceci est dû au fait que nous avons installé zx comme une dépendance locale de notre projet. Nous importons ensuite explicitement les fonctions et les objets que nous voulons utiliser à partir du paquet zx. Cela permet d’indiquer clairement d’où proviennent les dépendances utilisées dans notre script.

Nous utiliserons ensuite chmod pour rendre le script exécutable :

chmod u+x hello-world.mjs

Exécutons notre script :

./hello-world.mjs

Nous devrions maintenant voir la sortie suivante :

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

Vous remarquerez quelques éléments dans la sortie de notre script shell :

• La commande que nous avons exécutée(ls) est incluse dans la sortie.
• La sortie de la commande est affichée deux fois.
• Il y a une nouvelle ligne supplémentaire à la fin de la sortie.

zx fonctionne en mode verbeux par défaut. Il affiche la commande que vous passez à la fonction $ et affiche également la sortie standard de cette commande. Nous pouvons modifier ce comportement en ajoutant la ligne de code suivante avant d’exécuter la commande ls:

$.verbose = false;

La plupart des programmes de ligne de commande, tels que ls, affichent un caractère de nouvelle ligne à la fin de leur sortie pour rendre la sortie plus lisible dans le terminal. C’est une bonne chose pour la lisibilité, mais comme nous stockons la sortie dans une variable, nous ne voulons pas de cette nouvelle ligne supplémentaire. Nous pouvons nous en débarrasser avec la fonction JavaScript String#trim():

- const output = (await 

import { $ } from "zx";

attendez 

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

$ ls

mkdir zx-shell-scripts
cd zx-shell-scripts

npm

npm install

#! /usr/bin/env

Écriture de scripts shell : le problème

La création d’un script shell – un script qui est exécuté par un shell tel que Bash ou zsh – peut être un excellent moyen d’automatiser des tâches répétitives. Node.js semble être un choix idéal pour écrire un script shell, car il nous fournit un certain nombre de modules de base et nous permet d’importer toute bibliothèque de notre choix. Il nous donne également accès aux caractéristiques du langage et aux fonctions intégrées fournies par JavaScript.

Mais si vous avez essayé d’écrire un script shell pour l’exécuter sous Node.js, vous avez probablement constaté que ce n’est pas aussi facile que vous le souhaiteriez. Vous devez écrire une gestion spéciale pour les processus enfants, prendre soin de l’échappement des arguments de la ligne de commande, et ensuite vous retrouver à jouer avec stdout (sortie standard) et stderr (erreur standard). Ce n’est pas particulièrement intuitif et cela peut rendre le scriptage de l’interpréteur de commandes assez maladroit.

Le langage de script shell Bash est un choix populaire pour écrire des scripts shell. Il n’est pas nécessaire d’écrire du code pour gérer les processus enfants, et il dispose de fonctionnalités linguistiques intégrées pour travailler avec stdout et stderr. Mais il n’est pas non plus si facile d’écrire des scripts shell avec Bash. La syntaxe peut être assez confuse, ce qui rend difficile l’implémentation d’une logique ou la gestion d’éléments tels que les invites de saisie de l’utilisateur.

La bibliothèque zx de Google permet de rendre les scripts shell avec Node.js efficaces et agréables.

Conditions requises pour le suivi

Il y a quelques conditions requises pour suivre cet article :

• Idéalement, vous devez être familier avec les bases de JavaScript et Node.js.
• Vous devez être à l’aise pour exécuter des commandes dans un terminal.
• Vous devez avoir installé Node.js

>= v14.13.1.

L’ensemble du code de cet article est disponible sur GitHub.

Comment fonctionne le zx de Google ?

Google’s zx fournit des fonctions qui englobent la création de processus enfants et la gestion des stdout et stderr de ces processus. La principale fonction avec laquelle nous allons travailler est la fonction $. Voici un exemple de cette fonction en action :

import { $ } from "zx";

attendez

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

import { $ } from "zx";

attendez 

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

$ ls

mkdir zx-shell-scripts
cd zx-shell-scripts

npm

npm install

#! /usr/bin/env

import { $ } from "zx";

const output = (await 

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

import { $ } from "zx";

attendez 

import { $ } from "zx";

await $`ls`;

$ ls
bootstrap-tool
hello-world
node_modules
package.json
README.md
typescript

mkdir zx-shell-scripts
cd zx-shell-scripts

npm init --yes

npm install --save-dev zx

#! /usr/bin/envnode

import { $ } from "zx";

const output = (await $`ls`).stdout;

console.log(output);

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls
hello-world.mjs
node_modules
package.json
package-lock.json
README.md
hello-world.mjs
node_modules
package.json
package-lock.json
README.md

$.verbose = false;

- const output = (await 

$ ls

mkdir zx-shell-scripts
cd zx-shell-scripts

npm

npm install

#! /usr/bin/env

chmod u+x hello-world.mjs

./hello-world.mjs

$ ls

$.verbose = false;