mirror of
https://github.com/shelljs/shelljs.git
synced 2026-01-25 16:07:37 +00:00
9237f66c52
No change to logic, only docs. In v0.7.0, we introduced ShellStrings and changed most methods to return them. Docs weren't appropriately updated, so this PR cross-links these methods to the ShellString docs. This also expands on the ShellString docs themselves, since there was room to make this clearer. Fixes #933
77 lines
1.8 KiB
JavaScript
77 lines
1.8 KiB
JavaScript
var common = require('./common');
|
|
var fs = require('fs');
|
|
|
|
common.register('cat', _cat, {
|
|
canReceivePipe: true,
|
|
cmdOptions: {
|
|
'n': 'number',
|
|
},
|
|
});
|
|
|
|
//@
|
|
//@ ### cat([options,] file [, file ...])
|
|
//@ ### cat([options,] file_array)
|
|
//@
|
|
//@ Available options:
|
|
//@
|
|
//@ + `-n`: number all output lines
|
|
//@
|
|
//@ Examples:
|
|
//@
|
|
//@ ```javascript
|
|
//@ var str = cat('file*.txt');
|
|
//@ var str = cat('file1', 'file2');
|
|
//@ var str = cat(['file1', 'file2']); // same as above
|
|
//@ ```
|
|
//@
|
|
//@ Returns a [ShellString](#shellstringstr) containing the given file, or a
|
|
//@ concatenated string containing the files if more than one file is given (a
|
|
//@ new line character is introduced between each file).
|
|
function _cat(options, files) {
|
|
var cat = common.readFromPipe();
|
|
|
|
if (!files && !cat) common.error('no paths given');
|
|
|
|
files = [].slice.call(arguments, 1);
|
|
|
|
files.forEach(function (file) {
|
|
if (!fs.existsSync(file)) {
|
|
common.error('no such file or directory: ' + file);
|
|
} else if (common.statFollowLinks(file).isDirectory()) {
|
|
common.error(file + ': Is a directory');
|
|
}
|
|
|
|
cat += fs.readFileSync(file, 'utf8');
|
|
});
|
|
|
|
if (options.number) {
|
|
cat = addNumbers(cat);
|
|
}
|
|
|
|
return cat;
|
|
}
|
|
module.exports = _cat;
|
|
|
|
function addNumbers(cat) {
|
|
var lines = cat.split('\n');
|
|
var lastLine = lines.pop();
|
|
|
|
lines = lines.map(function (line, i) {
|
|
return numberedLine(i + 1, line);
|
|
});
|
|
|
|
if (lastLine.length) {
|
|
lastLine = numberedLine(lines.length + 1, lastLine);
|
|
}
|
|
lines.push(lastLine);
|
|
|
|
return lines.join('\n');
|
|
}
|
|
|
|
function numberedLine(n, line) {
|
|
// GNU cat use six pad start number + tab. See http://lingrok.org/xref/coreutils/src/cat.c#57
|
|
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart
|
|
var number = (' ' + n).slice(-6) + '\t';
|
|
return number + line;
|
|
}
|