CRACO
**C**reate **R**eact **A**pp **C**onfiguration **O**verride, an easy and comprehensible configuration layer for create-react-app.
**Find config docs, API docs, plugins, and example configs at [craco.js.org](https://craco.js.org)!**
[](https://www.npmjs.com/package/@craco/craco) [](https://www.npmjs.com/package/@craco/craco) [](https://github.com/dilanx/craco/blob/main/packages/craco/LICENSE) [](https://github.com/dilanx/craco) [](https://github.com/dilanx/craco/graphs/contributors) [](https://github.com/dilanx/craco/pulls) 
Get all the benefits of [Create React App](https://create-react-app.dev) **and** customization without using 'eject' by adding a single configuration (e.g. `craco.config.js`) file at the root of your application and customize your ESLint, Babel, PostCSS configurations and many more.
1. Install the latest version of the package from npm as a dev dependency:
```
npm i -D @craco/craco
```
2. Create a CRACO configuration file in your project's root directory and [configure](https://craco.js.org/docs/):
```diff
my-app
├── node_modules
+ ├── craco.config.js
└── package.json
```
3. Update the existing calls to `react-scripts` in the `scripts` section of your `package.json` to use the `craco` CLI:
```diff title="package.json"
"scripts": {
- "start": "react-scripts start"
+ "start": "craco start"
- "build": "react-scripts build"
+ "build": "craco build"
- "test": "react-scripts test"
+ "test": "craco test"
}
```
Visit [craco.js.org](https://craco.js.org) to learn more.
================================================
FILE: lerna.json
================================================
{
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
"useWorkspaces": true,
"version": "7.1.0"
}
================================================
FILE: package.json
================================================
{
"name": "craco",
"private": true,
"license": "Apache-2.0",
"keywords": [
"react",
"create-react-app",
"cra"
],
"workspaces": [
"packages/*"
],
"scripts": {
"test:unit": "jest --config test/unit/jest.config.js",
"test:integration": "NODE_ENV=production jest --config test/integration/jest.config.js --runInBand",
"lint": "npm run lint:ts && npm run lint:es",
"lint:ts": "tsc --noEmit",
"lint:es": "eslint --ext .ts",
"tslint": "tsc --noEmit",
"bootstrap": "lerna bootstrap",
"build": "lerna exec npm run build",
"build:types": "npm run build -w @craco/types",
"build:craco": "npm run build -w @craco/craco",
"publish": "lerna publish --no-private",
"publish:alpha": "lerna publish --dist-tag alpha --no-private",
"pack": "lerna exec npm pack",
"refresh": "npm run build && npm run bootstrap",
"refresh:types": "npm run build:types && npm run bootstrap"
},
"prettier": "@dilanx/config/prettier",
"devDependencies": {
"@dilanx/config": "^1.1.0",
"@typescript-eslint/eslint-plugin": "^5.38.1",
"@typescript-eslint/parser": "^5.38.1",
"eslint": "^8.24.0",
"jest": "^29.5.0",
"jest-playwright-preset": "^3.0.1",
"lerna": "^6.5.1",
"playwright": "^1.33.0",
"prettier": "2.7.1"
}
}
================================================
FILE: packages/craco/LICENSE
================================================
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
================================================
FILE: packages/craco/README.md
================================================
CRACO
**C**reate **R**eact **A**pp **C**onfiguration **O**verride, an easy and comprehensible configuration layer for create-react-app.
**Find config docs, API docs, plugins, and example configs at [craco.js.org](https://craco.js.org)!**
[](https://www.npmjs.com/package/@craco/craco) [](https://www.npmjs.com/package/@craco/craco) [](https://github.com/dilanx/craco/blob/main/packages/craco/LICENSE) [](https://github.com/dilanx/craco) [](https://github.com/dilanx/craco/graphs/contributors) [](https://github.com/dilanx/craco/pulls)
Get all the benefits of [Create React App](https://create-react-app.dev) **and** customization without using 'eject' by adding a single configuration (e.g. `craco.config.js`) file at the root of your application and customize your ESLint, Babel, PostCSS configurations and many more.
1. Install the latest version of the package from npm as a dev dependency:
```
npm i -D @craco/craco
```
2. Create a CRACO configuration file in your project's root directory and [configure](https://craco.js.org/docs/):
```diff
my-app
├── node_modules
+ ├── craco.config.js
└── package.json
```
3. Update the existing calls to `react-scripts` in the `scripts` section of your `package.json` to use the `craco` CLI:
```diff title="package.json"
"scripts": {
- "start": "react-scripts start"
+ "start": "craco start"
- "build": "react-scripts build"
+ "build": "craco build"
- "test": "react-scripts test"
+ "test": "craco test"
}
```
Visit [craco.js.org](https://craco.js.org) to learn more.
================================================
FILE: packages/craco/package.json
================================================
{
"name": "@craco/craco",
"description": "Create React App Configuration Override, an easy and comprehensible configuration layer for create-react-app.",
"version": "7.1.0",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
"dist"
],
"scripts": {
"build": "tsc",
"prepack": "npm run build"
},
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "https://github.com/dilanx/craco.git",
"directory": "packages/craco"
},
"keywords": [
"react",
"create-react-app",
"cra"
],
"author": "Dilan Nair (https://www.dilanxd.com)",
"contributors": [
"Groupe Sharegate inc."
],
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/dilanx/craco/issues"
},
"homepage": "https://craco.js.org",
"engines": {
"node": ">=6"
},
"bin": {
"craco": "./dist/bin/craco.js"
},
"peerDependencies": {
"react-scripts": "^5.0.0"
},
"devDependencies": {
"@babel/types": "^7.19.3",
"@craco/types": "^7.1.0",
"@jest/types": "^27.5.1",
"@types/cross-spawn": "^6.0.2",
"@types/eslint": "^8.4.6",
"@types/jest": "^27.5.2",
"@types/lodash": "^4.14.186",
"@types/semver": "^7.3.12",
"babel-jest": "^29.7.0",
"eslint-webpack-plugin": "^3.2.0",
"jest": "^27.5.1",
"react-scripts": "5.*",
"ts-jest": "^27.1.5",
"typescript": "^4.8.4",
"webpack": "^5.74.0"
},
"dependencies": {
"autoprefixer": "^10.4.12",
"cosmiconfig": "^7.0.1",
"cosmiconfig-typescript-loader": "^1.0.0",
"cross-spawn": "^7.0.3",
"lodash": "^4.17.21",
"semver": "^7.3.7",
"webpack-merge": "^5.8.0"
}
}
================================================
FILE: packages/craco/src/bin/craco.ts
================================================
#!/usr/bin/env node
import spawn from 'cross-spawn';
const args = process.argv.slice(2);
const scriptIndex = args.findIndex(
(x) => x === 'build' || x === 'start' || x === 'test'
);
const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
switch (script) {
case 'build':
case 'start':
case 'test': {
const nodeArgs = scriptIndex > 0 ? args.slice(0, scriptIndex) : [];
const scriptPath = require.resolve(`../scripts/${script}`);
const scriptArgs = args.slice(scriptIndex + 1);
const processArgs = nodeArgs.concat(scriptPath).concat(scriptArgs);
const child = spawn.sync('node', processArgs, { stdio: 'inherit' });
if (child.signal) {
if (child.signal === 'SIGKILL') {
console.log(`
The build failed because the process exited too early.
This probably means the system ran out of memory or someone called
\`kill -9\` on the process.
`);
} else if (child.signal === 'SIGTERM') {
console.log(`
The build failed because the process exited too early.
Someone might have called \`kill\` or \`killall\`, or the system could
be shutting down.
`);
}
process.exit(1);
}
process.exit(child.status ?? undefined);
break;
}
default:
console.log(`Unknown script "${script}".`);
console.log('Perhaps you need to update craco?');
break;
}
================================================
FILE: packages/craco/src/bin/jest.ts
================================================
#!/usr/bin/env node
/*
* Copied (and converted to TS) from https://github.com/timarney/react-app-rewired/blob/master/packages/react-app-rewired/bin/jest.js
* This file is necessary to allow usage of craco as a drop-in replacement
* for react-scripts with WebStorms's test runner UI.
*
* For more information, see https://github.com/dilanx/craco/pull/41
*/
import spawn from 'cross-spawn';
const args = process.argv.slice(2);
const setupScriptFileIndex =
args.findIndex((x) => x === '--setupTestFrameworkScriptFile') + 1;
const isIntelliJ =
setupScriptFileIndex !== -1
? false
: args[setupScriptFileIndex].indexOf('jest-intellij') !== -1;
const result = spawn.sync(
process.argv[0],
([] as any[]).concat(require.resolve('../scripts/test'), args),
{
stdio: 'inherit',
env: Object.assign({}, process.env, isIntelliJ ? { CI: 1 } : null),
}
);
process.exit(result.signal ? 1 : result.status ?? undefined);
================================================
FILE: packages/craco/src/index.ts
================================================
import {
addAfterAssetModule,
addAfterAssetModules,
addBeforeAssetModule,
addBeforeAssetModules,
assetModuleByName,
getAssetModule,
getAssetModules,
removeAssetModules,
} from './lib/asset-modules';
import { createDevServerConfigProviderProxy } from './lib/features/dev-server/api';
import { createJestConfig } from './lib/features/jest/api';
import {
createWebpackDevConfig,
createWebpackProdConfig,
} from './lib/features/webpack/api';
import {
addAfterLoader,
addAfterLoaders,
addBeforeLoader,
addBeforeLoaders,
getLoader,
getLoaders,
loaderByName,
removeLoaders,
} from './lib/loaders';
import { gitHubIssueUrl, throwUnexpectedConfigError } from './lib/plugin-utils';
import { when, whenDev, whenProd, whenTest } from './lib/user-config-utils';
import {
addPlugins,
getPlugin,
pluginByName,
removePlugins,
} from './lib/webpack-plugins';
export {
getLoader,
getLoaders,
removeLoaders,
addBeforeLoader,
addBeforeLoaders,
addAfterLoader,
addAfterLoaders,
loaderByName,
getAssetModule,
getAssetModules,
removeAssetModules,
addBeforeAssetModule,
addBeforeAssetModules,
addAfterAssetModule,
addAfterAssetModules,
assetModuleByName,
getPlugin,
pluginByName,
addPlugins,
removePlugins,
when,
whenDev,
whenProd,
whenTest,
throwUnexpectedConfigError,
gitHubIssueUrl,
createJestConfig,
createWebpackDevConfig,
createWebpackProdConfig,
createDevServerConfigProviderProxy,
};
================================================
FILE: packages/craco/src/lib/args.ts
================================================
export interface CliArgs {
[key: string]: string | boolean;
}
export interface CliArgSpec {
[key: string]: { arg: string; value: boolean };
}
const args: CliArgSpec = {
verbose: {
arg: '--verbose',
value: false,
},
config: {
arg: '--config',
value: true,
},
};
let processedArgs: CliArgs = {};
export function getArgs() {
return processedArgs;
}
export function setArgs(values?: CliArgs) {
processedArgs = {
...processedArgs,
...values,
};
}
export function findArgsFromCli() {
const processed: CliArgs = {};
let i = 0;
while (i < process.argv.length) {
const arg = process.argv[i];
for (const a in args) {
if (arg === args[a].arg) {
processed[a] = args[a].value ? process.argv[i + 1] : true;
i++;
}
}
i++;
}
setArgs(processed);
}
================================================
FILE: packages/craco/src/lib/asset-modules.ts
================================================
import type {
AssetModule,
AssetModuleMatcher,
AssetModuleType,
} from '@craco/types';
import type { Configuration as WebpackConfig, RuleSetRule } from 'webpack';
export function assetModuleByName(assetModuleName: AssetModuleType) {
return (rule: RuleSetRule) => rule.type === assetModuleName;
}
const toMatchingAssetModule = (
rule: RuleSetRule,
index: number
): AssetModule => ({
rule,
index,
});
export function getAssetModule(
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher
) {
let matchingAssetModule: AssetModule | undefined;
(webpackConfig.module?.rules as RuleSetRule[])?.some((rule, index) => {
if (matcher(rule)) {
matchingAssetModule = toMatchingAssetModule(rule, index);
}
return matchingAssetModule !== undefined;
});
return {
isFound: matchingAssetModule !== undefined,
match: matchingAssetModule,
};
}
export function getAssetModules(
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher
) {
const matchingAssetModules: AssetModule[] = [];
(webpackConfig.module?.rules as RuleSetRule[])?.forEach((rule, index) => {
if (matcher(rule)) {
matchingAssetModules.push(toMatchingAssetModule(rule, index));
}
});
return {
hasFoundAny: matchingAssetModules.length !== 0,
matches: matchingAssetModules,
};
}
export function removeAssetModules(
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher
) {
const toRemove: number[] = [];
(webpackConfig.module?.rules as RuleSetRule[])?.forEach((rule, index) => {
if (matcher(rule)) {
toRemove.push(index);
}
});
toRemove.forEach((index) => {
webpackConfig.module?.rules?.splice(index, 1);
});
return {
rules: webpackConfig.module?.rules,
removedCount: toRemove.length,
};
}
function addAssetModule(
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule,
positionAdapter: (index: number) => number
) {
const { match } = getAssetModule(webpackConfig, matcher);
if (match !== undefined) {
webpackConfig.module?.rules?.splice(
positionAdapter(match.index),
0,
newAssetModule
);
return { isAdded: true };
}
return { isAdded: false };
}
export const addBeforeAssetModule = (
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule
) => addAssetModule(webpackConfig, matcher, newAssetModule, (x) => x);
export const addAfterAssetModule = (
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule
) => addAssetModule(webpackConfig, matcher, newAssetModule, (x) => x + 1);
function addAssetModules(
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule,
positionAdapter: (index: number) => number
) {
const { matches } = getAssetModules(webpackConfig, matcher);
if (matches.length !== 0) {
matches.forEach((match) => {
webpackConfig.module?.rules?.splice(
positionAdapter(match.index),
0,
newAssetModule
);
});
return { isAdded: true, addedCount: matches.length };
}
return { isAdded: false, addedCount: 0 };
}
export const addBeforeAssetModules = (
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule
) => addAssetModules(webpackConfig, matcher, newAssetModule, (x) => x);
export const addAfterAssetModules = (
webpackConfig: WebpackConfig,
matcher: AssetModuleMatcher,
newAssetModule: RuleSetRule
) => addAssetModules(webpackConfig, matcher, newAssetModule, (x) => x + 1);
================================================
FILE: packages/craco/src/lib/config.ts
================================================
import type { BaseContext, CracoConfig } from '@craco/types';
import { cosmiconfigSync } from 'cosmiconfig';
import tsLoader from 'cosmiconfig-typescript-loader';
import path from 'path';
import { getArgs } from './args';
import { applyCracoConfigPlugins } from './features/plugins';
import { log } from './logger';
import { projectRoot } from './paths';
import { deepMergeWithArray, isArray, isFunction, isString } from './utils';
const DEFAULT_CONFIG: CracoConfig = {
reactScriptsVersion: 'react-scripts',
style: {
postcss: {
mode: 'extends',
},
},
eslint: {
mode: 'extends',
},
jest: {
babel: {
addPresets: true,
addPlugins: true,
},
},
};
const moduleName = 'craco';
const explorer = cosmiconfigSync(moduleName, {
searchPlaces: [
'package.json',
`${moduleName}.config.ts`,
`${moduleName}.config.js`,
`${moduleName}.config.cjs`,
`.${moduleName}rc.ts`,
`.${moduleName}rc.js`,
`.${moduleName}rc`,
],
loaders: {
'.ts': tsLoader(),
},
});
function ensureConfigSanity(cracoConfig: CracoConfig) {
if (cracoConfig.plugins && isArray(cracoConfig.plugins)) {
cracoConfig.plugins.forEach((x, index) => {
if (!x.plugin) {
throw new Error(
`craco: Malformed plugin at index: ${index} of 'plugins'.`
);
}
});
}
}
export function processCracoConfig(
cracoConfig: CracoConfig,
context: BaseContext
) {
const resultingCracoConfig = deepMergeWithArray(
{},
DEFAULT_CONFIG,
cracoConfig
);
ensureConfigSanity(resultingCracoConfig);
return applyCracoConfigPlugins(resultingCracoConfig, context);
}
function getConfigPath() {
const args = getArgs();
if (args.config && isString(args.config)) {
return path.resolve(projectRoot, args.config);
} else {
const packageJsonPath = path.join(projectRoot, 'package.json');
const packageJson = require(packageJsonPath);
if (packageJson.cracoConfig && isString(packageJson.cracoConfig)) {
// take it as the path to the config file if it's path-like, otherwise assume it contains the config content below
return path.resolve(projectRoot, packageJson.cracoConfig);
} else {
const result = explorer.search(projectRoot);
if (result === null) {
throw new Error(
'craco: Config file not found. check if file exists at root (craco.config.ts, craco.config.js, .cracorc.js, .cracorc.json, .cracorc.yaml, .cracorc)'
);
}
return result.filepath;
}
}
}
function getConfigAsObject(context: BaseContext) {
const configFilePath = getConfigPath();
log('Config file path resolved to: ', configFilePath);
const result = explorer.load(configFilePath);
const configAsObject = isFunction(result?.config)
? result?.config(context)
: result?.config;
if (!configAsObject) {
throw new Error("craco: Config function didn't return a config object.");
}
return configAsObject;
}
export function loadCracoConfig(context: BaseContext) {
const configAsObject = getConfigAsObject(context);
if (configAsObject instanceof Promise) {
throw new Error(
'craco: Config function returned a promise. Use `loadCracoConfigAsync` instead of `loadCracoConfig`.'
);
}
return processCracoConfig(configAsObject, context);
}
// The "build", "start", and "test" scripts use this to wait for any promises to resolve before they run.
export async function loadCracoConfigAsync(context: BaseContext) {
const configAsObject = await getConfigAsObject(context);
if (!configAsObject) {
throw new Error("craco: Async config didn't return a config object.");
}
return processCracoConfig(configAsObject, context);
}
================================================
FILE: packages/craco/src/lib/cra.ts
================================================
import type {
CracoConfig,
CraPaths,
DevServerConfigProvider,
JestConfigProvider,
} from '@craco/types';
import type { Configuration as WebpackConfig } from 'webpack';
import path from 'path';
import semver from 'semver';
import { log } from './logger';
import { projectRoot } from './paths';
let envLoaded = false;
const CRA_LATEST_SUPPORTED_MAJOR_VERSION = '5.0.0';
/************ Common ************/
function resolveConfigFilePath(cracoConfig: CracoConfig, fileName: string) {
if (!envLoaded) {
// Environment variables must be loaded before the CRA paths, otherwise they will not be applied.
require(resolveConfigFilePathInner(cracoConfig, 'env.js'));
envLoaded = true;
}
return resolveConfigFilePathInner(cracoConfig, fileName);
}
function resolveConfigFilePathInner(
cracoConfig: CracoConfig,
fileName: string
) {
return require.resolve(
path.join(
cracoConfig.reactScriptsVersion ?? 'react-scripts',
'config',
fileName
),
{ paths: [projectRoot] }
);
}
function resolveScriptsFilePath(cracoConfig: CracoConfig, fileName: string) {
return require.resolve(
path.join(
cracoConfig.reactScriptsVersion ?? 'react-scripts',
'scripts',
fileName
),
{ paths: [projectRoot] }
);
}
function resolveReactDevUtilsPath(fileName: string) {
return require.resolve(path.join('react-dev-utils', fileName), {
paths: [projectRoot],
});
}
function overrideModule(modulePath: string, newModule: any) {
if (!require.cache[modulePath]) {
throw new Error(`Module not found: ${modulePath}`);
}
require.cache[modulePath]!.exports = newModule;
log(`Overrode require cache for module: ${modulePath}`);
}
function resolvePackageJson(cracoConfig: CracoConfig) {
return require.resolve(
path.join(
cracoConfig.reactScriptsVersion ?? 'react-scripts',
'package.json'
),
{ paths: [projectRoot] }
);
}
export function getReactScriptVersion(cracoConfig: CracoConfig) {
const reactScriptPackageJsonPath = resolvePackageJson(cracoConfig);
const { version } = require(reactScriptPackageJsonPath);
return {
version,
isSupported: semver.gte(version, CRA_LATEST_SUPPORTED_MAJOR_VERSION),
};
}
/************ Paths ************/
let _resolvedCraPaths: any = null;
export function getCraPathsPath(cracoConfig: CracoConfig) {
return resolveConfigFilePath(cracoConfig, 'paths.js');
}
export function getCraPaths(cracoConfig: CracoConfig) {
if (!_resolvedCraPaths) {
_resolvedCraPaths = require(getCraPathsPath(cracoConfig));
}
return _resolvedCraPaths;
}
export function overrideCraPaths(
cracoConfig: CracoConfig,
newConfig?: CraPaths
) {
overrideModule(getCraPathsPath(cracoConfig), newConfig);
log('Overrode CRA paths config.');
}
/************ Webpack Dev Config ************/
function getWebpackDevConfigPath(cracoConfig: CracoConfig) {
try {
return {
filepath: resolveConfigFilePath(cracoConfig, 'webpack.config.js'),
isLegacy: false,
};
} catch (e) {
return {
filepath: resolveConfigFilePath(cracoConfig, 'webpack.config.dev.js'),
isLegacy: true,
};
}
}
export function loadWebpackDevConfig(cracoConfig: CracoConfig): WebpackConfig {
const result = getWebpackDevConfigPath(cracoConfig);
log('Found Webpack dev config at: ', result.filepath);
if (result.isLegacy) {
return require(result.filepath);
}
return require(result.filepath)('development');
}
export function overrideWebpackDevConfig(
cracoConfig: CracoConfig,
newConfig: WebpackConfig
) {
const result = getWebpackDevConfigPath(cracoConfig);
if (result.isLegacy) {
overrideModule(result.filepath, newConfig);
} else {
overrideModule(result.filepath, () => newConfig);
}
log('Overrode Webpack dev config.');
}
/************ Webpack Prod Config ************/
function getWebpackProdConfigPath(cracoConfig: CracoConfig) {
try {
return {
filepath: resolveConfigFilePath(cracoConfig, 'webpack.config.js'),
isLegacy: false,
};
} catch (e) {
return {
filepath: resolveConfigFilePath(cracoConfig, 'webpack.config.prod.js'),
isLegacy: true,
};
}
}
export function loadWebpackProdConfig(cracoConfig: CracoConfig): WebpackConfig {
const result = getWebpackProdConfigPath(cracoConfig);
log('Found Webpack prod config at: ', result.filepath);
if (result.isLegacy) {
return require(result.filepath);
}
return require(result.filepath)('production');
}
export function overrideWebpackProdConfig(
cracoConfig: CracoConfig,
newConfig: WebpackConfig
) {
const result = getWebpackProdConfigPath(cracoConfig);
if (result.isLegacy) {
overrideModule(result.filepath, newConfig);
} else {
overrideModule(result.filepath, () => newConfig);
}
log('Overrode Webpack prod config.');
}
/************ Dev Server Config ************/
function getDevServerConfigPath(cracoConfig: CracoConfig) {
return resolveConfigFilePath(cracoConfig, 'webpackDevServer.config.js');
}
function getDevServerUtilsPath() {
return resolveReactDevUtilsPath('WebpackDevServerUtils.js');
}
export function loadDevServerConfigProvider(
cracoConfig: CracoConfig
): DevServerConfigProvider {
const filepath = getDevServerConfigPath(cracoConfig);
log('Found dev server config at: ', filepath);
return require(filepath);
}
export function overrideDevServerConfigProvider(
cracoConfig: CracoConfig,
configProvider: any
) {
const filepath = getDevServerConfigPath(cracoConfig);
overrideModule(filepath, configProvider);
log('Overrode dev server config provider.');
}
export function loadDevServerUtils() {
const filepath = getDevServerUtilsPath();
log('Found dev server utils at: ', filepath);
return require(filepath);
}
export function overrideDevServerUtils(newUtils: any) {
const filepath = getDevServerUtilsPath();
overrideModule(filepath, newUtils);
log('Overrode dev server utils.');
}
/************ Jest Config ************/
function getCreateJestConfigPath(cracoConfig: CracoConfig) {
return resolveScriptsFilePath(cracoConfig, 'utils/createJestConfig.js');
}
// https://github.com/facebook/create-react-app/blob/main/packages/react-scripts/scripts/utils/createJestConfig.js
export function loadJestConfigProvider(
cracoConfig: CracoConfig
): JestConfigProvider {
const filepath = getCreateJestConfigPath(cracoConfig);
log('Found jest config at: ', filepath);
return require(filepath);
}
export function overrideJestConfigProvider(
cracoConfig: CracoConfig,
configProvider: any
) {
const filepath = getCreateJestConfigPath(cracoConfig);
overrideModule(filepath, configProvider);
log('Overrode Jest config provider.');
}
/************ Scripts *******************/
export function start(cracoConfig: CracoConfig) {
const filepath = resolveScriptsFilePath(cracoConfig, 'start.js');
log('Starting CRA at: ', filepath);
require(filepath);
}
export function build(cracoConfig: CracoConfig) {
const filepath = resolveScriptsFilePath(cracoConfig, 'build.js');
log('Building CRA at: ', filepath);
require(filepath);
}
export function test(cracoConfig: CracoConfig) {
const filepath = resolveScriptsFilePath(cracoConfig, 'test.js');
log('Testing CRA at: ', filepath);
require(filepath);
}
================================================
FILE: packages/craco/src/lib/features/dev-server/api.ts
================================================
import type { CracoConfig, DevServerContext } from '@craco/types';
import type { CliArgs } from '../../args';
import { setArgs } from '../../args';
import { processCracoConfig } from '../../config';
import { getCraPaths } from '../../cra';
import { isFunction } from '../../utils';
import { createConfigProviderProxy } from './create-config-provider-proxy';
export function createDevServerConfigProviderProxy(
callerCracoConfig: CracoConfig,
callerContext: DevServerContext,
options: CliArgs
) {
if (!callerCracoConfig) {
throw new Error("craco: 'cracoConfig' is required.");
}
if (isFunction(callerCracoConfig)) {
throw new Error("craco: 'cracoConfig' should be an object.");
}
if (!process.env.NODE_ENV) {
process.env.NODE_ENV = 'development';
}
setArgs(options);
const context: DevServerContext = {
env: process.env.NODE_ENV,
...callerContext,
};
const cracoConfig = processCracoConfig(callerCracoConfig, context);
context.paths = getCraPaths(cracoConfig);
const proxy = createConfigProviderProxy(cracoConfig, context);
return proxy;
}
================================================
FILE: packages/craco/src/lib/features/dev-server/create-config-provider-proxy.ts
================================================
import type {
CracoConfig,
DevServerContext,
DevServerConfigProvider,
} from '@craco/types';
import type { Configuration as DevServerConfig } from 'webpack-dev-server';
import merge from 'webpack-merge';
import { loadDevServerConfigProvider } from '../../cra';
import { log } from '../../logger';
import { isFunction } from '../../utils';
import { applyDevServerConfigPlugins } from '../plugins';
import { setEnvironmentVariables } from './set-environment-variables';
function createProxy(
cracoConfig: CracoConfig,
craDevServerConfigProvider: DevServerConfigProvider,
context: DevServerContext
) {
const proxy = (proxy: any, allowedHost: string) => {
let devServerConfig = craDevServerConfigProvider(proxy, allowedHost);
if (isFunction(cracoConfig.devServer)) {
devServerConfig = cracoConfig.devServer(devServerConfig, {
...context,
proxy,
allowedHost,
});
if (!devServerConfig) {
throw new Error(
"craco: 'devServer' function didn't return a config object."
);
}
} else {
// TODO: ensure is otherwise a plain object, if not, log an error.
devServerConfig = merge