Skip to content

More realistic custom inspect example #8875

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
Havvy wants to merge 2 commits into from
Closed

More realistic custom inspect example #8875

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc57bc8
docs: more realistic custom inspect example
Havvy Oct 1, 2016
ad9ef92
use " ".repeat in custom util.inspect example
Havvy Oct 2, 2016
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
Prev Previous commit
use " ".repeat in custom util.inspect example
  • Loading branch information
@Havvy
Havvy committed Oct 2, 2016
commit ad9ef926e46336ba5aed887067e1a5724899e379
2 changes: 1 addition & 1 deletion doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ class Box {
});

// Five space padding because that's the size of "Box< ".
const padding = ' ';
const padding = ' '.repeat(5);
const inner = util.inspect(this.value, newOptions).replace(/\n/g, '\n' + padding);
Copy link
Copy Markdown
Member

@jasnell jasnell Oct 6, 2016

Choose a reason for hiding this comment

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

And a comment here about what this call to util.inspect is for.

Copy link
Copy Markdown
Contributor Author

@Havvy Havvy Oct 8, 2016

Choose a reason for hiding this comment

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

Will do when I have time and energy.

return options.stylize('Box', 'special') + '< ' + inner + ' >';
Copy link
Copy Markdown
Member

@jasnell jasnell Oct 6, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

I know I already signed off on this but, just as a very minor nit, this could be slightly simplified to:

return `${options.stylize('Box', 'special')}<${inner}>`;

Copy link
Copy Markdown
Member

@addaleax addaleax Oct 6, 2016

Choose a reason for hiding this comment

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

I am not sure I’d find that more readable… long expressions inside ${} are a bit weird imho.

So, maybe options.stylize('Box', 'special') + < ${inner} >;?

Copy link
Copy Markdown
Contributor Author

@Havvy Havvy Oct 8, 2016

Choose a reason for hiding this comment

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

Do we really want to mix quasiquoting and string concatenation together?

Seems like any option we go with (other than just string concatenation IMO) looks weird.

}
Expand Down