Registry /
devops / favicons-webpack-plugin
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
default (FaviconsWebpackPlugin)
✓ const FaviconsWebpackPlugin = require('favicons-webpack-plugin')
This package is CommonJS-only; it does not provide an ESM export. Use require() for import.
FaviconsWebpackPlugin
✓ import FaviconsWebpackPlugin from 'favicons-webpack-plugin'
✗ import { FaviconsWebpackPlugin } from 'favicons-webpack-plugin'
The package uses a default export, not a named export. Named import will result in undefined.
FaviconsWebpackPlugin
✓ const FaviconsWebpackPlugin = require('favicons-webpack-plugin')
In a TypeScript CJS context, you may need to use '= require(...)' syntax or adjust your tsconfig.
Shows a full webpack config using HtmlWebpackPlugin and FaviconsWebpackPlugin with custom options and icon set configuration.
// webpack.config.js (CommonJS)
const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const FaviconsWebpackPlugin = require('favicons-webpack-plugin');
module.exports = {
entry: './src/index.js',
output: {
path: path.resolve(__dirname, 'dist'),
filename: 'bundle.js',
},
plugins: [
new HtmlWebpackPlugin({
template: './src/index.html',
}),
new FaviconsWebpackPlugin({
logo: './src/logo.png',
mode: 'webapp', // optional: 'webapp' | 'light' | 'auto'
devMode: 'webapp', // optional: 'webapp' | 'light' | 'auto' for development
favicons: {
appName: 'My App',
appDescription: 'My App Description',
developerName: 'My Name',
developerURL: 'https://example.com',
background: '#fff',
theme_color: '#fff',
icons: {
android: true,
appleIcon: true,
appleStartup: false,
favicons: true,
windows: true,
yandex: false,
},
},
}),
],
};
Errors
Common errors & fixes
Module not found: Error: Can't resolve 'favicons' in '/path/to/project'
Missing required peer dependency 'favicons'.
fixRun 'npm install --save-dev favicons@^7.0.1'.
TypeError: Cannot read properties of undefined (reading 'tapAsync')
Using an incompatible version of webpack (e.g., webpack 4 with plugin v6).
fixUpdate webpack to ^5.0.0 or downgrade plugin to v5.x.
FaviconsWebpackPlugin is not a constructor
Named import instead of default import in CommonJS or incorrect import syntax.
fixUse `const FaviconsWebpackPlugin = require('favicons-webpack-plugin')` (no destructuring) or `import FaviconsWebpackPlugin from 'favicons-webpack-plugin'`. Audit
Dependencies
faviconsrequiredRequired peer dependency for generating all icon files and manifest.
webpackrequiredRequired peer dependency for webpack plugin ecosystem.