{"id":16208487,"url":"https://github.com/ehmicky/winston-error-format","last_synced_at":"2025-03-19T08:30:49.164Z","repository":{"id":63740365,"uuid":"569392265","full_name":"ehmicky/winston-error-format","owner":"ehmicky","description":"Log errors with Winston","archived":false,"fork":false,"pushed_at":"2024-02-14T20:48:37.000Z","size":4210,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-03-15T00:23:25.830Z","etag":null,"topics":["browser","console","error","error-handler","error-handling","error-monitoring","format","formatter","http","javascript","library","log","logger","logger-middleware","logging","nodejs","typescript","winston","winston-logger","winstonjs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ehmicky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-22T18:12:42.000Z","updated_at":"2024-04-22T20:36:57.135Z","dependencies_parsed_at":"2024-02-14T21:50:46.231Z","dependency_job_id":null,"html_url":"https://github.com/ehmicky/winston-error-format","commit_stats":{"total_commits":148,"total_committers":3,"mean_commits":"49.333333333333336","dds":0.03378378378378377,"last_synced_commit":"b6b27ef47bd6fb2ea98ae6c2c050ceb7006f8b53"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":"ehmicky/template-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fwinston-error-format","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fwinston-error-format/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fwinston-error-format/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fwinston-error-format/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/winston-error-format/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976478,"owners_count":20377691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","console","error","error-handler","error-handling","error-monitoring","format","formatter","http","javascript","library","log","logger","logger-middleware","logging","nodejs","typescript","winston","winston-logger","winstonjs"],"created_at":"2024-10-10T10:17:14.809Z","updated_at":"2025-03-19T08:30:49.158Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","readme":"[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/winston-error-format)\n[![TypeScript](https://img.shields.io/badge/-Typed-808080?logo=typescript\u0026colorA=404040\u0026logoColor=0096ff)](/src/main.d.ts)\n[![Codecov](https://img.shields.io/badge/-Tested%20100%25-808080?logo=codecov\u0026colorA=404040)](https://codecov.io/gh/ehmicky/winston-error-format)\n[![Minified size](https://img.shields.io/bundlephobia/minzip/winston-error-format?label\u0026colorA=404040\u0026colorB=808080\u0026logo=webpack)](https://bundlephobia.com/package/winston-error-format)\n[![Mastodon](https://img.shields.io/badge/-Mastodon-808080.svg?logo=mastodon\u0026colorA=404040\u0026logoColor=9590F9)](https://fosstodon.org/@ehmicky)\n[![Medium](https://img.shields.io/badge/-Medium-808080.svg?logo=medium\u0026colorA=404040)](https://medium.com/@ehmicky)\n\nLog errors with [Winston](https://github.com/winstonjs/winston).\n\n# Hire me\n\nPlease\n[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)\nif you're looking for a Node.js API or CLI engineer (11 years of experience).\nMost recently I have been [Netlify Build](https://github.com/netlify/build)'s\nand [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'\ntechnical lead for 2.5 years. I am available for full-time remote positions.\n\n# Features\n\nThis provides with two Winston\n[formats](https://github.com/winstonjs/winston/blob/master/README.md#formats):\n\n- [Full](#fullformatoptions): includes all properties\n- [Short](#shortformatoptions): includes only the error's `name`, `message` and\n  `stack`\n\nUnlike Winston's default\n[error format](https://github.com/winstonjs/logform#errors):\n\n- The error `name` is logged\n- The full format logs nested errors, including\n  [`cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)\n  and aggregate\n  [`errors`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError)\n- The full format is [JSON-safe](https://github.com/ehmicky/safe-json-value)\n- The short format optionally logs the stack trace\n- The error instance is not modified\n\n# Example\n\nUsing the [full format](#fullformatoptions).\n\n```js\nimport { createLogger, format, transports } from 'winston'\n\nimport { fullFormat } from 'winston-error-format'\n\nconst logger = createLogger({\n  format: format.combine(fullFormat(), format.json()),\n  transports: [new transports.Http(httpOptions)],\n})\n\nconst error = new ExampleError('Could not read file.')\nerror.filePath = '/...'\nlogger.error(error)\n// Sent via HTTP:\n// {\n//   level: 'error',\n//   name: 'ExampleError',\n//   message: 'Could not read file.',\n//   stack: `ExampleError: Could not read file.\n//     at ...`,\n//   filePath: '/...',\n// }\n```\n\nUsing the [short format](#shortformatoptions).\n\n```js\nimport { createLogger, format, transports } from 'winston'\n\nimport { shortFormat } from 'winston-error-format'\n\nconst logger = createLogger({\n  format: format.combine(shortFormat(), format.cli()),\n  transports: [new transports.Console()],\n})\n\nconst error = new ExampleError('Could not read file.')\nlogger.error(error)\n// Printed on the console:\n// error: ExampleError: Could not read file.\n//     at ...\n```\n\n# Install\n\n```bash\nnpm install winston-error-format\n```\n\nThis package requires installing [Winston](https://github.com/winstonjs/winston)\nseparately.\n\n```bash\nnpm install winston\n```\n\nThis package works in Node.js \u003e=18.18.0.\n\nThis is an ES module. It must be loaded using\n[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),\nnot `require()`. If TypeScript is used, it must be configured to\n[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),\nnot CommonJS.\n\n# API\n\n## fullFormat(options?)\n\n`options`: [`Options`](#options)\\\n_Return value_: `Format`\n\nReturns a logger\n[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)\nto [combine](https://github.com/winstonjs/winston#combining-formats) with\n[`format.json()`](https://github.com/winstonjs/logform#json) or\n[`format.prettyPrint()`](https://github.com/winstonjs/logform#prettyprint). This\nlogs all error properties, making it useful with\n[transports](https://github.com/winstonjs/winston#transports) like\n[HTTP](https://github.com/winstonjs/winston/blob/master/docs/transports.md#http-transport).\n\nErrors should be logged using\n[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).\n\n## shortFormat(options?)\n\n`options`: [`Options`](#options)\\\n_Return value_: `Format`\n\nReturns a logger\n[`format`](https://github.com/winstonjs/winston/blob/master/README.md#formats)\nto [combine](https://github.com/winstonjs/winston#combining-formats) with\n[`format.simple()`](https://github.com/winstonjs/logform#simple) or\n[`format.cli()`](https://github.com/winstonjs/logform#cli). This logs only the\nerror `name`, `message` and `stack`, making it useful with\n[transports](https://github.com/winstonjs/winston#transports) like the\n[console](https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport).\n\nErrors should be logged using\n[`logger.*(error)`](https://github.com/winstonjs/winston/blob/master/README.md#creating-your-own-logger).\n\n## Options\n\n_Type_: `object | ((Error) =\u003e object)`\n\nThe options object can be error-specific by passing a function returning it\ninstead.\n\n### stack\n\n_Type_: `boolean`\\\n_Default_: `true`\n\nWhether to log the stack trace.\n\n### level\n\n_Type_: `string`\n\nOverride the log [level](https://github.com/winstonjs/winston#logging-levels).\n\n### transform\n\n_Type_: `(Error) =\u003e Error`\n\nMaps the `error` before logging it.\n\n# Related projects\n\n- [`winston`](https://github.com/winstonjs/winston): A logger for just about\n  everything\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`modern-errors-winston`](https://github.com/ehmicky/modern-errors-winston):\n  Log errors with Winston\n- [`error-custom-class`](https://github.com/ehmicky/error-custom-class): Create\n  one error class\n- [`error-class-utils`](https://github.com/ehmicky/error-class-utils): Utilities\n  to properly create error classes\n- [`error-serializer`](https://github.com/ehmicky/error-serializer): Convert\n  errors to/from plain objects\n- [`normalize-exception`](https://github.com/ehmicky/normalize-exception):\n  Normalize exceptions/errors\n- [`is-error-instance`](https://github.com/ehmicky/is-error-instance): Check if\n  a value is an `Error` instance\n- [`merge-error-cause`](https://github.com/ehmicky/merge-error-cause): Merge an\n  error with its `cause`\n- [`set-error-class`](https://github.com/ehmicky/set-error-class): Properly\n  update an error's class\n- [`set-error-message`](https://github.com/ehmicky/set-error-message): Properly\n  update an error's message\n- [`wrap-error-message`](https://github.com/ehmicky/wrap-error-message):\n  Properly wrap an error's message\n- [`set-error-props`](https://github.com/ehmicky/set-error-props): Properly\n  update an error's properties\n- [`set-error-stack`](https://github.com/ehmicky/set-error-stack): Properly\n  update an error's stack\n- [`error-cause-polyfill`](https://github.com/ehmicky/error-cause-polyfill):\n  Polyfill `error.cause`\n- [`handle-cli-error`](https://github.com/ehmicky/handle-cli-error): 💣 Error\n  handler for CLI applications 💥\n- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON\n  serialization should never fail\n- [`log-process-errors`](https://github.com/ehmicky/log-process-errors): Show\n  some ❤ to Node.js process errors\n- [`error-http-response`](https://github.com/ehmicky/error-http-response):\n  Create HTTP error responses\n\n# Support\n\nFor any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).\n\nEveryone is welcome regardless of personal background. We enforce a\n[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and\ninclusive environment.\n\n# Contributing\n\nThis project was made with ❤️. The simplest way to give back is by starring and\nsharing it online.\n\nIf the documentation is unclear or has a typo, please click on the page's `Edit`\nbutton (pencil icon) and suggest a correction.\n\nIf you would like to help us fix a bug or add a new feature, please check our\n[guidelines](CONTRIBUTING.md). Pull requests are welcome!\n\n\u003c!-- Thanks go to our wonderful contributors: --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003c!--\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://fosstodon.org/@ehmicky\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/8136211?v=4\" width=\"100px;\" alt=\"ehmicky\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eehmicky\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ehmicky/winston-error-format/commits?author=ehmicky\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#design-ehmicky\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-ehmicky\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"https://github.com/ehmicky/winston-error-format/commits?author=ehmicky\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fwinston-error-format","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fwinston-error-format","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fwinston-error-format/lists"}