util.inspect multiline output length limit should be configurable #7305

Activity

1. mscdex

   added

   utilIssues and PRs related to the built-in util module.Issues and PRs related to the built-in util module.

   feature requestIssues requesting new Node.js features.Issues requesting new Node.js features.

   on Jun 15, 2016
2. Trott commented on Jun 15, 2016

   

   Trott

   on Jun 15, 2016

   Member

   More actions

   It would be great to see a PR that adds a property to the options object that allows the user to configure the maximum length, perhaps allowing a setting of 0 to disable the limit.
3. cjihrig

   added a commit that references this issue on Jul 5, 2016

   util: add an option for configuring break length

   ...

   a2ee21d
4. cjihrig

   closed this as completedin #7499on Jul 5, 2016
5. Fishrock123

   added a commit that references this issue on Jul 6, 2016

   util: add an option for configuring break length

   ...

   3b8914d
6. whitneyland commented on Mar 4, 2017

   

   whitneyland

   on Mar 4, 2017

   Last edited by whitneyland

   More actions

   By setting breakLength to 1, shouldn't this create multiple lines in the output? I'm getting a single line string like this:
   { color: 'black', 'font-size': '12px', 'font-weight': 'bold' }

   util.inspect(
   {
       "color": "black", 
       "font-size": "12px", 
       "font-weight": "bold"},
   {
       "showHidden" : false,
       "depth" : 4,
       "showProxy" : false,
       "maxArrayLength" : 10,
       "breakLength" : 1,
   })
   
   
7. BridgeAR commented on Dec 28, 2017

   

   BridgeAR

   on Dec 28, 2017

   Member

   More actions

   @whitneyland I get the following output '{ color: \'black\',\n \'font-size\': \'12px\',\n \'font-weight\': \'bold\' }'. This is correct as the output will only break for each element.

   If the documentation is not clear enough about this, could you please open a issue for this?
8. windmaomao commented on Dec 20, 2020

   

   windmaomao

   on Dec 20, 2020

   More actions

   Setting breakLength to 1 is working, but not for any number more than 80 including Infinity. This can be confirmed if you use console.dir, which will print out all the \n.
9. BridgeAR commented on Dec 21, 2020

   

   BridgeAR

   on Dec 21, 2020

   Member

   More actions

   @windmaomao I just checked and it does work properly for me. Do you have a concrete example that does not work as expected? And what Node.js version do you use?
10. windmaomao commented on Dec 21, 2020

    

    windmaomao

    on Dec 21, 2020

    More actions

    @BridgeAR the node version is 14.15.3, but i have tried with couple of different version as well, so it's pretty consistent.

    Here's how to reproduce it, if you use the following code and then try to set breakLength to 1, it'll make the array to display as a column, however if you change this number to anything else, I always get a break after 5 items.

    const util = require('util')
    
    const settings = {
    //	showHidden: false, 
    	depth: null,
    	colors: true,
    	maxArrayLength: Infinity,
    //	maxStringLength: Infinity,
    	breakLength: 1,
    //	compact: false
    }
    
    util.inspect.defaultOptions = {
    	...util.inspect.defaultOptions,
    	...settings
    }
    
    const log = (s, options = {}) => { 
    	console.log(util.inspect(s, options))
    }
    
    module.exports = log
    
    log([1,2,3,4,5,6,7])
    
11. BridgeAR commented on Dec 21, 2020

    

    BridgeAR

    on Dec 21, 2020

    Member

    More actions

    If I understood correct, you prefer to deactivate the array grouping functionality. It's possible to set compact = true or compact = 0. It'll stop the grouping functionality but it'll also change a few other formatting aspects.