{"id":28484296,"url":"https://github.com/ehmicky/beautiful-error","last_synced_at":"2026-03-07T12:37:17.744Z","repository":{"id":294513584,"uuid":"987227130","full_name":"ehmicky/beautiful-error","owner":"ehmicky","description":"💣 Prettify error messages and stacks 💥","archived":false,"fork":false,"pushed_at":"2025-09-29T01:05:10.000Z","size":1262,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-29T02:34:34.229Z","etag":null,"topics":["bash","cli","console","error","error-handling","error-monitoring","errors","exit","exitcode","handler","javascript","library","message","monitoring","nodejs","shell","stack","terminal","timeout","typescript"],"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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-20T19:03:50.000Z","updated_at":"2025-09-29T01:05:13.000Z","dependencies_parsed_at":"2025-09-29T23:32:11.206Z","dependency_job_id":null,"html_url":"https://github.com/ehmicky/beautiful-error","commit_stats":null,"previous_names":["ehmicky/pretty-cli-error","ehmicky/beautiful-error"],"tags_count":6,"template":false,"template_full_name":"ehmicky/template-javascript","purl":"pkg:github/ehmicky/beautiful-error","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fbeautiful-error","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fbeautiful-error/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fbeautiful-error/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fbeautiful-error/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehmicky","download_url":"https://codeload.github.com/ehmicky/beautiful-error/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehmicky%2Fbeautiful-error/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278617485,"owners_count":26016559,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bash","cli","console","error","error-handling","error-monitoring","errors","exit","exitcode","handler","javascript","library","message","monitoring","nodejs","shell","stack","terminal","timeout","typescript"],"created_at":"2025-06-07T22:06:42.002Z","updated_at":"2025-10-06T13:24:13.789Z","avatar_url":"https://github.com/ehmicky.png","language":"JavaScript","readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/ehmicky/design/main/beautiful-error/beautiful-error_dark.svg\"/\u003e\n  \u003cimg alt=\"beautiful-error logo\" src=\"https://raw.githubusercontent.com/ehmicky/design/main/beautiful-error/beautiful-error.svg\" width=\"500\"/\u003e\n\u003c/picture\u003e\n\n[![Node](https://img.shields.io/badge/-Node.js-808080?logo=node.js\u0026colorA=404040\u0026logoColor=66cc33)](https://www.npmjs.com/package/beautiful-error)\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/beautiful-error)\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\nPrettify error messages and stacks.\n\n# Features\n\n- 🖍️ Pretty [colors](#%EF%B8%8F-colors), [icons](#-icon) and [header](#-header)\n- 💣 [Error class-specific](#-classes) and [custom](#-custom) handling\n- ⛑️ [Normalize](https://github.com/ehmicky/normalize-exception) invalid errors\n- 🔕 Log verbosity: [stack](#-stack), [nested errors](#-cause),\n  [properties](#-props)\n- 💥 Exception-safe\n\n# Screenshot\n\n\u003cimg alt=\"beautiful-error screenshot\" src=\"docs/screenshot.png\" width=\"500\"/\u003e\n\n# Example\n\n## General\n\n```js\nimport beautifulError from 'beautiful-error'\n\ntry {\n  // ...\n} catch (error) {\n  const message = beautifulError(error)\n  console.error(message)\n}\n```\n\n## Error class-specific\n\n```js\nconst message = beautifulError(error, {\n  InputError: { icon: 'warning', stack: false },\n  DatabaseError: { icon: 'info', stack: false },\n  default: { icon: 'cross' },\n})\n```\n\n# Install\n\n```bash\nnpm install beautiful-error\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## beautifulError(error, options?)\n\n`error` `any`\\\n`options` [`Options?`](#options)\\\n_Return value_: `string`\n\nReturns `error` as a prettified string.\n\nThis never throws. Invalid errors are silently\n[normalized](https://github.com/ehmicky/normalize-exception).\n\n### Options\n\n#### 📕 stack\n\n_Type_: `boolean`\\\n_Default_: `true`\n\nWhether to show the error's stack trace.\n\n#### 🪏 cause\n\n_Type_: `boolean`\\\n_Default_: `true`\n\nWhether to show nested errors, i.e.\n[`error.cause`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause)\nand\n[`error.errors`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AggregateError/errors).\n\n#### 📢 props\n\n_Type_: `boolean`\\\n_Default_: `true`\n\nWhether to show the error's additional properties.\n\n#### 🖍️ colors\n\n_Type_: `boolean`\\\n_Default_: `true` in terminals, `false` otherwise\n\nWhether to colorize the error's message, stack trace and additional properties.\n\nQuoted strings in the error's message are printed in bold (for `\"...\"` and\n`'...'`) and in italic (for `` `...` ``).\n\n#### ❌ icon\n\n_Type_: `string`\\\n_Default_: `'cross'`\n\nIcon prepended to the error's name. The available values are listed\n[here](https://github.com/sindresorhus/figures/blob/main/readme.md#figures-1).\nCan be disabled by passing an empty string.\n\n#### 💄 header\n\n_Type_: `string`\\\n_Default_: `'red bold'`\n\nColor/style of the error's [icon](#-icon) and name. The available values are\nlisted [here](https://github.com/ehmicky/chalk-string#available-styles). Several\nstyles can be specified by using spaces. Can be disabled by passing an empty\nstring.\n\n#### 💣 classes\n\n_Type_: `object`\\\n_Default_: `{}`\n\nSpecify [different options per error class](#error-class-specific). The object:\n\n- Keys are either the\n  [`error.name`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/name),\n  or `\"default\"` (used if no `error.name` matches)\n- Values are [options](#options) objects\n\n#### 🪛 custom\n\n_Type_: `string | symbol`\\\n_Default_: `beautiful`\n\nName of a method to map the output. That method must take the output as a string\nargument, transform it then return it.\n\n\u003c!-- eslint-disable fp/no-class --\u003e\n\n```js\nclass ExampleError extends Error {\n  beautiful(output) {\n    return output.replaceAll('secret', '***')\n  }\n}\n\nconst error = new ExampleError('Unknown value: secret')\nconst message = beautifulError(error) // 'Unknown value: ***'\n```\n\n# Related projects\n\n- [`modern-errors`](https://github.com/ehmicky/modern-errors): Handle errors in\n  a simple, stable, consistent way\n- [`modern-errors-beautiful`](https://github.com/ehmicky/modern-errors-beautiful):\n  Prettify errors messages and stacks\n- [`modern-errors-cli`](https://github.com/ehmicky/modern-errors-cli): Handle\n  errors in CLI modules\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- [`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- [`winston-error-format`](https://github.com/ehmicky/winston-error-format): Log\n  errors with Winston\n\n# Credits\n\nThe logo background was created by\n[dgim-studio](https://www.freepik.com/free-vector/comic-dynamic-elements-set_7997347.htm).\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/beautiful-error/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/beautiful-error/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%2Fbeautiful-error","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehmicky%2Fbeautiful-error","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehmicky%2Fbeautiful-error/lists"}