Skip to content

console: add color support #19372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
addaleax wants to merge 5 commits into from
Closed

console: add color support #19372

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
75cc568
util: introduce `formatWithOptions()`
addaleax Mar 15, 2018
565d8c3
doc: document `Console(…, ignoreErrors)` option
addaleax Mar 15, 2018
ec7741f
console: allow `options` object as constructor arg
addaleax Mar 17, 2018
313f29c
console: add color support
addaleax Mar 15, 2018
0e52d4b
console: auto-detect color support by default
addaleax Mar 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
util: introduce formatWithOptions() 
Identical to `format()` except that it takes an options argument
that is passed through to `inspect()`.
  • Loading branch information
@addaleax
addaleax committed Apr 12, 2018
commit 75cc568db76314839388a739a0a5ddacd3a1f45e
19 changes: 19 additions & 0 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,24 @@ intended as a debugging tool. Some input values can have a significant
performance overhead that can block the event loop. Use this function
with care and never in a hot code path.

## util.formatWithOptions(inspectOptions, format[, ...args])
<!-- YAML
added: REPLACEME
-->

Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Apr 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is worth to just mention the parameter types:

* `inspectOptions` {Object}
* `format` {string}

* `inspectOptions` {Object}
* `format` {string}

This function is identical to [`util.format()`][], except in that it takes
an `inspectOptions` argument which specifies options that are passed along to
[`util.inspect()`][].

```js
util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 });
// Returns 'See object { foo: 42 }', where `42` is colored as a number
// when printed to a terminal.
```

## util.getSystemErrorName(err)
<!-- YAML
added: v9.7.0
Expand Down Expand Up @@ -2054,6 +2072,7 @@ Deprecated predecessor of `console.log`.
[`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer
[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
[`util.format()`]: #util_util_format_format_args
[`util.inspect()`]: #util_util_inspect_object_options
[`util.promisify()`]: #util_util_promisify_original
[`util.types.isAnyArrayBuffer()`]: #util_util_types_isanyarraybuffer_value
Expand Down
33 changes: 22 additions & 11 deletions lib/util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,23 +173,28 @@ function tryStringify(arg) {
}
}

function format(f) {
const emptyOptions = {};
function format(...args) {
return formatWithOptions(emptyOptions, ...args);
}

function formatWithOptions(inspectOptions, f) {
let i, tempStr;
if (typeof f !== 'string') {
if (arguments.length === 0) return '';
if (arguments.length === 1) return '';
let res = '';
for (i = 0; i < arguments.length - 1; i++) {
res += inspect(arguments[i]);
for (i = 1; i < arguments.length - 1; i++) {
res += inspect(arguments[i], inspectOptions);
res += ' ';
}
res += inspect(arguments[i]);
res += inspect(arguments[i], inspectOptions);
return res;
}

if (arguments.length === 1) return f;
if (arguments.length === 2) return f;

let str = '';
let a = 1;
let a = 2;
let lastPos = 0;
for (i = 0; i < f.length - 1; i++) {
if (f.charCodeAt(i) === 37) { // '%'
Expand All @@ -206,12 +211,17 @@ function format(f) {
tempStr = `${Number(arguments[a++])}`;
break;
case 79: // 'O'
tempStr = inspect(arguments[a++]);
tempStr = inspect(arguments[a++], inspectOptions);
break;
case 111: // 'o'
tempStr = inspect(arguments[a++],
{ showHidden: true, showProxy: true });
{
const opts = Object.assign({}, inspectOptions, {
Copy link
Copy Markdown
Member

@lpinca lpinca Mar 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: how about

const opts = Object.assign({
  showHidden: true,
  showProxy: true
}, inspectOptions);

Feel free to ignore.

Copy link
Copy Markdown
Member Author

@addaleax addaleax Mar 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lpinca This is kind of intentional … we document that the %o specifier works this way, so I wouldn’t expect per-call options to override it

Copy link
Copy Markdown
Member

@lpinca lpinca Mar 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what case would it be overridden? It's still a new copy per call no?

Copy link
Copy Markdown
Member Author

@addaleax addaleax Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lpinca I meant, if inspectOptions happens to contains showProxy: false, then that would override the behaviour of %o with your suggestion, whereas right now the behaviour of %o is left untouched.

If you do think that that is the right thing to do, then I’m okay with that; I’d prefer to keep this as it is currently documented, though.

Copy link
Copy Markdown
Member

@lpinca lpinca Mar 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right, ignore my comment.

showHidden: true,
showProxy: true
});
tempStr = inspect(arguments[a++], opts);
break;
}
case 105: // 'i'
tempStr = `${parseInt(arguments[a++])}`;
break;
Expand Down Expand Up @@ -244,7 +254,7 @@ function format(f) {
if ((typeof x !== 'object' && typeof x !== 'symbol') || x === null) {
str += ` ${x}`;
} else {
str += ` ${inspect(x)}`;
str += ` ${inspect(x, inspectOptions)}`;
}
}
return str;
Expand Down Expand Up @@ -1206,6 +1216,7 @@ module.exports = exports = {
debuglog,
deprecate,
format,
formatWithOptions,
getSystemErrorName,
inherits,
inspect,
Expand Down