-
Notifications
You must be signed in to change notification settings - Fork 30.6k
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.
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
util: add an option for configuring break length #7499
Conversation
LGTM if CI is happy |
@@ -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; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about setting to null
or Infinity
... what affect would that need to have? Just thinking about consistency with other options
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think 60
is fine, but if set to null
or Infinity
explicitly we should figure out what the behavior should be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
LGTM with a nit |
seems fine to me |
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>
Checklist
make -j4 test
(UNIX), orvcbuild test nosign
(Windows) passesAffected core subsystem(s)
util
Description of change
This commit adds a
breakLength
option toutil.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