ag-grid is proud to partner with webpack

Stats

object string

The stats option lets you precisely control what bundle information gets displayed. This can be a nice middle ground if you don't want to use quiet or noInfo because you want some bundle information, but not all of it.

For webpack-dev-server, this property needs to be in the devServer configuration object.

For webpack-dev-middleware, this property needs to be in the webpack-dev-middleware's options object.

This option does not have any effect when using the Node.js API.

webpack.js.org

module.exports = {
  //...
  stats: 'errors-only'
};

Stats Presets

webpack comes with certain presets available for the stats output:

Preset	Alternative	Description
Preset Alternative Description `'errors-only'` none	none	Only output when errors happen
Preset Alternative Description `'errors-warnings'` none	none	Only output errors and warnings happen
Preset Alternative Description `'minimal'` none	none	Only output when errors or new compilation happen
Preset Alternative Description `'none'` `false`	`false`	Output nothing
Preset Alternative Description `'normal'` `true`	`true`	Standard output
Preset Alternative Description `'verbose'` none	none	Output everything
Preset Alternative Description `'detailed'` none	none	Output everything except `chunkModules` and `chunkRootModules`

Stats Options

It is possible to specify which information you want to see in the stats output.

All of the options in the stats configuration object are optional.

`stats.all`

A fallback value for stats options when an option is not defined. It has precedence over local webpack defaults.

module.exports = {
  //...
  stats: {
    all: undefined
  }
};

`stats.assets`

boolean = true

Tells stats whether to show the asset information. Set stats.assets to false to hide it.

module.exports = {
  //...
  stats: {
    assets: false
  }
};

`stats.assetsSort`

string = 'id'

Tells stats to sort the assets by a given field. All of the sorting fields are allowed to be used as values for stats.assetsSort. Use ! prefix in the value to reverse the sort order by a given field.

module.exports = {
  //...
  stats: {
    assetsSort: '!size'
  }
};

`stats.builtAt`

boolean = true

Tells stats whether to add the build date and the build time information. Set stats.builtAt to false to hide it.

module.exports = {
  //...
  stats: {
    builtAt: false
  }
};

`stats.moduleAssets`

boolean = true

Tells stats whether to add information about assets inside modules. Set stats.moduleAssets to false to hide it.

module.exports = {
  //...
  stats: {
    moduleAssets: false
  }
};

`stats.cached`

boolean = true

Tells stats whether to add information about the cached modules (not the ones that were built).

module.exports = {
  //...
  stats: {
    cached: false
  }
};

`stats.cachedAssets`

boolean = true

Tells stats whether to add information about the cached assets. Setting stats.cachedAssets to false will tell stats to only show the emitted files (not the ones that were built).

module.exports = {
  //...
  stats: {
    cachedAssets: false
  }
};

`stats.children`

boolean = true

Tells stats whether to add information about the children.

module.exports = {
  //...
  stats: {
    children: false
  }
};

`stats.chunks`

boolean = true

Tells stats whether to add information about the chunk. Setting stats.chunks to false results in a less verbose output.

module.exports = {
  //...
  stats: {
    chunks: false
  }
};

`stats.chunkGroups`

boolean = true

Tells stats whether to add information about the namedChunkGroups.

module.exports = {
  //...
  stats: {
    chunkGroups: false
  }
};

`stats.chunkModules`

boolean = true

Tells stats whether to add information about the built modules to information about the chunk.

module.exports = {
  //...
  stats: {
    chunkModules: false
  }
};

`stats.chunkRootModules`

boolean = true

Tells stats whether to add information about the root modules of chunks. Applied if stats.chunks = true.

module.exports = {
  //...
  stats: {
    chunkRootModules: false
  }
};

`stats.chunkOrigins`

boolean = true

Tells stats whether to add information about the origins of chunks and chunk merging.

module.exports = {
  //...
  stats: {
    chunkOrigins: false
  }
};

`stats.chunksSort`

string = 'id'

Tells stats to sort the chunks by a given field. All of the sorting fields are allowed to be used as values for stats.chunksSort. Use ! prefix in the value to reverse the sort order by a given field.

module.exports = {
  //...
  stats: {
    chunksSort: 'name'
  }
};

`stats.context`

string = '../src/'

Sets the context directory for shortening the request information.

module.exports = {
  //...
  stats: {
    context: '../src/components/'
  }
};

`stats.colors`

boolean = false object

Tells stats whether to output in the different colors.

module.exports = {
  //...
  stats: {
    colors: true
  }
};

It is also available as a CLI flag:

webpack-cli --colors

You can specify your own terminal output colors using ANSI escape sequences

module.exports = {
  //...
  colors: {
    green: '\u001b[32m',
  },
};

`stats.depth`

boolean = false

Tells stats whether to display the distance from the entry point for each module.

module.exports = {
  //...
  stats: {
    depth: true
  }
};

`stats.entrypoints`

boolean = true

Tells stats whether to display the entry points with the corresponding bundles.

module.exports = {
  //...
  stats: {
    entrypoints: false
  }
};

`stats.env`

boolean = false

Tells stats whether to display the --env information.

module.exports = {
  //...
  stats: {
    env: true
  }
};

`stats.orphanModules`

boolean = false

Tells stats whether to hide orphan modules. A module is an orphan if it is not included in any chunk. Orphan modules are hidden by default in stats.

module.exports = {
  //...
  stats: {
    orphanModules: true
  }
};

`stats.errors`

boolean = true

Tells stats whether to display the errors.

module.exports = {
  //...
  stats: {
    errors: false
  }
};

`stats.errorDetails`

boolean = true

Tells stats whether to add the details to the errors.

module.exports = {
  //...
  stats: {
    errorDetails: false
  }
};

`stats.errorStack`

boolean = true

Tells stats whether to show stack trace of errors.

module.exports = {
  //...
  stats: {
    errorStack: false
  }
};

`stats.excludeAssets`

array = []: string | RegExp | function (assetName) => boolean string RegExp function (assetName) => boolean

Tells stats to exclude the matching assets information. This can be done with a string, a RegExp, a function that is getting the assets name as an argument and returns a boolean. stats.excludeAssets can be an array of any of the above.

module.exports = {
  //...
  stats: {
    excludeAssets: [
      'filter',
      /filter/,
      (assetName) => assetName.contains('moduleA')
    ]
  }
};

`stats.excludeModules`

array = []: string | RegExp | function (assetName) => boolean string RegExp function (assetName) => boolean boolean: false

Tells stats to exclude the matching modules information. This can be done with a string, a RegExp, a function that is getting the module's source as an argument and returns a boolean. stats.excludeModules can be an array of any of the above. stats.excludeModules's configuration is merged with the stats.exclude's configuration value.

module.exports = {
  //...
  stats: {
    excludeModules: [
      'filter',
      /filter/,
      (moduleSource) => true
    ]
  }
};

Setting stats.excludeModules to false will disable the exclude behaviour.

module.exports = {
  //...
  stats: {
    excludeModules: false
  }
};

`stats.exclude`

See stats.excludeModules.

`stats.hash`

boolean = true

Tells stats whether to add information about the hash of the compilation.

module.exports = {
  //...
  stats: {
    hash: false
  }
};

`stats.logging`

Tells stats whether to add logging output.

'none', false - disable logging
'error' - errors only
'warn' - errors and warnings only
'info' - errors, warnings, and info messages
'log', true - errors, warnings, info messages, log messages, groups, clears. Collapsed groups are displayed in a collapsed state.
'verbose' - log everything except debug and trace. Collapsed groups are displayed in expanded state.

module.exports = {
  //...
  stats: {
    logging: 'verbose'
  }
};

`stats.loggingDebug`

array = []: string | RegExp | function (name) => boolean string RegExp function (name) => boolean

Tells stats to include the debug information of the specified loggers such as Plugins or Loaders. When stats.logging is set to false, stats.loggingDebug option is ignored.

module.exports = {
  //...
  stats: {
    loggingDebug: [
      'MyPlugin',
      /MyPlugin/,
      /webpack/, // To get core logging
      (name) => name.contains('MyPlugin')
    ]
  }
};

`stats.loggingTrace`

boolean = true

Enable stack traces in the logging output for errors, warnings and traces. Set stats.loggingTrace to hide the trace.

module.exports = {
  //...
  stats: {
    loggingTrace: false
  }
};

`stats.maxModules`

number = 15

Set the maximum number of modules to be shown.

module.exports = {
  //...
  stats: {
    maxModules: 5
  }
};

`stats.modules`

boolean = true

Tells stats whether to add information about the built modules.

module.exports = {
  //...
  stats: {
    modules: false
  }
};

`stats.modulesSort`

string = 'id'

Tells stats to sort the modules by a given field. All of the sorting fields are allowed to be used as values for stats.modulesSort. Use ! prefix in the value to reverse the sort order by a given field.

module.exports = {
  //...
  stats: {
    modulesSort: 'size'
  }
};

`stats.moduleTrace`

boolean = true

Tells stats to show dependencies and the origin of warnings/errors. stats.moduleTrace is available since webpack 2.5.0.

module.exports = {
  //...
  stats: {
    moduleTrace: false
  }
};

`stats.outputPath`

boolean = true

Tells stats to show the outputPath.

module.exports = {
  //...
  stats: {
    outputPath: false
  }
};

`stats.performance`

boolean = true

Tells stats to show performance hint when the file size exceeds performance.maxAssetSize.

module.exports = {
  //...
  stats: {
    performance: false
  }
};

`stats.preset`

string boolean: false

Sets the preset for the type of information that gets displayed. It is useful for extending stats behaviours.

module.exports = {
  //...
  stats: {
    preset: 'minimal'
  }
};

Setting value of stats.preset to false tells webpack to use 'none' stats preset.

`stats.providedExports`

boolean = false

Tells stats to show the exports of the modules.

module.exports = {
  //...
  stats: {
    providedExports: true
  }
};

`stats.publicPath`

boolean = true

Tells stats to show the publicPath.

module.exports = {
  //...
  stats: {
    publicPath: false
  }
};

`stats.reasons`

boolean = true

Tells stats to add information about the reasons of why modules are included.

module.exports = {
  //...
  stats: {
    reasons: false
  }
};

`stats.source`

boolean = false

Tells stats to add the source code of modules.

module.exports = {
  //...
  stats: {
    source: true
  }
};

`stats.timings`

boolean = true

Tells stats to add the timing information.

module.exports = {
  //...
  stats: {
    timings: false
  }
};

`stats.usedExports`

boolean = false

Tells stats whether to show which exports of a module are used.

module.exports = {
  //...
  stats: {
    usedExports: true
  }
};

`stats.version`

boolean = true

Tells stats to add information about the webpack version used.

module.exports = {
  //...
  stats: {
    version: false
  }
};

`stats.warnings`

boolean = true

Tells stats to add warnings.

module.exports = {
  //...
  stats: {
    warnings: false
  }
};

`stats.warningsFilter`

array = []: string | RegExp | function (warning) => boolean string RegExp function (warning) => boolean

Tells stats to exclude the warnings that are matching given filters. This can be done with a string, a RegExp, a function that is getting a warning as an argument and returns a boolean. stats.warningsFilter can be an array of any of the above.

module.exports = {
  //...
  stats: {
    warningsFilter: [
      'filter',
      /filter/,
      (warning) => true
    ]
  }
};

`stats.chunkRelations`

boolean = false

Tells stats to display chunk parents, children and siblings.

Sorting fields

For assetsSort, chunksSort and modulesSort there are several possible fields that you can sort items by:

'id' is the item's id;
'name' - a item's name that was assigned to it upon importing;
'size' - a size of item in bytes;
'chunks' - what chunks the item originates from (for example, if there are multiple subchunks for one chunk - the subchunks will be grouped together according to their main chunk);
'errors' - amount of errors in items;
'warnings' - amount of warnings in items;
'failed' - whether the item has failed compilation;
'cacheable' - whether the item is cacheable;
'built' - whether the asset has been built;
'prefetched' - whether the asset will be prefetched;
'optional' - whether the asset is optional;
'identifier' - identifier of the item;
'index' - item's processing index;
'index2'
'profile'
'issuer' - an identifier of the issuer;
'issuerId' - an id of the issuer;
'issuerName' - a name of the issuer;
'issuerPath' - a full issuer object. There's no real need to sort by this field;

Extending stats behaviours

If you want to use one of the pre-defined behaviours e.g. 'minimal' but still override one or more of the rules: specify the desired stats.preset and add the customized or additional rules afterwards.

webpack.config.js

module.exports = {
  //..
  stats: {
    preset: 'minimal',
    moduleTrace: true,
    errorDetails: true
  }
};

Contributors