Document webpack change: deprecate stats.warningsFilter in favor of ignoreWarnings

[webpack-bot]

A pull request by @sokra was merged and maintainers requested a documentation change.

See pull request: webpack/webpack#11506

---

improve warnings and errors handling in stats
respect warningsFilter for warnings count
include child compilation warnings and errors in count
show hint for child compilation errors and warnings
add config.ignoreWarnings
deprecate stats.warningsFilter

What kind of change does this PR introduce?
refactoring

Did you add tests for your changes?
yes

Does this PR introduce a breaking change?
no, only deprecation

What needs to be documented once your changes are merged?

• stats.warningsFilter is deprecated
• ignoreWarnings is the new option
  • RegExp
  • {module?: RegExp, file?: RegExp, message?: RegExp}
  • function(WebpackError, Compilation): boolean

[snitin315]

Taking on this.

[u01jmg3]

@snitin315, @EugeneHlushko: is this correct? Shouldn't it be documented as ignoreWarnings and not stats.ignoreWarnings?

Invalid configuration object. Webpack has been initialized using a configuration object that does not match the API schema.
 - configuration.stats has an unknown property 'ignoreWarnings'. These properties are valid:
   object { all?, assets?, assetsSort?, assetsSpace?, builtAt?, cached?, cachedAssets?, cachedModules?, children?, chunkGroupAuxiliary?, chunkGroupChildren?, chunkGroupMaxAssets?, chunkGroups?, chunkModules?, chunkOrigins?, chunkRelations?, chunks?, chunksSort?, colors?, context?, dependentModules?, depth?, entrypoints?, env?, errorDetails?, errorStack?, errors?, errorsCount?, exclude?, excludeAssets?, excludeModules?, groupAssetsByChunk?, groupAssetsByEmitStatus?, groupAssetsByExtension?, groupAssetsByInfo?, groupAssetsByPath?, groupModulesByAttributes?, groupModulesByCacheStatus?, groupModulesByExtension?, groupModulesByPath?, hash?, ids?, logging?, loggingDebug?, loggingTrace?, moduleAssets?, moduleTrace?, modules?, modulesSort?, modulesSpace?, nestedModules?, optimizationBailout?, orphanModules?, outputPath?, performance?, preset?, providedExports?, publicPath?, reasons?, relatedAssets?, runtimeModules?, source?, timings?, usedExports?, version?, warnings?, warningsCount?, warningsFilter? }
   -> Stats options object.

[snitin315]

Yes, Indeed. My bad 😞, It should be ignoreWarnings. Can you send a PR fixing it ?

[u01jmg3]

I can do but what file should this documentation live in? Currently it's in stats.md but this is no longer correct for the ignoreWarnings option.

[snitin315]

I think other-options.md will be appropriate.

[u01jmg3]

@snitin315: see #4076