Feature - optionally include Error.cause property

[lexctk]

This fixes #2446 by adding optional cause property

[chriskuech]

@DABH this PR seems simple and would help a lot--could you please take a look?

[DABH]

Can we add a test or modify a test to maintain coverage? 🙏

[lexctk]

Can we add a test or modify a test to maintain coverage? 🙏

took me way longer than expected to get back to this. I added a test case, please let me know if ok, I'll make any necessary changes

[p-herbert]

Any updates for this feature?

[chriskuech]

@p-herbert I was able to circumvent the issue with a custom formatter

import winston from 'winston'

export const serialize = (error: Error, i = 1): string =>
  `${i}. ${error.stack}\n${'cause' in error ? serialize(error.cause as Error, i + 1) : ''}`

const formatError = winston.format((info) => {
  if (info instanceof Error) {
    return {
      ...info,
      message: serialize(info),
    }
  }

  return info
})

export const logger = winston.createLogger({
  levels: winston.config.npm.levels,
  format: winston.format.combine(winston.format.timestamp(), formatError()),
  transports: [
    new winston.transports.Console({
      format: winston.format.combine(
        winston.format.colorize(),
        winston.format.simple(),
      ),
    }),
  ],
})

[HenriqueSilverio]

This would be very useful.

[DABH]

Given that this was fixed in logform but not in winston, I believe it's valid to go ahead and merge this. It feels like in general (unless there's some unlucky property name) this should not be a breaking change, and in any case, would be in the spirit of how we're trying to handle Errors, but addressing this new property added in es2022.

Thanks for your contribution!