feat: log method support depth option

lib/handlebars/helpers/log.js

@@ -14,6 +14,17 @@ export default function (instance) {
     }
     args[0] = level;
 
+    // Only add depth to args if it's explicitly provided
+    let depth;
+    if (options.hash.depth != null) {
+      depth = options.hash.depth;
+    } else if (options.data && options.data.depth != null) {
+      depth = options.data.depth;
+    }
+    if (depth != null) {
+      args.splice(1, 0, depth);
+    }
+
     instance.log(...args);
   });
 }

lib/handlebars/logger.js

@@ -3,6 +3,7 @@ import { indexOf } from './utils';
 let logger = {
   methodMap: ['debug', 'info', 'warn', 'error'],
   level: 'info',
+  depth: 2,
 
   // Maps a given level value to the `methodMap` indexes above.
   lookupLevel: function (level) {
@@ -18,10 +19,30 @@ let logger = {
     return level;
   },
 
+  convertDepth: function (depth) {
+    depth = parseInt(depth, 10);
+    if (isNaN(depth) || depth < 0) {
+      depth = logger.depth;
+    }
+
+    return depth;
+  },
+
   // Can be overridden in the host environment
   log: function (level, ...message) {
     level = logger.lookupLevel(level);
 
+    // Check if the first message argument is a numeric depth
+    let depth = logger.depth;
+    if (
+      message.length > 0 &&
+      typeof message[0] === 'number' &&
+      !isNaN(message[0])
+    ) {
+      depth = logger.convertDepth(message[0]);
+      message = message.slice(1);
+    }
+
     if (
       typeof console !== 'undefined' &&
       logger.lookupLevel(logger.level) <= level
@@ -31,6 +52,36 @@ let logger = {
       if (!console[method]) {
         method = 'log';
       }
+
+      const isNodeEnvironment =
+        typeof process !== 'undefined' &&
+        process.versions && // eslint-disable-line no-undef
+        process.versions.node; // eslint-disable-line no-undef
+      if (isNodeEnvironment && depth !== 2) {
+        let formatWithOptions;
+        if (typeof require === 'function') {
+          try {
+            formatWithOptions = require('util').formatWithOptions;
+          } catch (e) {
+            // util module not available, fallback to default behavior
+          }
+        }
+        if (typeof formatWithOptions === 'function') {
+          const supportsColor =
+            typeof process !== 'undefined' &&
+            process.stdout &&
+            process.stdout.isTTY; // eslint-disable-line no-undef
+          const formatted = formatWithOptions(
+            {
+              depth: depth,
+              colors: supportsColor,
+            },
+            ...message
+          );
+          message = [formatted];
+        }
+      }
+
       console[method](...message); // eslint-disable-line no-console
     }
   },

spec/builtins.js

@@ -793,6 +793,71 @@ describe('builtin helpers', function () {
       expectTemplate('{{log}}').withInput({ blah: 'whee' }).toCompileTo('');
       expect(called).to.be.true();
     });
+
+    it('should handle hash depth parameter', function () {
+      var levelArg, depthArg, logArg;
+      handlebarsEnv.log = function (level, ...args) {
+        levelArg = level;
+        // Check if the first arg is a number (depth)
+        if (typeof args[0] === 'number') {
+          depthArg = args[0];
+          logArg = args[1];
+        } else {
+          logArg = args[0];
+        }
+      };
+
+      expectTemplate('{{log blah depth=5}}')
+        .withInput({ blah: 'whee' })
+        .toCompileTo('');
+      equals(1, levelArg);
+      equals(5, depthArg);
+      equals('whee', logArg);
+    });
+
+    it('should handle data depth parameter', function () {
+      var levelArg, depthArg, logArg;
+      handlebarsEnv.log = function (level, ...args) {
+        levelArg = level;
+        // Check if the first arg is a number (depth)
+        if (typeof args[0] === 'number') {
+          depthArg = args[0];
+          logArg = args[1];
+        } else {
+          logArg = args[0];
+        }
+      };
+
+      expectTemplate('{{log blah}}')
+        .withInput({ blah: 'whee' })
+        .withRuntimeOptions({ data: { depth: 3 } })
+        .withCompileOptions({ data: true })
+        .toCompileTo('');
+      equals(1, levelArg);
+      equals(3, depthArg);
+      equals('whee', logArg);
+    });
+
+    it('should handle both level and depth parameters', function () {
+      var levelArg, depthArg, logArg;
+      handlebarsEnv.log = function (level, ...args) {
+        levelArg = level;
+        // Check if the first arg is a number (depth)
+        if (typeof args[0] === 'number') {
+          depthArg = args[0];
+          logArg = args[1];
+        } else {
+          logArg = args[0];
+        }
+      };
+
+      expectTemplate('{{log blah level="error" depth=10}}')
+        .withInput({ blah: 'whee' })
+        .toCompileTo('');
+      equals('error', levelArg);
+      equals(10, depthArg);
+      equals('whee', logArg);
+    });
     /* eslint-enable no-console */
   });