util: add an option for configuring break length #7499

cjihrig · 2016-06-30T16:08:03Z

Checklist

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

Affected core subsystem(s)

util

Description of change

This commit adds a breakLength option to util.inspect(). This option allows users to control the length at which object keys are split across multiple lines. For backwards compatibility, this option defaults to 60.

Fixes: #7305

evanlucas · 2016-06-30T16:57:21Z

LGTM if CI is happy

jasnell · 2016-06-30T17:18:49Z

lib/util.js

@@ -194,6 +194,7 @@ function inspect(obj, opts) {
  if (ctx.colors) ctx.stylize = stylizeWithColor;
  if (ctx.maxArrayLength === undefined) ctx.maxArrayLength = kDefaultMaxLength;
  if (ctx.maxArrayLength === null) ctx.maxArrayLength = Infinity;
+  if (ctx.breakLength === undefined) ctx.breakLength = 60;


what about setting to null or Infinity... what affect would that need to have? Just thinking about consistency with other options

I picked 60 to maintain backwards compatibility. I could assign it to null or Infinity and then change the value later, but it seems like that would only complicate things.

I think 60 is fine, but if set to null or Infinity explicitly we should figure out what the behavior should be.

Infinity is documented to make the object print on a single line with no breaks. null, or any value for that matter, will be plugged in for breakLength in the length > breakLength comparison.

jasnell · 2016-06-30T17:19:05Z

LGTM with a nit

Fishrock123 · 2016-07-01T09:02:29Z

seems fine to me

cjihrig · 2016-07-01T12:46:34Z

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

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

This commit adds a breakLength option to util.inspect(). This option allows users to control the length at which object keys are split across multiple lines. For backwards compatibility, this option defaults to 60. Fixes: nodejs#7305 PR-URL: nodejs#7499 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>

This commit adds a breakLength option to util.inspect(). This option allows users to control the length at which object keys are split across multiple lines. For backwards compatibility, this option defaults to 60. Fixes: #7305 PR-URL: #7499 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>

Notable changes: * buffer: Added `buffer.swap64()` to compliment `swap16()` & `swap32()`. (Zach Bjornson) #7157 * build: New `configure` options have been added for building Node.js as a shared library. (Stefan Budeanu) #6994 - The options are: `--shared`, `--without-v8-platform` & `--without-bundled-v8`. * crypto: Root certificates have been updated. (Ben Noordhuis) #7363 * debugger: The server address is now configurable via `--debug=<address>:<port>`. (Ben Noordhuis) #3316 * npm: Upgraded npm to v3.10.3 (Kat Marchán) #7515 & (Rebecca Turner) #7410 * readline: Added the `prompt` option to the readline constructor. (Evan Lucas) #7125 * repl / vm: `sigint`/`ctrl+c` will now break out of infinite loops without stopping the Node.js instance. (Anna Henningsen) #6635 * src: - Added a `node::FreeEnvironment` public C++ API. (Cheng Zhao) #3098 - Refactored `require('constants')`, constants are now available directly from their respective modules. (James M Snell) #6534 * stream: Improved `readable.read()` performance by up to 70%. (Brian White) #7077 * timers: `setImmediate()` is now up to 150% faster in some situations. (Andras) #6436 * util: Added a `breakLength` option to `util.inspect()` to control how objects are formatted across lines. (cjihrig) #7499 * v8-inspector: Experimental support has been added for debugging Node.js over the inspector protocol. (Ali Ijaz Sheikh) #6792 - *Note: This feature is experimental, and it could be altered or removed.* - You can try this feature by running Node.js with the `--inspect` flag. Refs: #7441 PR-URL: #7550

### Notable changes * **buffer**: Added `buffer.swap64()` to compliment `swap16()` & `swap32()`. (Zach Bjornson) [#7157](nodejs/node#7157) * **build**: New `configure` options have been added for building Node.js as a shared library. (Stefan Budeanu) [#6994](nodejs/node#6994) - The options are: `--shared`, `--without-v8-platform` & `--without-bundled-v8`. * **crypto**: Root certificates have been updated. (Ben Noordhuis) [#7363](nodejs/node#7363) * **debugger**: The server address is now configurable via `--debug=<address>:<port>`. (Ben Noordhuis) [#3316](nodejs/node#3316) * **npm**: Upgraded npm to v3.10.3 (Kat Marchán) [#7515](nodejs/node#7515) & (Rebecca Turner) [#7410](nodejs/node#7410) * **readline**: Added the `prompt` option to the readline constructor. (Evan Lucas) [#7125](nodejs/node#7125) * **repl / vm**: `sigint`/`ctrl+c` will now break out of infinite loops without stopping the Node.js instance. (Anna Henningsen) [#6635](nodejs/node#6635) * **src**: - Added a `node::FreeEnvironment` public C++ API. (Cheng Zhao) [#3098](nodejs/node#3098) - Refactored `require('constants')`, constants are now available directly from their respective modules. (James M Snell) [#6534](nodejs/node#6534) * **stream**: Improved `readable.read()` performance by up to 70%. (Brian White) [#7077](nodejs/node#7077) * **timers**: `setImmediate()` is now up to 150% faster in some situations. (Andras) [#6436](nodejs/node#6436) * **util**: Added a `breakLength` option to `util.inspect()` to control how objects are formatted across lines. (cjihrig) [#7499](nodejs/node#7499) * **v8-inspector**: Experimental support has been added for debugging Node.js over the inspector protocol. (Ali Ijaz Sheikh) [#6792](nodejs/node#6792) - **Note: This feature is _experimental_, and it could be altered or removed.** - You can try this feature by running Node.js with the `--inspect` flag.

mscdex added the util Issues and PRs related to the built-in util module. label Jun 30, 2016

evanlucas added the semver-minor PRs that contain new features and should be released in the next minor version. label Jun 30, 2016

jasnell reviewed Jun 30, 2016
View reviewed changes

cjihrig force-pushed the 7305 branch from fa1d6ba to a2ee21d Compare July 5, 2016 14:19

cjihrig merged commit a2ee21d into nodejs:master Jul 5, 2016

cjihrig deleted the 7305 branch July 5, 2016 14:52

Fishrock123 mentioned this pull request Jul 6, 2016

Propose v6.3.0 (v2) #7550

Merged

chrjean mentioned this pull request Jul 7, 2016

Update nodejs to 6.3.0 ScoopInstaller/Scoop#948

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

util: add an option for configuring break length #7499

util: add an option for configuring break length #7499

cjihrig commented Jun 30, 2016

evanlucas commented Jun 30, 2016

jasnell Jun 30, 2016

cjihrig Jun 30, 2016

jasnell Jun 30, 2016

cjihrig Jun 30, 2016

jasnell commented Jun 30, 2016

Fishrock123 commented Jul 1, 2016

cjihrig commented Jul 1, 2016 •

edited

Loading

util: add an option for configuring break length #7499

util: add an option for configuring break length #7499

Conversation

cjihrig commented Jun 30, 2016

Checklist

Affected core subsystem(s)

Description of change

evanlucas commented Jun 30, 2016

jasnell Jun 30, 2016

Choose a reason for hiding this comment

cjihrig Jun 30, 2016

Choose a reason for hiding this comment

jasnell Jun 30, 2016

Choose a reason for hiding this comment

cjihrig Jun 30, 2016

Choose a reason for hiding this comment

jasnell commented Jun 30, 2016

Fishrock123 commented Jul 1, 2016

cjihrig commented Jul 1, 2016 • edited Loading

cjihrig commented Jul 1, 2016 •

edited

Loading