util: support BigInt in util.format #22097

shisama · 2018-08-03T00:48:42Z

Adding support for BigInt in util.format and console.log.
Placeholder %d is replaced as Number when BigInt is set in
second argument.
Now, util.format('%d', 1180591620717411303424n) returns
'1.1805916207174113e+21'.
However, expected result is '1180591620717411303424'.

Checklist

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

devsnek

bigint is a distinct type from number and i don't think we should mix them up. perhaps there is another letter we can use? also any output of a bigint should include the n suffix

ghost

Your codes cannot pass eslint check because over 80-character each line. You have to step up to a new line, something like this format in your test file.

assert.strictEqual(util.format('%d', 1180591620717411303424),
                   '1.1805916207174113e+21');
assert.strictEqual(util.format('%d', 1180591620717411303424n),
                   '1180591620717411303424');

shisama · 2018-08-03T01:26:59Z

@devsnek Thanks.

perhaps there is another letter we can use?

OK, but I have no idea what the letter should be. So, Please help me if you have any ideas.
cc @nodejs/util

also any output of a bigint should include the n suffix

I agree with you. I'll fix it.

shisama · 2018-08-03T01:27:45Z

@Maledong Thanks. I fixed it.

hiroppy · 2018-08-03T04:46:08Z

/cc @nodejs/util

joyeecheung · 2018-08-03T11:53:50Z

doc/api/util.md

@@ -198,7 +198,7 @@ Each placeholder token is replaced with the converted value from the
 corresponding argument. Supported placeholders are:

 * `%s` - `String`.
-* `%d` - `Number` (integer or floating point value).
+* `%d` - `Number` (integer or floating point value) or `BigInt`.


If anything, shouldn't %i be more suitable for BigInt, considering it's an integer?

silverwind · 2018-08-04T10:52:41Z

Before we jump to an implementation, I'd suggest first discussing it at whatwg/console. The spec says that %d and %i use parseInt for the type conversion. We are already violating this spec on %d by using Number, by the way.

shisama · 2018-08-05T16:06:54Z

@joyeecheung @silverwind Thank you for your comments. I think It's better to discuss before implementing this on Node.js. I created the issue in whatwg/console. whatwg/console#148

silverwind · 2018-08-09T16:45:15Z

edit: see whatwg/console#148 (comment)

Adding support for BigInt in util.format and console.log. Placeholder `%d` is replaced as Number when BigInt is set in second argument. Now, `util.format('%d', 1180591620717411303424n)` returns `'1.1805916207174113e+21'`. However, expected result is `'1180591620717411303424'`.

silverwind · 2018-09-17T17:54:59Z

Current implementation looks good to me, but please update the docs and maybe add a few more test cases with more than one specifier.

Not totally happy with the change to include the n suffix, but I see it's in line with what Chrome does.

shisama · 2018-09-18T07:15:52Z

@silverwind Thank you for your comments. I updated document util.md and add tests with two specifiers.

silverwind

LGTM, but would like to wait with landing a few more days in case there's any movement on whatwg/console#148.

silverwind · 2018-09-27T18:24:13Z

@devsnek does your red cross still stand? I'd like to merge this.

shisama · 2018-10-08T11:53:23Z

@devsnek Please review again. If you request changes still, please tell me what they are.

stale

silverwind · 2018-10-09T18:12:30Z

Thanks. Landed in d71dd97.

`util.format` and `console.log` now support BigInt via the existing format specifiers `%i` and `%d`. PR-URL: #22097 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: * assert * The diff output is now a tiny bit improved by sorting object properties when inspecting the values that are compared with each other. #22788 * cli * The options parser now normalizes `_` to `-` in all multi-word command-line flags, e.g. `--no_warnings` has the same effect as `--no-warnings`. #23020 * Added bash completion for the `node` binary. To generate a bash completion script, run `node --completion-bash`. The output can be saved to a file which can be sourced to enable completion. #20713 * crypto * Added support for PEM-level encryption. #23151 * Added an API asymmetric key pair generation. The new methods `crypto.generateKeyPair` and `crypto.generateKeyPairSync` can be used to generate public and private key pairs. The API supports RSA, DSA and EC and a variety of key encodings (both PEM and DER). #22660 * fs * Added a `recursive` option to `fs.mkdir` and `fs.mkdirSync`. If this option is set to true, non-existing parent folders will be automatically created. #21875 * http2 * Added a `'ping'` event to `Http2Session` that is emitted whenever a non-ack `PING` is received. #23009 * Added support for the `ORIGIN` frame. #22956 * Updated nghttp2 to 1.34.0. This adds RFC 8441 extended connect protocol support to allow use of WebSockets over HTTP/2. #23284 * module * Added `module.createRequireFromPath(filename)`. This new method can be used to create a custom require function that will resolve modules relative to the filename path. #19360 * process * Added a `'multipleResolves'` process event that is emitted whenever a `Promise` is attempted to be resolved multiple times, e.g. if the `resolve` and `reject` functions are both called in a `Promise` executor. #22218 * url * Added `url.fileURLToPath(url)` and `url.pathToFileURL(path)`. These methods can be used to correctly convert between file: URLs and absolute paths. #22506 * util * Added the `sorted` option to `util.inspect()`. If set to `true`, all properties of an object and Set and Map entries will be sorted in the returned string. If set to a function, it is used as a compare function. #22788 * The `util.instpect.custom` symbol is now defined in the global symbol registry as `Symbol.for('nodejs.util.inspect.custom')`. #20857 * Added support for `BigInt` numbers in `util.format()`. #22097 * V8 API * A number of V8 C++ APIs have been marked as deprecated since they have been removed in the upstream repository. Replacement APIs are added where necessary. #23159 * Windows * The Windows msi installer now provides an option to automatically install the tools required to build native modules. #22645 * Workers * Debugging support for Workers using the DevTools protocol has been implemented. #21364 * The public `inspector` module is now enabled in Workers. #22769 * Added new collaborators: * digitalinfinity - Hitesh Kanwathirtha PR-URL: #23313

`util.format` and `console.log` now support BigInt via the existing format specifiers `%i` and `%d`. PR-URL: #22097 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: * assert * The diff output is now a tiny bit improved by sorting object properties when inspecting the values that are compared with each other. #22788 * cli * The options parser now normalizes `_` to `-` in all multi-word command-line flags, e.g. `--no_warnings` has the same effect as `--no-warnings`. #23020 * Added bash completion for the `node` binary. To generate a bash completion script, run `node --completion-bash`. The output can be saved to a file which can be sourced to enable completion. #20713 * crypto * Added support for PEM-level encryption. #23151 * Added an API asymmetric key pair generation. The new methods `crypto.generateKeyPair` and `crypto.generateKeyPairSync` can be used to generate public and private key pairs. The API supports RSA, DSA and EC and a variety of key encodings (both PEM and DER). #22660 * fs * Added a `recursive` option to `fs.mkdir` and `fs.mkdirSync`. If this option is set to true, non-existing parent folders will be automatically created. #21875 * http2 * Added a `'ping'` event to `Http2Session` that is emitted whenever a non-ack `PING` is received. #23009 * Added support for the `ORIGIN` frame. #22956 * Updated nghttp2 to 1.34.0. This adds RFC 8441 extended connect protocol support to allow use of WebSockets over HTTP/2. #23284 * module * Added `module.createRequireFromPath(filename)`. This new method can be used to create a custom require function that will resolve modules relative to the filename path. #19360 * process * Added a `'multipleResolves'` process event that is emitted whenever a `Promise` is attempted to be resolved multiple times, e.g. if the `resolve` and `reject` functions are both called in a `Promise` executor. #22218 * url * Added `url.fileURLToPath(url)` and `url.pathToFileURL(path)`. These methods can be used to correctly convert between file: URLs and absolute paths. #22506 * util * Added the `sorted` option to `util.inspect()`. If set to `true`, all properties of an object and Set and Map entries will be sorted in the returned string. If set to a function, it is used as a compare function. #22788 * The `util.instpect.custom` symbol is now defined in the global symbol registry as `Symbol.for('nodejs.util.inspect.custom')`. #20857 * Added support for `BigInt` numbers in `util.format()`. #22097 * V8 API * A number of V8 C++ APIs have been marked as deprecated since they have been removed in the upstream repository. Replacement APIs are added where necessary. #23159 * Windows * The Windows msi installer now provides an option to automatically install the tools required to build native modules. #22645 * Workers * Debugging support for Workers using the DevTools protocol has been implemented. #21364 * The public `inspector` module is now enabled in Workers. #22769 * Added new collaborators: * digitalinfinity - Hitesh Kanwathirtha PR-URL: #23313

nodejs-github-bot added the util Issues and PRs related to the built-in util module. label Aug 3, 2018

devsnek previously requested changes Aug 3, 2018

View reviewed changes

shisama changed the title ~~util: support BigInt in util.format~~ [wip]util: support BigInt in util.format Aug 3, 2018

ghost reviewed Aug 3, 2018

View reviewed changes

shisama force-pushed the util-format-bigint branch from 28e49cd to 5dc83f4 Compare August 3, 2018 01:12

shisama changed the title ~~[wip]util: support BigInt in util.format~~ util: support BigInt in util.format Aug 3, 2018

joyeecheung reviewed Aug 3, 2018

View reviewed changes

BridgeAR added the blocked PRs that are blocked by other issues or PRs. label Sep 5, 2018

shisama force-pushed the util-format-bigint branch from 2087b0b to 08f67c4 Compare September 16, 2018 15:10

util: %i supports BigInt

932002c

Masashi Hirano added 2 commits September 18, 2018 12:42

util: update util.md that supports BigInt

097ba59

util: add tests to check multiple %d/%i specifiers for BigInt

946fdec

silverwind approved these changes Sep 18, 2018

View reviewed changes

jasnell approved these changes Sep 19, 2018

View reviewed changes

silverwind added semver-minor PRs that contain new features and should be released in the next minor version. and removed blocked PRs that are blocked by other issues or PRs. labels Oct 9, 2018

silverwind closed this Oct 9, 2018

targos mentioned this pull request Oct 10, 2018

Release proposal: v10.12.0 #23313

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: support BigInt in util.format #22097

util: support BigInt in util.format #22097

shisama commented Aug 3, 2018 •

edited

Loading

devsnek left a comment •

edited

Loading

ghost left a comment •

edited by ghost

Loading

shisama commented Aug 3, 2018 •

edited

Loading

shisama commented Aug 3, 2018

hiroppy commented Aug 3, 2018

joyeecheung Aug 3, 2018

silverwind commented Aug 4, 2018

shisama commented Aug 5, 2018 •

edited

Loading

silverwind commented Aug 9, 2018 •

edited

Loading

silverwind commented Sep 17, 2018

shisama commented Sep 18, 2018

silverwind left a comment

silverwind commented Sep 27, 2018

shisama commented Oct 8, 2018

silverwind commented Oct 9, 2018

util: support BigInt in util.format #22097

util: support BigInt in util.format #22097

Conversation

shisama commented Aug 3, 2018 • edited Loading

Checklist

devsnek left a comment • edited Loading

Choose a reason for hiding this comment

ghost left a comment • edited by ghost Loading

Choose a reason for hiding this comment

shisama commented Aug 3, 2018 • edited Loading

shisama commented Aug 3, 2018

hiroppy commented Aug 3, 2018

joyeecheung Aug 3, 2018

Choose a reason for hiding this comment

silverwind commented Aug 4, 2018

shisama commented Aug 5, 2018 • edited Loading

silverwind commented Aug 9, 2018 • edited Loading

silverwind commented Sep 17, 2018

shisama commented Sep 18, 2018

silverwind left a comment

Choose a reason for hiding this comment

silverwind commented Sep 27, 2018

shisama commented Oct 8, 2018

silverwind commented Oct 9, 2018

shisama commented Aug 3, 2018 •

edited

Loading

devsnek left a comment •

edited

Loading

ghost left a comment •

edited by ghost

Loading

shisama commented Aug 3, 2018 •

edited

Loading

shisama commented Aug 5, 2018 •

edited

Loading

silverwind commented Aug 9, 2018 •

edited

Loading