Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

customize-cra-util

PeckZeg5MIT1.1.3TypeScript support: included

customize-cra utils

readme

customize-cra-util

utilities for customize-cra.

Install

yarn add customize-cra-util --dev

Usage

const { addCssModulesCamelCase } = require('customize-cra-util');
const { override } = require('customize-cra');

module.exports = override(
  addCssModulesCamelCase()
);

API

addCssModulesCamelCase

add camel case variable names for css modules.

Usage

const { addCssModulesCamelCase } = require('customize-cra-util');
const { override } = require('customize-cra');

module.exports = override(
  addCssModulesCamelCase()
);

addDocumentTitle(title)

inject document title.

Usage

const { addDocumentTitle } = require('customize-cra-util');
const { override } = require('customize-cra');

module.exports = override(
  addDocumentTitle('react app')
);

notice: you should inject <%= htmlWebpackPlugin.options.title %> in index.html template.

<html>
  <head>
    <title><%= htmlWebpackPlugin.options.title %></title>
  </head>
</html>

resolveModules([additionalModulePaths])

put app's node_modules folder at resolve.modules first place, and inject additional node_modules folders.

Usage

const { resolveModules } = require('customize-cra-util');
const { override } = require('customize-cra');

module.exports = override(
  resolveModules()
);

addDeployEnvironmentVariables(extraEnvs: Record<string | number, any>)

inject deploy environment variables to process.env.

this util will search .env.deploy.* files through REACT_APP_ENV env variable.

example: when REACT_APP_ENV is beta, we will search .env.deploy.beta.local, .env.deploy.beta, .env.deploy files.

Usage

const { addDeployEnvironmentVariables } = require('customize-cra-util');
const { override } = require('customize-cra');
const pkgJson = require('./package.json');

module.exports = override(
  addDeployEnvironmentVariables({
    REACT_APP_PACKAGE: pkgJson.version
  })
);

changelog

CHANGELOG

1.1.3

2022-04-14

  • :bug: 兼容 HtmlWebpackPlugin 5.x 版本。

1.1.2

2021-12-11

  • :sparkles: addDeployEnvironmentVariables 新增 extraEnvs 参数。

1.1.1

2021-07-10

  • :bug: 修复了因 env 文件顺序导致的合并问题。