Giter VIP home page Giter VIP logo

webpack's Introduction

@stackup/webpack

Build Version License

Functions that you can compose to build the perfect Webpack configuration. These functions bake in best practices, so you can stop copy-pasting them from the internet!

View the API documentation here

Install

$ yarn add @stackup/webpack --dev

Usage

Step 1: Add scripts

Add the following to your package.json.

{
  // ...
  "scripts": {
    "start": "webpack serve",
    "build": "webpack --env production"
  }
  // ...
}

After adding this configuration, you can run:

  • yarn start to start the development server
  • yarn build to create a production build

Step 2: Configure Babel

This library ships with a Babel preset to get you up and running quickly.

To configure Babel, add the following to your package.json:

{
  // ...
  "babel": {
    "presets": ["@stackup/webpack/babel-preset"]
  }
  // ...
}

Step 3: Configure Webpack

This library provides a set of functions that can be composed to generate a production-ready webpack configuration file.

You can get started by copying the example here.

const path = require("path");
const webpack = require("@stackup/webpack");

module.exports = webpack.pipeline([
  // Set your entrypoint
  webpack.entry("./src/index.tsx"),

  // Output to `dist/`
  webpack.output({
    path: path.join(__dirname, "dist"),
    publicPath: "/",
  }),

  // More configuration goes here...
]);

Guides

Enabling TypeScript

To use TypeScript, just install it:

$ yarn add typescript --dev

Then, create a tsconfig.json file:

{
  "include": ["src", "types"],
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "jsx": "preserve",
    "lib": ["dom", "dom.iterable", "esnext"],
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "isolatedModules": true,
    "forceConsistentCasingInFileNames": true
  }
}

The target, module, moduleResolution, and jsx are especially important. Those settings above instruct TypeScript to let Babel do the heavy lifting.

Polyfill missing browser features

First, specify which browsers you want your application to support in your package.json:

{
  // ...
  "browserslist": {
    "production": [">0.2%", "not dead", "not op_mini all"],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  }
  // ...
}

Next, insert the following line at the very top of your entrypoint:

import "core-js/stable";

The Babel preset that ships with @stackup/webpack will translate that import to a bunch of smaller imports based on your browserlist and the features that you application actually depends on. So, after compilation, it might look something like this:

import "core-js/modules/es.array.unscopables.flat";
import "core-js/modules/es.array.unscopables.flat-map";

Enabling Fast Refresh

Note: This feature is experimental.

To support fast refresh for React applications, you'll need to update your Babel configuration:

{
  // ...
  "babel": {
    "presets": [["@stackup/webpack/babel-preset", { "refresh": true }]]
  }
  // ...
}

Then, you'll need to enable fast refresh in your webpack configuration:

import * as webpack from "@stackup/webpack";

module.exports = webpack.pipeline([
  // ...
  webpack.refresh(),
  // ...
]);

webpack's People

Contributors

rzane avatar dependabot-preview[bot] avatar mstubna avatar

Watchers

James Cloos avatar

webpack's Issues

Your .dependabot/config.yml contained invalid details

Dependabot encountered the following error when parsing your .dependabot/config.yml:

Automerging is not enabled for this account. You can enable it from the [account settings](https://app.dependabot.com/accounts/rzane/settings) screen in your Dependabot dashboard.

Please update the config file to conform with Dependabot's specification using our docs and online validator.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.