improve the truncate logic by adding logs

Author: GrantBirki

dist/index.js

@@ -1,3 +1,6 @@
+import * as core from '@actions/core'
+import {COLORS} from './colors'
+
 const truncatedMessageStart =
   'The message is too large to be posted as a comment.\n<details><summary>Click to see the truncated message</summary>\n'
 const truncatedMessageEnd = '\n</details>'
@@ -9,12 +12,22 @@ const maxCommentLength = 65536
 // returned as is.
 // :param message: The message to be truncated (String)
 export function truncateCommentBody(message) {
+  // If the message is short enough, return it as is
   if (message.length <= maxCommentLength) {
+    core.debug('comment body is within length limit')
     return message
   }
+
+  // if we make it here, the message is too long, so truncate it
+  core.warning(
+    `✂️ truncating - comment body is too long - current: ${COLORS.highlight}${message.length}${COLORS.reset} characters - max: ${COLORS.highlight}${maxCommentLength}${COLORS.reset} characters`
+  )
+
   let truncated = message.substring(
     0,
     maxCommentLength - truncatedMessageStart.length - truncatedMessageEnd.length
   )
+
+  // return the truncated message wrapped in a details tag
   return truncatedMessageStart + truncated + truncatedMessageEnd
 }