Exécuter et obtenir la sortie d'une commande shell dans node.js

C'est la façon dont je le fais dans un projet sur lequel je travaille actuellement.

var exec = require('child_process').exec;
function execute(command, callback){
    exec(command, function(error, stdout, stderr){ callback(stdout); });
};

Exemple: Récupérer les utilisateurs de git

module.exports.getGitUser = function(callback){
    execute("git config --global user.name", function(name){
        execute("git config --global user.email", function(email){
            callback({ name: name.replace("\n", ""), email: email.replace("\n", "") });
        });
    });
};

Si vous êtes à l'aide d'un noeud au plus tard 7.6 et vous n'aimez pas le rappel de style, vous pouvez également utiliser un nœud-util de promisify fonction avec async /await pour obtenir des commandes shell qui lire proprement. Voici un exemple de la accepté de répondre, à l'aide de cette technique:

const { promisify } = require('util');
const exec = promisify(require('child_process').exec)

module.exports.getGitUser = async function getGitUser () {
  const name = await exec('git config --global user.name')
  const email = await exec('git config --global user.email')
  return { name, email }
};

Cela a aussi l'avantage de renvoyer le refus de la promesse sur l'échec de commandes, qui peuvent être manipulés avec try /catch à l'intérieur de la async code.

Exigences

Cela nécessitera Node.js 7 ou plus tard avec un support pour des Promesses et Async/Await.

Solution

Créer une fonction wrapper qui tirent parti de promesses pour contrôler le comportement de la child_process.exec commande.

Explication

À l'aide de promesses et d'une fonction d'asynchrone, vous pouvez reproduire le comportement d'un shell retour de la sortie, sans tomber dans un rappel de l'enfer et avec une très soignée de l'API. À l'aide de la await mot-clé, vous pouvez créer un script qui se lit facilement, bien que toujours être en mesure de faire le travail de child_process.exec fait.

Exemple de Code

const childProcess = require("child_process");

/**
 * @param {string} command A shell command to execute
 * @return {Promise<string>} A promise that resolve to the output of the shell command, or an error
 * @example const output = await execute("ls -alh");
 */
function execute(command) {
  /**
   * @param {Function} resolve A function that resolves the promise
   * @param {Function} reject A function that fails the promise
   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
   */
  return new Promise(function(resolve, reject) {
    /**
     * @param {Error} error An error triggered during the execution of the childProcess.exec command
     * @param {string|Buffer} standardOutput The result of the shell command execution
     * @param {string|Buffer} standardError The error resulting of the shell command execution
     * @see https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
     */
    childProcess.exec(command, function(error, standardOutput, standardError) {
      if (error) {
        reject();

        return;
      }

      if (standardError) {
        reject(standardError);

        return;
      }

      resolve(standardOutput);
    });
  });
}

Utilisation

async function main() {
  try {
    const passwdContent = await execute("cat /etc/passwd");

    console.log(passwdContent);
  } catch (error) {
    console.error(error.toString());
  }

  try {
    const shadowContent = await execute("cat /etc/shadow");

    console.log(shadowContent);
  } catch (error) {
    console.error(error.toString());
  }
}

main();

Exemple De Sortie

root:x:0:0::/root:/bin/bash
[output trimmed, bottom line it succeeded]

Error: Command failed: cat /etc/shadow
cat: /etc/shadow: Permission denied

Essayer en ligne.

Repl.il.

Ressources externes

Promesses.

child_process.exec.

Node.js support de table.