如何检测Node.js脚本是否通过shell管道运行？

Question

我的问题类似于这个问题:如何检测我的shell脚本是否通过管道运行？.不同之处在于我正在处理的shell脚本是用Node.js编写的.

假设我输入:

echo "foo bar" | ./test.js

然后,我怎么能得到的价值"foo bar"的test.js？

我读过Unix和Node:Pipes and Streams,但这似乎只提供了一个异步解决方案(除非我弄错了).我正在寻找同步解决方案.此外,使用这种技术,检测脚本是否被管道传输似乎并不是非常简单.

TL; DR我的问题有两个:

1. 如何检测Node.js脚本是否通过shell管道运行,例如echo "foo bar" | ./test.js？
2. 如果是这样,如何读出Node.js中的管道值？

Answer 1

我刚刚找到了一个问题的简单答案.

要快速并同步检测管道内容是否正在传递给Node.js中的当前脚本,请使用process.stdin.isTTY布尔值:

$ node -p -e 'process.stdin.isTTY'
true
$ echo 'foo' | node -p -e 'process.stdin.isTTY'
undefined

因此,在脚本中,您可以执行以下操作:

if (process.stdin.isTTY) {
  // handle shell arguments
} else {
  // handle piped content (see Jerome’s answer)
}

之前我没有找到这个的原因是因为我正在查看文档process,其中isTTY根本没有提到.相反,它在TTY文档中提到过.

Answer 2

管道用于处理小输入,如"foo bar",但也可以处理大文件.

流API确保您可以开始处理数据,而无需等待巨大的文件完全通过(这对速度和内存更好).它的方式是给你数据块.

管道没有同步API.如果您真的想在做某事之前掌握整个管道输入,您可以使用

注意:仅使用节点> = 0.10.0,因为该示例使用stream2 API

var data = '';
function withPipe(data) {
   console.log('content was piped');
   console.log(data.trim());
}
function withoutPipe() {
   console.log('no content was piped');
}

var self = process.stdin;
self.on('readable', function() {
    var chunk = this.read();
    if (chunk === null) {
        withoutPipe();
    } else {
       data += chunk;
    }
});
self.on('end', function() {
   withPipe(data);
});

测试

echo "foo bar" | node test.js

和

node test.js

Answer 3

事实证明这process.stdin.isTTY是不可靠的，因为您可以生成一个不是 TTY 的子进程。

我在这里使用文件描述符找到了更好的解决方案。

您可以测试您的程序是否使用这些函数输入或输出：

function pipedIn(cb) {
    fs.fstat(0, function(err, stats) {
        if (err) {
            cb(err)
        } else {
            cb(null, stats.isFIFO())
        }
    })
}

function pipedOut(cb) {
    fs.fstat(1, function(err, stats) {
        if (err) {
            cb(err)
        } else {
            cb(null, stats.isFIFO())
        }
    })
}

pipedIn((err, x) => console.log("in", x))
pipedOut((err, x) => console.log("out", x))

这里有一些测试证明它有效。

??? node pipes.js
in false
out false
??? node pipes.js | cat -
in false
out true
??? echo 'hello' | node pipes.js | cat -
in true
out true
??? echo 'hello' | node pipes.js
in true
out false
??? node -p -e "let x = require('child_process').exec(\"node pipes.js\", (err, res) => console.log(res))"
undefined
in false
out false
??? node -p -e "let x = require('child_process').exec(\"echo 'hello' | node pipes.js\", (err, res) => console.log(res))"
undefined
in true
out false
??? node -p -e "let x = require('child_process').exec(\"echo 'hello' | node pipes.js | cat -\", (err, res) => console.log(res))"
undefined
in true
out true
??? node -p -e "let x = require('child_process').exec(\"node pipes.js | cat -\", (err, res) => console.log(res))"
undefined
in false
out true