{"id":15365609,"url":"https://github.com/tunnckocore/stacktrace-metadata","last_synced_at":"2025-04-15T09:52:34.864Z","repository":{"id":1312833,"uuid":"42293848","full_name":"tunnckoCore/stacktrace-metadata","owner":"tunnckoCore","description":"Clean stack traces with sane defaults, customizable through options","archived":false,"fork":false,"pushed_at":"2023-01-12T06:13:35.000Z","size":442,"stargazers_count":4,"open_issues_count":10,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-08T07:42:54.682Z","etag":null,"topics":["clean","clean-stack","clean-stack-traces","clean-stacktrace","error-handling","error-stack-trace","metadata","stack","stack-traces","stacktrace"],"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/tunnckoCore.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-11T07:19:31.000Z","updated_at":"2023-03-04T04:44:46.000Z","dependencies_parsed_at":"2023-01-14T11:15:23.411Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCore/stacktrace-metadata","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fstacktrace-metadata","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fstacktrace-metadata/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fstacktrace-metadata/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCore%2Fstacktrace-metadata/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCore","download_url":"https://codeload.github.com/tunnckoCore/stacktrace-metadata/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710435,"owners_count":21149190,"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":["clean","clean-stack","clean-stack-traces","clean-stacktrace","error-handling","error-stack-trace","metadata","stack","stack-traces","stacktrace"],"created_at":"2024-10-01T13:15:15.858Z","updated_at":"2025-04-15T09:52:34.847Z","avatar_url":"https://github.com/tunnckoCore.png","language":"JavaScript","readme":"# stacktrace-metadata [![NPM version](https://img.shields.io/npm/v/stacktrace-metadata.svg?style=flat)](https://www.npmjs.com/package/stacktrace-metadata) [![mit license][license-img]][license-url] [![NPM monthly downloads](https://img.shields.io/npm/dm/stacktrace-metadata.svg?style=flat)](https://npmjs.org/package/stacktrace-metadata) [![npm total downloads][downloads-img]][downloads-url]\n\n\u003e Modify given `err` object to be more useful - adds `at`, `line`, `column`, `place` and `filename` properties and also cleans stack traces.\n\n[![code climate][codeclimate-img]][codeclimate-url] \n[![code style][standard-img]][standard-url] \n[![linux build][travis-img]][travis-url] \n[![windows build][appveyor-img]][appveyor-url] \n[![code coverage][coverage-img]][coverage-url] \n[![dependency status][david-img]][david-url]\n[![paypal donate][paypalme-img]][paypalme-url] \n\nYou might also be interested in [clean-stacktrace](https://github.com/tunnckocore/clean-stacktrace#readme).\n\n## Highlights\n\n- Works on Windows and Node.js \u003e= 0.10\n- Always normalizes Windows paths to be Unix-style\n- Customizable through options\n- Cleans stack trace using [clean-stacktrace][], `opts.cleanStack: false` to disable\n- Passing different current working directory to use, `opts.cwd`, using [clean-stacktrace-relative-paths][]\n- Makes paths relative against `opts.cwd`, `opts.relativePaths: false` to disable\n- Makes stack trace short - top 4, `opts.shortStack: false` to disable\n- Allow hiding the stack trace (making it empty string), `opts.showStack: false` to enable\n- Adds useful properties like `line`, `column` and `filename`, using [clean-stacktrace-metadata][]\n\n## Table of Contents\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n  * [stacktraceMetadata](#stacktracemetadata)\n- [Related](#related)\n- [Contributing](#contributing)\n- [Building docs](#building-docs)\n- [Running tests](#running-tests)\n- [Author](#author)\n- [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\nInstall with [npm](https://www.npmjs.com/)\n\n```\n$ npm install stacktrace-metadata --save\n```\n\nor install using [yarn](https://yarnpkg.com)\n\n```\n$ yarn add stacktrace-metadata\n```\n\n## Usage\n\u003e For more use-cases see the [tests](test.js)\n\n```js\nconst stacktraceMetadata = require('stacktrace-metadata')\n```\n\n## API\n\n### [stacktraceMetadata](index.js#L69)\n\u003e Cleans stack trace and attaches few more metadata properties, such as `at`, `line`, `column`, `filename` and `place`. By default it cleans stack, makes is short (4 length) and makes paths relative. But all this is controllable through `options` object. Throws `TypeError` if `error` is not an instance of Error.\n\n**Params**\n\n* `error` **{Error}**: real error object, checked against `instanceof Error`    \n* `options` **{Object}**: optional options object for more control    \n* `options.cleanStack` **{Boolean}**: if `false` won't clean stack trace from node internals    \n* `options.shortStack` **{Boolean}**: if `false` full stack traces, otherwise they are just four    \n* `options.showStack` **{Boolean}**: if `false` the error.stack will be empty string    \n* `options.relativePaths` **{Boolean}**: if `false` paths in stack traces will be absolute    \n* `options.mapper` **{Function}**: called on each line of the stack with `(line, index)` signature    \n* `options.cwd` **{String}**: current working directory, default `process.cwd()`    \n* `returns` **{Error}**: same error object, but modified  \n\n**Example**\n\n```js\nconst metadata = require('stacktrace-metadata')\n\nconst error = new Error('foo quxie')\nerror.stack = `Error: foo quxie\n    at zazz (/home/charlike/apps/alwa.js:8:10)\n    at module.exports (/home/charlike/apps/foo.js:6:3)\n    at Object.\u003canonymous\u003e (/home/charlike/apps/dush.js:45:3)\n    at Module._compile (module.js:409:26)\n    at Object.Module._extensions..js (module.js:416:10)\n    at Module.load (module.js:343:32)\n    at Function.Module._load (module.js:300:12)\n    at Function.Module.runMain (module.js:441:10)\n    at startup (node.js:139:18)\n`\nconst err = metadata(error)\n\nconsole.log(err.line) // =\u003e 8\nconsole.log(err.column) // =\u003e 10\nconsole.log(err.filename) // =\u003e 'alwa.js'\nconsole.log(err.place) // =\u003e 'zazz'\nconsole.log(err.at) // =\u003e 'zazz (alwa.js:8:10)'\nconsole.log(err.stack)\n// =\u003e\n// Error: foo quxie\n//     at zazz (alwa.js:8:10)\n//     at module.exports (foo.js:6:3)\n//     at Object.\u003canonymous\u003e (dush.js:45:3)\n```\n\n## Related\n- [abbrev-kindof](https://www.npmjs.com/package/abbrev-kindof): Use abbreviations for checking type of given value. Like `kindof(val, 'soa')` to check that value is string, object or array. | [homepage](https://github.com/tunnckocore/abbrev-kindof#readme \"Use abbreviations for checking type of given value. Like `kindof(val, 'soa')` to check that value is string, object or array.\")\n- [assert-kindof](https://www.npmjs.com/package/assert-kindof): Check native type of value and throw AssertionError if not okey. Clean stack traces. Simplicity. Built on [is-kindof][]. | [homepage](https://github.com/tunnckocore/assert-kindof#readme \"Check native type of value and throw AssertionError if not okey. Clean stack traces. Simplicity. Built on [is-kindof][].\")\n- [clean-stack](https://www.npmjs.com/package/clean-stack): Clean up error stack traces | [homepage](https://github.com/sindresorhus/clean-stack#readme \"Clean up error stack traces\")\n- [clean-stacktrace-metadata](https://www.npmjs.com/package/clean-stacktrace-metadata): Plugin for `clean-stacktrace` lib. Parse each line to get additional info like `filename`, `column` and `line` of the error. | [homepage](https://github.com/tunnckocore/clean-stacktrace-metadata#readme \"Plugin for `clean-stacktrace` lib. Parse each line to get additional info like `filename`, `column` and `line` of the error.\")\n- [clean-stacktrace-relative-paths](https://www.npmjs.com/package/clean-stacktrace-relative-paths): Meant to be used with [clean-stacktrace][] as mapper function. Makes absolute paths inside stack traces to relative paths. | [homepage](https://github.com/tunnckocore/clean-stacktrace-relative-paths#readme \"Meant to be used with [clean-stacktrace][] as mapper function. Makes absolute paths inside stack traces to relative paths.\")\n- [clean-stacktrace](https://www.npmjs.com/package/clean-stacktrace): Clean up error stack traces from node internals | [homepage](https://github.com/tunnckocore/clean-stacktrace#readme \"Clean up error stack traces from node internals\")\n- [dush](https://www.npmjs.com/package/dush): Microscopic \u0026 functional event emitter in ~260 bytes, extensible through plugins. | [homepage](https://github.com/tunnckocore/dush#readme \"Microscopic \u0026 functional event emitter in ~260 bytes, extensible through plugins.\")\n- [is-kindof](https://www.npmjs.com/package/is-kindof): Check type of given javascript value. Support promises, generators, streams, and native types. Built on [kind-of][] lib. | [homepage](https://github.com/tunnckocore/is-kindof#readme \"Check type of given javascript value. Support promises, generators, streams, and native types. Built on [kind-of][] lib.\")\n\n## Contributing\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/stacktrace-metadata/issues/new).  \nPlease read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  \nIf you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github\u0026utm_medium=button\u0026utm_term=tunnckocore\u0026utm_campaign=github) too.\n\n**In short:** If you want to contribute to that project, please follow these things\n\n1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See [\"Building docs\"](#building-docs) section.\n2. Ensure anything is okey by installing the dependencies and run the tests. See [\"Running tests\"](#running-tests) section.\n3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.\n4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.\n\nThanks a lot! :)\n\n## Building docs\nDocumentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that\n\n```\n$ npm install verbose/verb#dev verb-generate-readme --global \u0026\u0026 verb\n```\n\n_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._\n\n## Running tests\nClone repository and run the following in that cloned directory\n\n```\n$ npm install \u0026\u0026 npm test\n```\n\n## Author\n**Charlike Mike Reagent**\n\n+ [github/tunnckoCore](https://github.com/tunnckoCore)\n+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)\n+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)\n\n## License\nCopyright © 2015, 2017, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 15, 2017._  \n_Project scaffolded using [charlike][] cli._\n\n[charlike]: https://github.com/tunnckocore/charlike\n[clean-stacktrace-metadata]: https://github.com/tunnckocore/clean-stacktrace-metadata\n[clean-stacktrace-relative-paths]: https://github.com/tunnckocore/clean-stacktrace-relative-paths\n[clean-stacktrace]: https://github.com/tunnckocore/clean-stacktrace\n[commitizen]: https://github.com/commitizen/cz-cli\n[is-kindof]: https://github.com/tunnckocore/is-kindof\n[kind-of]: https://github.com/jonschlinkert/kind-of\n[standard-version]: https://github.com/conventional-changelog/standard-version\n[verb-generate-readme]: https://github.com/verbose/verb-generate-readme\n[verb]: https://github.com/verbose/verb\n\n[license-url]: https://www.npmjs.com/package/stacktrace-metadata\n[license-img]: https://img.shields.io/npm/l/stacktrace-metadata.svg\n\n[downloads-url]: https://www.npmjs.com/package/stacktrace-metadata\n[downloads-img]: https://img.shields.io/npm/dt/stacktrace-metadata.svg\n\n[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/stacktrace-metadata\n[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/stacktrace-metadata.svg\n\n[travis-url]: https://travis-ci.org/tunnckoCore/stacktrace-metadata\n[travis-img]: https://img.shields.io/travis/tunnckoCore/stacktrace-metadata/master.svg?label=linux\n\n[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/stacktrace-metadata\n[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/stacktrace-metadata/master.svg?label=windows\n\n[coverage-url]: https://codecov.io/gh/tunnckoCore/stacktrace-metadata\n[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/stacktrace-metadata/master.svg\n\n[david-url]: https://david-dm.org/tunnckoCore/stacktrace-metadata\n[david-img]: https://img.shields.io/david/tunnckoCore/stacktrace-metadata.svg\n\n[standard-url]: https://github.com/feross/standard\n[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg\n\n[paypalme-url]: https://www.paypal.me/tunnckoCore\n[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg\n\n","funding_links":["https://www.paypal.me/tunnckoCore"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fstacktrace-metadata","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunnckocore%2Fstacktrace-metadata","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunnckocore%2Fstacktrace-metadata/lists"}