core(errors-in-console): add ignoredPatterns option #9480
Conversation
| /** @return {AuditOptions} */ | ||
| static defaultOptions() { | ||
| return { | ||
| ignoredPatterns: undefined, |
There was a problem hiding this comment.
i forget what we prefer type-wise.. should this be null?
There was a problem hiding this comment.
it's null for all of our constants that end up in config.settings because we want to distinguish between the default and unset state, but here I don't think we have a preference. willing to accept whatever.
There was a problem hiding this comment.
any reason to do explicit undefined over optional?
There was a problem hiding this comment.
not really other than a more legible version of the typedef for documentation, will remove
| length: 8, | ||
| }, | ||
| items: [ | ||
| {description: /Application Cache Error/}, |
There was a problem hiding this comment.
these just got explicit so we'll need to resolve the conflict
|
@patrickhulce feel free to take a pass on the expectations whenever |
|
Oh I missed this ever got approval sorry! Will do 👍 |
| /** @return {AuditOptions} */ | ||
| static defaultOptions() { | ||
| return { | ||
| ignoredPatterns: undefined, |
There was a problem hiding this comment.
any reason to do explicit undefined over optional?
| } | ||
|
|
||
| return true; | ||
| }); |
There was a problem hiding this comment.
what are we going to do with poorly formed ignoredPatterns? The error messages aren't going to be very comprehensible (e.g. not an Array) and the silent failure when there isn't an exception (e.g. misspelled or not a string or regex) isn't going to be noticeable
There was a problem hiding this comment.
TypeError: ignoredPatterns is not iterable seems like a quite comprehensible error to fail with, IMO, especially given the sophistication necessary to set audit options at all.
I'm not sure how we could ever possibly know that a user has misspelled the error they want to ignore, so you've lost me on that one. users gotta learn to crawl on their own sometime 😆
There was a problem hiding this comment.
TypeError: ignoredPatterns is not iterableseems like a quite comprehensible error to fail with, IMO, especially given the sophistication necessary to set audit options at all.
yeah, that does read well
I'm not sure how we could ever possibly know that a user has misspelled the error they want to ignore, so you've lost me on that one. users gotta learn to crawl on their own sometime 😆
options: {ignoredPatternzzz: [/s.mple/i, 'really']} and nothing happens. How do I figure out why?
There was a problem hiding this comment.
Oooooh misspell the option name, that makes much more sense. 👍
Honestly, I strongly dislike the pattern we've been starting to apply that unknown properties are fatal errors which breaks backwards/forwards compatibility. Would a warning of unrecognized property names address your concern?
There was a problem hiding this comment.
Honestly, I strongly dislike the pattern we've been starting to apply that unknown properties are fatal errors which breaks backwards/forwards compatibility. Would a warning of unrecognized property names address your concern?
yeah, sounds great 👍
|
|
||
| /** | ||
| * @template {{description: string | undefined}} T | ||
| * @param {Array<T>} items |
There was a problem hiding this comment.
this is only ever called with /** @type {Array<{source: string, description: string|undefined, url: string|undefined}>} */, which is already declared once. Should just be a typedef instead of parametric? :)
There was a problem hiding this comment.
why though? this method operates on things that have an optional description, no matter what they look like, and that's exactly how the types are expressed
There was a problem hiding this comment.
why though? this method operates on things that have an optional description, no matter what they look like, and that's exactly how the types are expressed
this is a nit, so can leave it, but it's only generic in the sense that all monomorphic functions are generic (over one type). Adding a parameter implies complexity that isn't there (it's only ever called with one type of thing).
There was a problem hiding this comment.
true, and if typescript had another method of expressing monomorphic functions that operate on a subset of the type while preserving the output type I would happily switch to that method :)
There was a problem hiding this comment.
method of expressing monomorphic functions that operate on a subset of the type while preserving the output type
I mean...
/**
* @param {Array<ConcreteType>} items
* @param {AuditOptions} options
* @return {Array<ConcreteType>}
*/
static filterAccordingToOptions(items, options) {
// ...
}operates on a subset of the type just fine :P
(I blame everyone's emojis for the continuation of this conversation 👻📠)
Summary
Adds the
ignoredPatternsaudit option toerrors-in-consolewhich takes an array ofRegExporstrings to filter the resulting text descriptions by.Related Issues/PRs
closes #9074