Webpack-configuratiegenerator

webpack.config.js

Webpack maakt deze map bij elke build leeg.

React zonder TypeScript heeft Babel nodig om JSX te compileren.

Vereist de optie “HTML-pagina”, die de losse bestanden voor je aan de pagina toevoegt.

Laat de alias leeg als je er geen nodig hebt. Met @ en src schrijf je @/components/Button.

Configuratie genereren

Wie een webpack.config.js uit het hoofd schrijft, moet de precieze opbouw van output, de test-regex van elke loader en de te installeren pakketten onthouden. Deze generator maakt daar een kort formulier van: kies gewoon JavaScript, React of Vue 3, vul je entry-bestand, uitvoermap en modus in en vink aan wat je nodig hebt, van TypeScript en Babel tot Sass, afbeeldingen en lettertypen, HtmlWebpackPlugin en een devserver. Hij schrijft een webpack 5-configuratie volgens de officiële documentatie, de npm install-regel voor precies de pakketten die erin staan en, met TypeScript, een bijpassende tsconfig.json.

Zo maak je een webpack-configuratie

  1. 1

    Entry en uitvoer instellen

    Typ je entry-bestand en de uitvoermap (standaard `dist`). Het voorgestelde entry-bestand volgt je framework, bijvoorbeeld `./src/index.tsx` voor React met TypeScript.

  2. 2

    Modus en framework kiezen

    Kies `production` of `development` en daarna gewoon JavaScript, React of Vue 3. De modus bepaalt de bestandsnamen, het soort source map en hoe CSS wordt geladen.

  3. 3

    Loaders en plugins aanzetten

    Zet aan wat je nodig hebt: TypeScript, Babel, CSS, Sass, afbeeldingen en lettertypen, `HtmlWebpackPlugin`, een devserver, source maps, apart gebundelde vendorcode en een importalias.

  4. 4

    De bestanden kopiëren

    Klik op “Configuratie genereren” en kopieer daarna `webpack.config.js`, de `npm install`-regel en, met TypeScript, `tsconfig.json` naar de hoofdmap van je project.

Standaarduitvoer

Met de standaardinstellingen (modus productie, gewoon JavaScript, Babel, CSS, afbeeldingen en lettertypen, HtmlWebpackPlugin, een devserver en source maps) schrijft de generator:

const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');

module.exports = {
  mode: 'production',
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: '[name].[contenthash].js',
    clean: true,
  },
  devtool: 'source-map',
  module: {
    rules: [
      {
        test: /\.(?:js|mjs|cjs)$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader',
          options: {
            targets: 'defaults',
            presets: [['@babel/preset-env']],
          },
        },
      },
      {
        test: /\.css$/i,
        use: [MiniCssExtractPlugin.loader, 'css-loader'],
      },
      {
        test: /\.(png|svg|jpg|jpeg|gif|webp|avif)$/i,
        type: 'asset/resource',
      },
      {
        test: /\.(woff|woff2|eot|ttf|otf)$/i,
        type: 'asset/resource',
      },
    ],
  },
  plugins: [
    new HtmlWebpackPlugin({
      template: './src/index.html',
    }),
    new MiniCssExtractPlugin({
      filename: '[name].[contenthash].css',
    }),
  ],
  devServer: {
    port: 3000,
    hot: true,
  },
};

Je krijgt er ook de installatieregel bij voor precies die pakketten:

npm install -D webpack webpack-cli webpack-dev-server html-webpack-plugin babel-loader @babel/core @babel/preset-env css-loader mini-css-extract-plugin

Wat elke optie schrijft

Optie Wat ze aan de configuratie toevoegt
Entry-bestand De waarde van entry. Een pad als src/index.js krijgt ./ ervoor, omdat webpack paden zonder voorvoegsel in node_modules zoekt.
Uitvoermap output.path, opgelost met path.resolve(__dirname, 'dist'), plus output.clean: true.
Modus mode: 'production' of mode: 'development'. In productie heten de bestanden [name].[contenthash].js als HtmlWebpackPlugin de pagina schrijft; in ontwikkeling [name].js.
Framework React voegt @babel/preset-react toe, of met TypeScript "jsx": "react-jsx" in tsconfig.json. Vue 3 voegt vue-loader, VueLoaderPlugin en de feature flags van Vue via DefinePlugin toe.
TypeScript Een ts-loader-regel voor .ts en .tsx, die extensies in resolve.extensions en een tsconfig.json.
Babel Een babel-loader-regel met @babel/preset-env en targets: 'defaults'.
CSS en Sass style-loader in ontwikkeling of MiniCssExtractPlugin in productie, gevolgd door css-loader; Sass voegt sass-loader en het pakket sass toe.
Afbeeldingen en lettertypen Twee regels voor asset modules met type: 'asset/resource', die in webpack 5 file-loader en url-loader vervangen.
HTML-pagina HtmlWebpackPlugin met een index.html-sjabloon naast je entry-bestand.
Devserver Een devServer-blok op poort 3000 met hot reload. Met React of Vue komen historyApiFallback en publicPath: '/' erbij, zodat routes aan de clientkant laden.
Source maps devtool: 'source-map' in productie en 'eval-source-map' in ontwikkeling.
Vendorcode apart bundelen optimization.splitChunks met chunks: 'all'.
Importalias Een resolve.alias-item zoals '@': path.resolve(__dirname, 'src'), met TypeScript ook opgenomen in de paths van tsconfig.json.

Wat de tool voor je beslist

  • Een veilige uitvoermap. output.clean maakt de uitvoermap bij elke build leeg, dus de tool weigert src, public, node_modules, de hoofdmap van het project en elke map waarin je entry-bestand staat.
  • Eén manier om CSS te laden. style-loader en MiniCssExtractPlugin worden nooit gecombineerd, zoals de documentatie van de plugin aanraadt.
  • Hashes alleen met een gegenereerde pagina. Een met de hand geschreven index.html kan niet naar een bestandsnaam met hash verwijzen. Zonder HtmlWebpackPlugin heten de bestanden daarom [name].js en serveert de devserver je pagina vanuit ./public.
  • Vue met TypeScript slaat de typecontrole in de build over. ts-loader draait met transpileOnly: true, zoals in het voorbeeld van vue-loader; controleer de types in je editor of met vue-tsc.

Verder uitbreiden

De gegenereerde bestanden zijn een startpunt. Veelgebruikte aanvullingen die je zelf toevoegt: postcss-loader voor Autoprefixer of Tailwind CSS, fork-ts-checker-webpack-plugin voor snellere typecontrole, copy-webpack-plugin voor statische bestanden en een proxy-item in devServer voor een lokale API.

Veelgestelde vragen

Voor webpack 5 en webpack-dev-server 5 of 6. De uitvoer gebruikt output.clean, bestandsnamen met [contenthash], asset modules en resolve.extensions met '...', dus een clean-plugin, file-loader of url-loader heb je niet nodig.

Nee, de webpack-configuratie is altijd een JavaScript-bestand webpack.config.js. De optie TypeScript voegt een ts-loader-regel toe en levert een tsconfig.json voor je broncode; het formaat van de webpack-configuratie zelf verandert niet.

Met de optie HTML-pagina gebruikt HtmlWebpackPlugin een index.html-sjabloon naast je entry-bestand. Maak dat bestand aan (React en Vue hebben een element nodig om in te mounten, zoals <div id="root"></div> of <div id="app"></div>) of zet de optie uit.

Het gegenereerde devServer-blok gebruikt poort 3000 met hot reload. Pas de waarde van port in het gekopieerde bestand aan als je een andere nodig hebt.

Ja. Elke optie voegt een eigen regel toe (ts-loader voor .ts en .tsx, babel-loader voor .js), dus je kunt de ene, de andere of allebei gebruiken. React zonder TypeScript heeft Babel nodig om JSX te compileren, daarom houdt de tool Babel in dat geval aan.

Gerelateerde tools

Tool beschikbaar in andere talen