Creates an optional callback to check for other paths to omit

[broguinn]

Love this repo - I think it'd be great if we could omit a few more paths as-needed.

This PR:

• Adds an option for pathFilterCallback which can be used to filter out extra lines if the callback returns false for the line's path.
• Adds a test for this option.

I'll add to the readme for this option next. Let me know if you have any questions!

[sindresorhus]

Just out of curiosity, what kind of stack trace lines would you use it for?

[sindresorhus]

It should be a function instead that receives a string with the stack line and is expected to return a boolean weather to keep it. That's more flexible.

[broguinn]

@sindresorhus our team is writing a proxy for a class of objects in a view tree. This is great for adding metadata to our logging and terrible for readability for our call stack. We want to filter out all calls to the proxy.

Happy to make this a callback - give me a few minutes.

[sindresorhus]

Suggested change

	readonly pathFilterCallback?: (string) => boolean;
	readonly pathFilter?: (string) => boolean;

I don't think Callback adds anything. The method signature is clear.

[sindresorhus]

We are not just removing the paths, we are removing the stack lines with the matching paths. This should be clearer.

[sindresorhus]

I think a full example would be useful in this case. Something like:

@example

import cleanStack from 'clean-stack';

const error = new Error('Missing unicorn');

console.log(cleanStack(error.stack));
// Error: Missing unicorn
//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)

console.log(cleanStack(error.stack, {pathFilter ...}));
// Error: Missing unicorn
//     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)

[sindresorhus]

This is the inverse of how filter generally works. Filter keeps the element on true and discards on false.

[broguinn]

This is even how I implemented the pathFilter - I just missed the boolean inversion. Thanks.