monkey-react-scripts

5.0.0-0 • Public • Published

monkey-react-scripts

Monkey react script runner: Customize react-scripts webpack config without eject or fork

Many of you want to add a small change to your webpack config created by create-react-app. but you don't want to eject. or use other scripts like configurable-react-scripts or custom-react-scripts because of update delay.

With monkey-react-scripts you can use react-scripts configs, but monkey patched one. so you always have updated react-scripts.

DANGER

As @gaearon mentioned multiple times there, it's not good idea to extend it. From my point of view, I'm giving you gun, so try not to shot yourself, because probably nobody will help you. When you modify something, be completely sure what you doing!

source

Usage

  • use create-react-app and create your project, more detail
npm install -g create-react-app

create-react-app my-app
cd my-app/
  • install monkey-react-scripts
npm install monkey-react-scripts --save-dev --save-exact
  • create webpack.monkey.js in the root of your project. you can modify webpack config here.
module.exports = function(webpackConfig, isDevelopment) {
  // mutate webpackConfig
};
  • edit package.json and replace scripts
  "scripts": {
    "start": "monkey-react-scripts start",
    "build": "monkey-react-scripts build",
    "test": "monkey-react-scripts test"
  }

How it works

I suggest you see scripts and bin folders. (less than 100 line of code)

Note: returned value of require function is mutable. so you can mutate that before real build/start script.

Snippets

You can use snippets if you want.

snippets:

  • addPlugin
  • findRule
  • findBabelRule

Example

Before use examples, you should know what happens inside react-scripts webpack config. first, see and read this files:

  • node_modules/react-scripts/config/webpack.config.dev.js
  • node_modules/react-scripts/config/webpack.config.prod.js

also, you can log webpackConfig value.

// webpack.monkey.js
module.exports = function(webpackConfig, isDevelopment) {
  console.log(webpackConfig);
};

Also, you can find complete examples at monkey-react-scripts-example repo

Enable .babelrc

The .babelrc file is enabled for tests if you have webpack.monkey.js file. also, you can enable .babelrc for build and start:

  • edit webpack.monkey.js like this (copy findRule, findBabelRule from snippets):
function findRule(webpackConfig, callback) {
  /* snippet codes */
}

function findBabelRule(webpackConfig, callback) {
  /* snippet codes */
}

module.exports = function(webpackConfig, isDevelopment) {
  const babelRule = findBabelRule(webpackConfig);
  babelRule.options.babelrc = true;
};

Webpack Visualizer

I love visualization so, I add webpack-visualizer-plugin to my project

  • install plugin:
npm install webpack-visualizer-plugin --save-dev
  • add the plugin to config (only at build time)
// webpack.monkey.js
var Visualizer = require("webpack-visualizer-plugin");

module.exports = function(webpackConfig, isDevelopment) {
  if (!isDevelopment) {
    webpackConfig.plugins.push(new Visualizer());
  }
};
  • build
$ npm run build
// some output
$ tree build
build
├── asset-manifest.json
├── favicon.ico
├── index.html
├── static
│   ├── css
│   ├── js
│   └── media
└── stats.html                      <-- new file

Decorator support

If you love decorators, you can add decorator support:

  • install decorator plugin
npm install --save-dev @babel/plugin-proposal-decorators
  • edit .babelrc like this:
{
  "plugins": [["@babel/plugin-proposal-decorators", { "legacy": true }]]
}

related issues: #107, #167, #214, #309, #411, #1357

Relay support

  • install babel-plugin-relay
yarn add --dev babel-plugin-relay
  • edit .babelrc like this:
{
  "plugins": ["relay"]
}

and continue relay documentation steps.

if you are using relay classic you can see old readme and get some ideas.

related issues: #462, #662, #900

postcss config

If you want to change postcss config you can use this code.

// add rtl css support
// find postCssLoader
const postCssFunction = postCssLoader.options.plugins;
postCssLoader.options.plugins = () => {
  return [...postCssFunction(), require("postcss-inline-rtl")];
};

you can find more detail in this file

TODOs

  • [ ] customize test runner (jest)
  • [x] add more example
    • [x] relay support

compatibility

react-scripts monkey-react-scripts
0.9.x 0.0.5
1.x.x 0.1.0
2.0.0 - 2.1.1 0.1.2
2.1.2 0.1.4
3.0.0 0.2.0
4.0.0 0.3.0
5.0.0 5.0.0-0

Thanks

@svrcekmichal for configurable-react-scripts

Readme

Keywords

none

Package Sidebar

Install

npm i monkey-react-scripts

Weekly Downloads

139

Version

5.0.0-0

License

MIT

Unpacked Size

13.2 kB

Total Files

8

Last publish

Collaborators

  • smmoosavi