@anansi/webpack-config v19.0.2

Anansi's Webpack Config

A webpack configuration for fast development and production ready optimizations.

Currently supports webpack 4 and 5.

Usage

/webpack.config.js

const { makeConfig } = require('@anansi/webpack-config');

const options = {
  basePath: 'src',
  buildDir: 'generated_assets/',
};

module.exports = { options };

module.exports = makeConfig(options);

/package.json

{
  "scripts": {
    "start:dev": "webpack serve --mode=development",
    "build": "webpack --mode=production",
    "build:server": "webpack --mode=production --target=node",
    "analyze": "webpack --mode=production --env analyze",
    "profile": "webpack --mode=production --env profile",
    "pkgcheck": "webpack --env check=nobuild",
  }
}

Storybook 6

/.storybook/webpack.config.js

const { makeStorybookConfigGenerator } = require('@anansi/webpack-config');
const { options } = require('../webpack.config');

module.exports = makeStorybookConfigGenerator(options);

Enabling react-refresh

Install react-refresh as a dev-dependency in your project and it will automatically be detected and enabled. Be sure to use the anansi babel or include react-refresh/babel in your own babel configuration.

yarn add --dev react-refresh

CMD line arguments

analyze

If set, will build a static treemap visualization of your packages. Highly recommended to run in production mode to get accurate results.

webpack --mode=production --env analyze

check

If set will run package checks to check for duplicates or ciruclar dependencies. Set equal to 'nobuild' for a standalone run where build output is not needed.

Examples: webpack --mode=production --env check or webpack --env check=nobuild

profile

If set, will enable React DevTools Profiler. This feature is only available in production mode since it is enabled in development by default.

webpack --mode=production --env profile

readable

Skips minification. This is useful when trying to debug production code.

webpack --mode=production --env readable

target

To target node instead of default of web. This is useful when building a node server for SSR alongside the client bundle.

webpack --mode=production --target=node

ENV customization

WEBPACK_PUBLIC_HOST = ''

Sets domain of served files. This is useful to distinguish between different build environments that will serve assets from different locations like a CDN.

Serves as first half of publicPath

Note: dev mode sets its own path based assets serving is completely controlled by webpack-dev-server.

WEBPACK_PUBLIC_PATH = '/'

Forms the second half of the publicPath. Can be useful when assets are served in subdirectories as opposed to custom domains like in the case of CDNs.

Options

Pass these to makeConfig.

libraryInclude/libraryExclude

Regex to match libraries to include in the normal build process. This is useful for locally developed modules or yarn workspaces. Not this should point to the installed location, rather than the actual target. Note you'll need both the positive and negative regexes.

libraryExclude defaults to /node_modules/, which will exclude libraries from expensive and potentially incorrect processing from babel loaders.

To match all libraries in namespace @myspacespace:

const myConfig = makeConfig({
  libraryInclude: /node_modules\/(@mynamespace\/)/,
  libraryExclude: /node_modules(?!\/(@mynamespace\/))/,
});

basePath = 'src'

Marks the base directory inside the package for javascript source files. This is used to make it easy to import from the root.

Example:

-package.json
-/src
  -/components
  -/pages
  -/utils
    -network.js

Then you can do

import fetch from 'network';

from any file.

babelRoot = \$CWD

babelRoot should be where the root babel configuration file is in your repo. Usually this is CWD, but while setting up a monorepo with multiple babel configurations, you may need to change this value.

rootPath = \$CWD

Root path should be the root path of your project. Usually where your package.json and webpack.config.js are. This defaults to the current working directory you are running commands from. However, if you need to run things from another directory, you can send __dirname into this option from your webpack.config.js.

buildDir = 'generated_assets/'

Output directory for production build files

serverDir: 'server_assets/'

Output directory for production server builds. Used when using --target=node cli option.

mode: argv?.mode || process.env.NODE_ENV

Override the mode

bundleAnalyzerOptions

Customize how to analyze your bundles

hardCacheOptions = false

Customize how hard-source-webpack-plugin works. Set to {} or other options to enable plugin. This plugin often speeds up development, but can sometimes cause compatibility issues. Because of this, it is disabled by default.

manifestFilename = 'manifest.json'

Determines the filename for the stats file that includes mappings to all filenames.

babelLoader

Override any babel loader specific options.

extraJsLoaders = []

Any extra loaders to use on JavaScript/TypeScript files.

cssModuleOptions

Customize css module options.

sassResources

resources option from https://github.com/shakacode/sass-resources-loader#readme

This is useful to specify global variables and mixins to be included in every sass file.

File Support

• SCSS with CSS modules
  • Use ${basePath}/style/export.scss to add variables or mixins avaiable in all scss files
  • Put global styles within ${basePath}/style
  • Other styles will be treated as css modules
• Web workers
• All font formats
• Any media files
  • svg|png|jpg|avif|gif|ico|webp|otf|eot|woff2|woff|ttf|pdf|mp4|webm|wav|mp3|m4a|aac|oga as file urls anywhere
  • svgs imported in javascript/typescript can be used as either components or file urls
• Raw string data: (md|txt) as a string (using raw-loader)

import starUrl, { ReactComponent as Star } from './star.svg'

const App = () => (
  <div>
    <img src={starUrl} alt="star" />
    <Star />
  </div>
)

• Javascript & TypeScript

Working with TypeScript

Add @anansi/webpack-config/types to the types in tsconfig.json

{
  "compilerOptions": {
    "types": ["@anansi/webpack-config/types"],
  }
}

This makes all imports of supported formats typed correctly, including svgs, media files and workers.

e.g.,

import plain from './plain.css';
import Worker from './my.worker.ts';
import angleDownUrl, {
  ReactComponent as AngleDown,
} from './angle-down-solid.svg';

worker.postMessage({ message: 'rendered' });

export default function MyComponent() {
  return (
    <>
      <AngleDown className={plain.svg} />
      <img src={angleDownUrl} />
    </>
  );
}

Working with Linaria

1. Install linaria: yarn add --dev linaria
2. Use extraJsLoaders option, to add the loader.

const myConfig = makeConfig({
  extraJsLoaders: [
    {
      loader: 'linaria/loader',
      options: {
        sourceMap: argv?.mode !== 'production',
      },
    }
  ]
});

3. Add linaria/babel to babel presets.

module.exports = {
  presets: [
    ['@anansi/babel-preset', { typing: 'typescript' }],
    'linaria/babel',
  ],
};