Parth

Posted on Feb 19 • Originally published at devsarticles.com

Complete Guide On Modification Of Configuration With React-App-Rewired

#react #modification

Introduction To React-App-Wired

React-app-rewired is a usefull tool for React developers that enables them to modify the configuration of their React applications without having to eject from Create React App.

Now let’s break that down this. When you create a React app using Create React App. It sets up a bunch of configurations behind the scenes to make your development process smooth. But sometimes, you might want to customize these configurations to add new features or tweak existing ones. This is where React-app-rewired comes into play.

Instead of ejecting your app from Create React App (which basically means taking control of all the configurations yourself which can be a bit complex) now you can use React-app-rewired to override certain configurations without the need for ejecting.

So why is this usefull ? Well imagine you want to use a newer version of a tool like Babel or Webpack in your React app but Create React App hasn’t updated to that version yet. With React-app-rewired you can easily update these tools without having to deal with the complexities of ejecting.

In simple words React-app-rewired makes it easier for React developers to customize their projects without going deep into the messy details of configuration management. It’s like having a little helper that lets you tweak things without making a big mess.

Let’s Get Started With React App Rewired

First Install React App Rewired To Your React App

First you need to install React-app-rewired and its related dependencies. Open your terminal or command prompt and navigate to your Create React App project directory. Then run the following command:

npm install react-app-rewired customize-cra --save-dev

This will install React-app-rewired along with Customize-CRA which is a package that allows you to customize Create React App configurations.

Create Config File

Next you need to create a configuration file. In the root directory of your project create a file called config-overrides.js. This file will contain the customizations you want to make to your Create React App configurations.

Configure Babel, Webpack Etc.

Inside config-overrides.js you can import functions from customize-cra to customize various aspects of your project. For example if you want to add a new Babel plugin you can do so like this:

const { addBabelPlugin } = require('customize-cra');

module.exports = function override(config, env) {
  // Add a new Babel plugin
  config = addBabelPlugin(['@babel/plugin-proposal-decorators', { legacy: true }]);

  return config;
};

This is just an example. You can customize other aspects of your project such as Webpack configuration, ESLint rules etc. By using the functions provided by Customize-CRA.

Update Scripts In Package.Json

Finally, you need to update the scripts in your package.json file to use React app rewired instead of the default react-scripts. In the scripts section of your package.json modify the start, build and test scripts like this:

"scripts": {
  "start": "react-app-rewired start",
  "build": "react-app-rewired build",
  "test": "react-app-rewired test",
  ...
}

Customizing Webpack Configurations With React-App-Rewired

Adding Loaders For Loading CSS Module

Loaders are used to process files in your project. For example if you want to add support for loading CSS modules. You can use the addWebpackModuleRule function provided by Customize-CRA.

const { addWebpackModuleRule } = require('customize-cra');

module.exports = function override(config, env) {
  // Add support for loading CSS modules
  config = addWebpackModuleRule({
    test: /\.module\.css$/,
    use: ['style-loader', 'css-loader']
  })(config);

  return config;
};

Adding Plugins To App

Plugins extend the functionality of Webpack. For Example if you want to use the HtmlWebpackPlugin to generate an HTML file for your project you can add it using the addWebpackPlugin function.

const HtmlWebpackPlugin = require('html-webpack-plugin');
const { addWebpackPlugin } = require('customize-cra');

module.exports = function override(config, env) {
  // Add HtmlWebpackPlugin to generate HTML file
  config = addWebpackPlugin(new HtmlWebpackPlugin({
    template: 'public/index.html',
    filename: 'index.html'
  }))(config);

  return config;
};

Modify Existing Settings Of App

You can also modify existing settings in the Webpack configuration. For example, if you want to change the output directory for your build files, you can do so by accessing the output property of the configuration object.

module.exports = function override(config, env) {
  // Change output directory for build files
  config.output.path = path.resolve(__dirname, 'custom-output');

  return config;
};

Advanced Customizations

React-app-rewired allows for more advanced customizations such as modifying optimization settings, configuring aliases for module imports and more. You can explore the full range of options provided by Customize-CRA to make Webpack configurations to your specific needs.

Best Practices, Tips And Tricks For Using React-App-Rewired

Best Practices For React App Rewired

Keep Configuration Separate : Maintain a clear separation between your application code and configuration overrides. Place your config-overrides.js file in the root directory of your project and keep it focused on customizing Webpack configurations.
Use Modular Customizations : Break down your customizations into small and modular functions using the functions provided by Customize-CRA. This makes it easier to manage and understand your configuration overrides and allows for better reusability.
Test Changes Thoroughly : Always test your configuration changes thoroughly to make sure they work as expected. Run your application in development and production modes and verify that any customizations you applied behave correctly.
Document Customizations : Document any customizations you make to your project’s configurations. Include comments in your config-overrides.js file to explain the purpose of each customization and any dependencies or considerations.
Stay Updated : Keep React-app-rewired and Customize-CRA up to date with the latest versions to benefit from bug fixes, performance improvements and new features. Regularly check for updates and consider updating your project accordingly.

Tips And Tricks For React-App-Rewired

Explore Available Functions : Familiarize yourself with the functions provided by Customize-CRA such as addWebpackModuleRule, addWebpackPlugin and override. Explore the documentation to discover additional customization options and possibilities.
Utilize Community Packages : Take advantage of community packages and plugins that extend the functionality of React-app-rewired. There are many third-party packages available for common use cases such as optimizing images, configuring environment variables and more.
Use Conditional Customizations : Apply conditional logic in your config-overrides.js file to customize configurations based on specific conditions such as the environment or build target. This allows you to create more flexible and dynamic configurations.

Potential Pitfalls To Avoid In React-App-Rewired

Overcomplicating Configurations : Avoid overcomplicating your configuration overrides with unnecessary customizations. Keep your configurations simple and focused on addressing specific requirements to avoid complexity and potential issues.
Breaking Changes with Updates : Be cautious when updating React-app-rewired or Customize-CRA. As updates may introduce breaking changes or require adjustments to your configuration overrides. Always review release notes and test updates in a controlled environment before applying them to your project.
Ignoring Create React App Updates : Don’t ignore updates to Create React App itself. While React-app-rewired provides flexibility for customizing configurations. It’s important to stay up to date with Create React App updates to benefit from improvements, security patches and new features.

Conclusion

In final conclusion React-app-rewired offers a user-friendly solution for React developers who want too personalize their projects without getting lost in the complexities of configuration management. It acts as a helpful companion that enable easy adjustments without creating chaos. By bypassing the need for extensive reconfiguration it simplifies the customization process and making it more approachable. However it’s essential to stay updated to recommended practices to make sure smooth operations. With React-app-rewired make your React application becomes a straightforward and accessible task.

DEV Community