util: implement %o as formatting specifier #14558

gla5001 · 2017-07-31T22:50:25Z

Implementing the %o and %O as formatting specifier for util.format.
Based on discussion in issue, this specifier should just call
util.inspect to format passed in value.

Fixes: #14545

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

util

Implementing the %o and %O as formatting specifier for util.format. Based on discussion in issue, this specifier should just call util.inspect to format passed in value. Fixes: nodejs#14545

vsemozhetbyt · 2017-07-31T23:09:58Z

CI: https://ci.nodejs.org/job/node-test-pull-request/9424/

vsemozhetbyt · 2017-08-01T00:34:26Z

One ubuntu1604-arm64 failure in the CI seems unrelated.

@gla5001 Thank you for your contribution!

Trott · 2017-08-01T02:46:14Z

/cc @Fishrock123

jasnell · 2017-08-01T14:46:51Z

This may possibly also need documentation added (I cannot remember how extensively we've documented the formatting specifiers)

gla5001 · 2017-08-01T15:09:16Z

Yup. Overlooked that. I'll update docs

Doc update

silverwind

LGTM, except one nit.

silverwind · 2017-08-01T16:43:37Z

doc/api/util.md

@@ -167,6 +167,9 @@ corresponding argument. Supported placeholders are:
 * `%f` - Floating point value.
 * `%j` - JSON.  Replaced with the string `'[Circular]'` if the argument
 contains circular references.
+* `%o` - Object. A string representation of an object. 
+Similar to `util.inspect()` without options.


Nit: Indent this line

refack · 2017-08-01T17:10:14Z

Is it too late to consider %o to be JSON.stringify(obj, null, ' ') which is just pretty JSON.
I feel like making %o and %O do the same is a missed opportunity...

refack · 2017-08-01T17:11:35Z

Or if there's no consensus let's implement just one, since changing it later will be semver-major

silverwind · 2017-08-01T17:46:25Z

I think it'd make sense to indent %o, it certainly fits the "optimally useful formatting" mentioned in the spec. Maybe with two spaces as that's the most common form of indentation in JS.

gla5001 · 2017-08-01T19:25:25Z

So im happy to implement whatever. Just need a consensus on it.

Keep as is
Remove the %O and just have %o
Change %o to JSON.stringify with 2 spaces

refack · 2017-08-01T19:36:25Z

Quoting #14545 (comment)

`%O`

An object with generic JavaScript object formatting is a potentially expandable representation of a generic JavaScript object.

`%o`

An object with optimally useful formatting is an implementation-specific, potentially-interactive representation of an object judged to be maximally useful and informative.

IMHO
%o - JSON.stringify(obj, null, ' ')
%O - util.inspect(obj)

Fishrock123 · 2017-08-01T19:57:31Z

I don't agree with @refack here. I don't think that JSON-ifying is more detailed, rather it is less, as JSON can't represent everything.

Fishrock123 · 2017-08-01T19:59:25Z

Considering browsers differentiate this by using a util.inspect()-like output with variances that are not possible in Node, I think it backs that up.

Nit fix and changing behavior of %o

gla5001 · 2017-08-01T20:50:03Z

Should they be the same then? By JSON-ifying one and inspecting the other, you now the option of displaying more or less detail. Which could be useful in some cases?

vsemozhetbyt · 2017-08-01T20:53:49Z

doc/api/util.md

@@ -167,6 +167,11 @@ corresponding argument. Supported placeholders are:
 * `%f` - Floating point value.
 * `%j` - JSON.  Replaced with the string `'[Circular]'` if the argument
 contains circular references.
+* `%o` - Object. A string representation of an object 
+  with optimally useful formatting.
+* `%O` - Object. A string representation of an object 


It seems we should state explicitly that JSON stringification is involved here with its restrictions.

@vsemozhetbyt Hows that look?

It seems explicit enough if we do have a consensus for this behavior.

refack · 2017-08-01T22:05:21Z

I don't agree with @refack here. I don't think that JSON-ifying is more detailed, rather it is less, as JSON can't represent everything.

@Fishrock123 So are you suggesting to reverse may suggestion for %O and %o? I'm fine with that, it's more important to me that have get two more representations. Or are you suggesting not to use JSON.stringify at all?

so tl;dr in terms of "human usefulness" %j < %O < %o ?

> const nestedObj = {
...   foo: 'bar',
...   foobar: {
.....     foo: 'bar',
.....     func: function() {}
.....   }
... };

> console.log("%j", nestedObj)
{"foo":"bar","foobar":{"foo":"bar"}}

> console.log(JSON.stringify(nestedObj, null, '  '))
{
  "foo": "bar",
  "foobar": {
    "foo": "bar"
  }
}

> console.log(util.inspect(nestedObj))
{ foo: 'bar', foobar: { foo: 'bar', func: [Function: func] } }

or go big and

> console.log(util.inspect(nestedObj, {showHidden: true, breakLength:10}))
{ foo: 'bar',
  foobar:
   { foo: 'bar',
     func:
      { [Function: func]
        [length]: 0,
        [name]: 'func',
        [prototype]: [Object] } } }

BTW: Chrome 60 has no obvius distinction

Nither does FF 54

refack · 2017-08-01T22:07:48Z

Another idea ( @gla5001 sorry for the noise ), add %J so:
%j - JSON.stringify(obj)
%J - JSON.stringify(obj, null, ' ')
%O - util.inspect(obj)
%o - util.inspect(obj, {showHidden: true, breakLength:10})

tniessen · 2017-08-04T17:36:18Z

Landed in 211df3f! Thank you for your efforts, great first contribution! 🎉

Implementing the %o and %O formatting specifiers for util.format. Based on discussion in issue, this specifier should just call util.inspect to format the value. PR-URL: #14558 Fixes: #14545 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

gla5001 · 2017-08-04T17:37:17Z

awesome. thanks!

tniessen · 2017-08-04T17:46:32Z

Just a few tips for the future:

You might want to configure git to warn you about whitespace problems, e.g. trailing whitespace. We fix those problems when landing your changes, but it can make rebasing more difficult. You can also configure some editors to highlight those problems, and depending on your git interface, you might see such problems highlighted in red when reviewing your changes.
Our commit message guidelines do not apply to fixup commits, so you don't need to repeat the same title throughout all commits within a PR, as long as the first commit has a proper message. While landing PRs, we usually squash your commits, and having the same commit title each time is not helpful. For fixup commits, just describe what you fixed in the commit title. (This does not apply to PRs which consist of multiple independent commits, but most PRs are a single commit and then a lot of fixups.)

We are looking forward to your next contribution!

refack · 2017-08-04T17:56:08Z

@gla5001 congrats on GitHub promoting you from:

to

🍾

refack · 2017-08-04T17:57:42Z

P.S. a nice second contribution might be adding an indent option to util.inspect 😉

gla5001 · 2017-08-04T22:13:53Z

@tniessen Thanks! I'll make sure to take those tips into account next time.

@refack Happy to look at that one next. Is there an issue for it?

refack · 2017-08-04T22:58:57Z

@refack Happy to look at that one next. Is there an issue for it?

No issue just my comment above #14558 (comment)

domenic · 2017-08-04T23:15:53Z

I would not suggest that as a PR, as I doubt it's something the community is interested in (I personally think it's a bad idea). It would need a dedicated issue with discussion and appropriate input from decider-people.

refack · 2017-08-04T23:19:05Z

Well @gla5001 opening an issue and discussing a new feature is also a nice contribution.

gla5001 · 2017-08-05T02:59:47Z

Starting discussion #14638

Implementing the %o and %O formatting specifiers for util.format. Based on discussion in issue, this specifier should just call util.inspect to format the value. PR-URL: #14558 Fixes: #14545 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>

Ref: nodejs#14558

Ref: #14558 PR-URL: #14810 Reviewed-By: Jeremiah Senkpiel <[email protected]>

Notable changes * **Inspector** * `require()` is available in the inspector console now. [#8837](#8837) * **N-API** * New APIs for creating number values have been introduced. [#14573](#14573) * **Stream** * For `Duplex` streams, the high water mark option can now be set independently for the readable and the writable side. [#14636](#14636) * **Util** * `util.format` now supports the `%o` and `%O` specifiers for printing objects. [#14558](#14558) PR-URL: #14811

Notable changes * **HTTP2** * Experimental support for the built-in `http2` has been added via the `--expose-http2` flag. [#14239](#14239) * **Inspector** * `require()` is available in the inspector console now. [#8837](#8837) * Multiple contexts, as created by the `vm` module, are supported now. [#14465](#14465) * **N-API** * New APIs for creating number values have been introduced. [#14573](#14573) * **Stream** * For `Duplex` streams, the high water mark option can now be set independently for the readable and the writable side. [#14636](#14636) * **Util** * `util.format` now supports the `%o` and `%O` specifiers for printing objects. [#14558](#14558) PR-URL: #14811

Notable changes * **HTTP2** * Experimental support for the built-in `http2` has been added via the `--expose-http2` flag. [#14239](nodejs/node#14239) * **Inspector** * `require()` is available in the inspector console now. [#8837](nodejs/node#8837) * Multiple contexts, as created by the `vm` module, are supported now. [#14465](nodejs/node#14465) * **N-API** * New APIs for creating number values have been introduced. [#14573](nodejs/node#14573) * **Stream** * For `Duplex` streams, the high water mark option can now be set independently for the readable and the writable side. [#14636](nodejs/node#14636) * **Util** * `util.format` now supports the `%o` and `%O` specifiers for printing objects. [#14558](nodejs/node#14558) PR-URL: nodejs/node#14811

gibfahn · 2018-01-15T22:12:32Z

Release team were +1 on backporting to v6.x.

util: implement %o as formatting specifier

2dc1ba6

Implementing the %o and %O as formatting specifier for util.format. Based on discussion in issue, this specifier should just call util.inspect to format passed in value. Fixes: nodejs#14545

nodejs-github-bot added the util Issues and PRs related to the built-in util module. label Jul 31, 2017

vsemozhetbyt approved these changes Jul 31, 2017

View reviewed changes

cjihrig approved these changes Aug 1, 2017

View reviewed changes

TimothyGu approved these changes Aug 1, 2017

View reviewed changes

tniessen approved these changes Aug 1, 2017

View reviewed changes

tniessen self-assigned this Aug 1, 2017

jasnell approved these changes Aug 1, 2017

View reviewed changes

util: implement %o as formatting specifier

c0826e7

Doc update

silverwind approved these changes Aug 1, 2017

View reviewed changes

silverwind added the semver-minor PRs that contain new features and should be released in the next minor version. label Aug 1, 2017

hiroppy approved these changes Aug 1, 2017

View reviewed changes

util: implement %o as formatting specifier.

0b373b4

Nit fix and changing behavior of %o

vsemozhetbyt reviewed Aug 1, 2017

View reviewed changes

util: implement %o as formatting specifier. doc fix

436765e

tniessen closed this Aug 4, 2017

gla5001 mentioned this pull request Aug 5, 2017

Add indent option to util.inspect? #14638

Closed

addaleax added a commit to addaleax/node that referenced this pull request Aug 13, 2017

doc: add missing changes: metadata for util

1590ff3

Ref: nodejs#14558

addaleax mentioned this pull request Aug 13, 2017

doc: add missing changes: metadata for recent PRs #14810

Closed

addaleax added a commit that referenced this pull request Aug 13, 2017

doc: add missing changes: metadata for util

314217f

Ref: #14558 PR-URL: #14810 Reviewed-By: Jeremiah Senkpiel <[email protected]>

addaleax added a commit that referenced this pull request Aug 13, 2017

doc: add missing changes: metadata for util

9e51802

Ref: #14558 PR-URL: #14810 Reviewed-By: Jeremiah Senkpiel <[email protected]>

addaleax mentioned this pull request Aug 13, 2017

v8.4.0 proposal #14811

Merged

pvdlg mentioned this pull request Oct 30, 2017

fix: Update npx command line semantic-release/semantic-release#496

Closed

gibfahn added the lts-watch-v6.x label Jan 15, 2018

wltsmrz mentioned this pull request Apr 24, 2020

Add %J console format specifier #33036

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: implement %o as formatting specifier #14558

util: implement %o as formatting specifier #14558

gla5001 commented Jul 31, 2017

vsemozhetbyt commented Jul 31, 2017

vsemozhetbyt commented Aug 1, 2017

Trott commented Aug 1, 2017

jasnell commented Aug 1, 2017

gla5001 commented Aug 1, 2017

silverwind left a comment

silverwind Aug 1, 2017

refack commented Aug 1, 2017

refack commented Aug 1, 2017

silverwind commented Aug 1, 2017 •

edited

Loading

gla5001 commented Aug 1, 2017

refack commented Aug 1, 2017

Fishrock123 commented Aug 1, 2017 •

edited

Loading

Fishrock123 commented Aug 1, 2017 •

edited

Loading

gla5001 commented Aug 1, 2017

vsemozhetbyt Aug 1, 2017

gla5001 Aug 1, 2017

vsemozhetbyt Aug 1, 2017

refack commented Aug 1, 2017

refack commented Aug 1, 2017 •

edited

Loading

tniessen commented Aug 4, 2017

gla5001 commented Aug 4, 2017

tniessen commented Aug 4, 2017

refack commented Aug 4, 2017

refack commented Aug 4, 2017 •

edited

Loading

gla5001 commented Aug 4, 2017

refack commented Aug 4, 2017

domenic commented Aug 4, 2017

refack commented Aug 4, 2017

gla5001 commented Aug 5, 2017

gibfahn commented Jan 15, 2018

util: implement %o as formatting specifier #14558

util: implement %o as formatting specifier #14558

Conversation

gla5001 commented Jul 31, 2017

Checklist

Affected core subsystem(s)

vsemozhetbyt commented Jul 31, 2017

vsemozhetbyt commented Aug 1, 2017

Trott commented Aug 1, 2017

jasnell commented Aug 1, 2017

gla5001 commented Aug 1, 2017

silverwind left a comment

Choose a reason for hiding this comment

silverwind Aug 1, 2017

Choose a reason for hiding this comment

refack commented Aug 1, 2017

refack commented Aug 1, 2017

silverwind commented Aug 1, 2017 • edited Loading

gla5001 commented Aug 1, 2017

refack commented Aug 1, 2017

%O

%o

Fishrock123 commented Aug 1, 2017 • edited Loading

Fishrock123 commented Aug 1, 2017 • edited Loading

gla5001 commented Aug 1, 2017

vsemozhetbyt Aug 1, 2017

Choose a reason for hiding this comment

gla5001 Aug 1, 2017

Choose a reason for hiding this comment

vsemozhetbyt Aug 1, 2017

Choose a reason for hiding this comment

refack commented Aug 1, 2017

refack commented Aug 1, 2017 • edited Loading

tniessen commented Aug 4, 2017

gla5001 commented Aug 4, 2017

tniessen commented Aug 4, 2017

refack commented Aug 4, 2017

refack commented Aug 4, 2017 • edited Loading

gla5001 commented Aug 4, 2017

refack commented Aug 4, 2017

domenic commented Aug 4, 2017

refack commented Aug 4, 2017

gla5001 commented Aug 5, 2017

gibfahn commented Jan 15, 2018

silverwind commented Aug 1, 2017 •

edited

Loading

`%O`

`%o`

Fishrock123 commented Aug 1, 2017 •

edited

Loading

Fishrock123 commented Aug 1, 2017 •

edited

Loading

refack commented Aug 1, 2017 •

edited

Loading

refack commented Aug 4, 2017 •

edited

Loading