Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arackaf/customize-cra

Override webpack configurations for create-react-app 2.0
https://github.com/arackaf/customize-cra

Last synced: about 2 months ago
JSON representation

Override webpack configurations for create-react-app 2.0

Host: GitHub
URL: https://github.com/arackaf/customize-cra
Owner: arackaf
License: mit
Created: 2018-09-28T14:42:33.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-10-06T20:33:24.000Z (12 months ago)
Last Synced: 2024-05-16T19:44:34.185Z (4 months ago)
Language: JavaScript
Homepage:
Size: 675 KB
Stars: 2,762
Watchers: 22
Forks: 269
Open Issues: 115
Metadata Files:
- Readme: readme.md
- Contributing: contributing.md
- License: LICENSE

Awesome Lists containing this project

awesome - customize-cra - Override webpack configurations for create-react-app 2.0 (JavaScript)
awesome-list - customize-cra - react-app 2.0 | arackaf | 2339 | (JavaScript)

README

        # `customize-cra`

[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors-)

📌📌 **Breaking change:** With the `1.0` release of customize-cra breaking changes have been made to the `addLessLoader` customizer to support the changes to `create-react-app` in [#7876](https://github.com/facebook/create-react-app/pull/7876). Please follow the migration guide in [#253](https://github.com/arackaf/customize-cra/issues/253).

This project provides a set of utilities to customize [`create-react-app`](https://github.com/facebook/create-react-app) versions 2 and 3 configurations leveraging [`react-app-rewired`](https://github.com/timarney/react-app-rewired/) core functionalities.

- [How to install](#how-to-install)

- [Warning](#warning)

- [Overview](#overview)

- [Usage](#usage)

  - [With `webpack`](#with-webpack)

  - [With `webpack-dev-server`](#with-webpack-dev-server)

  - [With `MobX`](#with-mobx)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Contributors](#contributors)

## How to install

This project relies on [`react-app-rewired`](https://github.com/timarney/react-app-rewired/). You'll need to install that in order for `customize-cra` to work.

```bash

yarn add customize-cra react-app-rewired --dev

```

## ❗ Warning

> "Stuff can break"

> \- Dan Abramov

Using this library will override the default behavior and configuration of `create-react-app`, therefore invalidating the guarantees that come with it. Use with discretion!

## Overview

`customize-cra` takes advantage of `react-app-rewired`'s `config-overrides.js` file. By importing `customize-cra` functions and exporting a few function calls wrapped in our `override` function, you can easily modify the underlying config objects (`webpack`, `webpack-dev-server`, `babel`, etc.) that make up `create-react-app`.

## Usage

**Note:** all code should be added to `config-overrides.js` at the same level as `package.json`.

See the [api docs](api.md) for documentation for each function.

### With `webpack`

To use these plugins, import the `override` function, and call it with whatever plugins you need. Each of these plugin invocations will return a new function, that `override` will call with the newly modified config object. Falsy values will be ignored though, so if you need to conditionally apply any of these plugins, you can do so like below.

For example:

```js

const {

  override,

  addDecoratorsLegacy,

  disableEsLint,

  addBundleVisualizer,

  addWebpackAlias,

  adjustWorkbox

} = require("customize-cra");

const path = require("path");

module.exports = override(

  // enable legacy decorators babel plugin

  addDecoratorsLegacy(),

  // disable eslint in webpack

  disableEsLint(),

  // add webpack bundle visualizer if BUNDLE_VISUALIZE flag is enabled

  process.env.BUNDLE_VISUALIZE == 1 && addBundleVisualizer(),

  // add an alias for "ag-grid-react" imports

  addWebpackAlias({

    ["ag-grid-react$"]: path.resolve(__dirname, "src/shared/agGridWrapper.js")

  }),

  // adjust the underlying workbox

  adjustWorkbox(wb =>

    Object.assign(wb, {

      skipWaiting: true,

      exclude: (wb.exclude || []).concat("index.html")

    })

  )

);

```

### With `webpack-dev-server`

You can use the `overrideDevServer` function to override the `webpack-dev-server` config. It works the same way as `override`:

```js

const {

  override,

  disableEsLint,

  overrideDevServer,

  watchAll

} = require("customize-cra");

module.exports = {

  webpack: override(

    // usual webpack plugin

    disableEsLint()

  ),

  devServer: overrideDevServer(

    // dev server plugin

    watchAll()

  )

};

```

### With `MobX`

If you want CRA 2 to work with MobX, use the `addDecoratorsLegacy` and `disableEsLint`.

## Documentation

[See `api.md`](api.md) for documentation on the functions provided by `customize-cra`.

## Contributing

For more information about contributing to this project, like a directory map or a how-to for reporting an issue about the project, please [`see contributing.md`](contributing.md).

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_dqu
💬

    
_Breeze
💻

    
_Terryand
💻

    
_m-weeks
🐛

    
_吴超
💡

    
_{James Thistlewood}
💻

    
_taddj
💬

  

  

    
_MeiLin
💻

    
_{Graham Crockford}
🤔

    
_afei
💻

    
_zoomdong
💻

    
_{Danilo Campana Fuchs}
💻

    
_{Rodrigo Narvaez}
💻

    
_blackmatch
💻

  

  

    
_billypon
💻

    
_Juetta
💻

    
_{LING_ZI_QING}
💻 📖

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!