https://github.com/artdecocode/clean-stack1
A utility to remove internal Node.js lines and specific modules from error stacks.
https://github.com/artdecocode/clean-stack1
Last synced: about 2 months ago
JSON representation
A utility to remove internal Node.js lines and specific modules from error stacks.
- Host: GitHub
- URL: https://github.com/artdecocode/clean-stack1
- Owner: artdecocode
- License: other
- Created: 2018-09-13T02:36:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-13T03:21:59.000Z (over 7 years ago)
- Last Synced: 2025-02-25T15:52:00.204Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @artdeco/clean-stack
[](https://npmjs.org/package/@artdeco/clean-stack)
`@artdeco/clean-stack` is a fork of clean-stack to remove internal Node.js lines from error stacks, as well as lines from specific modules.
```sh
yarn add -E @artdeco/clean-stack
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`cleanStack(stack: string, options?: Config)`](#cleanstackstack-stringoptions-config-void)
* [`Config`](#config)
- [TODO](#todo)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import cleanStack from '@artdeco/clean-stack'
```
## `cleanStack(`
`stack: string,`
`options?: Config,`
`): void`
__`Config`__: Options for the program.
| Name | Type | Description | Default |
| ------------- | ---------- | ------------------------------------------------------------- | ------------- |
| pretty | _boolean_ | Replace the absolute path to the home directory with the `~`. | `false` |
| ignoreModules | _string[]_ | Which modules to ignore in the path. | `['pirates']` |
Remove unuseful internal Node.js lines from the error stack. Any other modules to ignore can be passed in the `ignoreModules` option.
```js
/* yarn example/ */
import cleanStack from '@artdeco/clean-stack'
const err = `
Error: test
at Object. (/Users/zavr/adc/clean-stack/i2.js:1:69)
at Module._compile (module.js:652:30)
at Module._compile (/Users/zavr/adc/clean-stack/node_modules/pirates/lib/index.js:83:24)
at Module._extensions..js (module.js:663:10)
at Object.newLoader [as .js] (/Users/zavr/adc/clean-stack/node_modules/pirates/lib/index.js:88:7)
at Module.load (module.js:565:32)
at tryModuleLoad (module.js:505:12)
at Function.Module._load (module.js:497:3)
at Module.require (module.js:596:17)
at require (internal/module.js:11:18)
`.trim()
const res = cleanStack(err)
```
```
Error: test
at Object. (/Users/zavr/adc/clean-stack/i2.js:1:69)
```
## TODO
- [ ] Add a new item to the todo list.
## Copyright
(c) [Art Deco][1] 2018
[1]: https://artdeco.bz