Skip to content

Commit 52572ae

Browse files
committed
add docs for SKIP_PREFLIGHT_CHECK
Adds entry in docusaurus site. Provides additional context in `verifyPackageTree` error messaging. Closes facebook#11119.
1 parent 0ee4765 commit 52572ae

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docusaurus/docs/advanced-configuration.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ You can adjust various development and production settings by setting environmen
2424
| CHOKIDAR_USEPOLLING | ✅ Used | 🚫 Ignored | When set to `true`, the watcher runs in polling mode, as necessary inside a VM. Use this option if `npm start` isn't detecting changes. |
2525
| GENERATE_SOURCEMAP | 🚫 Ignored | ✅ Used | When set to `false`, source maps are not generated for a production build. This solves out of memory (OOM) issues on some smaller machines. |
2626
| INLINE_RUNTIME_CHUNK | 🚫 Ignored | ✅ Used | By default, Create React App will embed the runtime script into `index.html` during the production build. When set to `false`, the script will not be embedded and will be imported as usual. This is normally required when dealing with CSP. |
27-
| IMAGE_INLINE_SIZE_LIMIT | ✅ Used | ✅ Used | By default, images smaller than 10,000 bytes are encoded as a data URI in base64 and inlined in the CSS or JS build artifact. Set this to control the size limit in bytes. Setting it to `0` will disable the inlining of images. |
27+
| IMAGE_INLINE_SIZE_LIMIT | ✅ Used | ✅ Used | By default, images smaller than 10,000 bytes are encoded as a data URI in base64 and inlined in the CSS or JS build artifact. Set this to control the size limit in bytes. Setting it to `0` will disable the inlining of images. |
2828
| FAST_REFRESH | ✅ Used | 🚫 Ignored | When set to `false`, disables experimental support for Fast Refresh to allow you to tweak your components in real time without reloading the page. |
2929
| TSC_COMPILE_ON_ERROR | ✅ Used | ✅ Used | When set to `true`, you can run and properly build TypeScript projects even if there are TypeScript type check errors. These errors are printed as warnings in the terminal and/or browser console. |
3030
| ESLINT_NO_DEV_ERRORS | ✅ Used | 🚫 Ignored | When set to `true`, ESLint errors are converted to warnings during development. As a result, ESLint output will no longer appear in the error overlay. |
3131
| DISABLE_ESLINT_PLUGIN | ✅ Used | ✅ Used | When set to `true`, [eslint-webpack-plugin](https://github.com/webpack-contrib/eslint-webpack-plugin) will be completely disabled. |
3232
| DISABLE_NEW_JSX_TRANSFORM | ✅ Used | ✅ Used | When set to `true`, disables the [new JSX transform](https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html) introduced in React 17 and backported to React 16.14.0, 15.7.0, and 0.14.10. New projects will use a version of React that supports this by default but you may need to disable it in existing projects if you can't upgrade React. |
33+
| SKIP_PREFLIGHT_CHECK | ✅ Used | 🚫 Ignored | By default, Create React App will scan your dependency tree for version mismatches likely to break your setup. When set to `false`, the scan is skipped. In non-traditional project setups (<tt>lerna</tt>, <tt>yarn workspaces</tt>), this can generate false positives. |

packages/react-scripts/scripts/utils/verifyPackageTree.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,8 @@ function verifyPackageTree() {
9999
` ${chalk.bold(chalk.red(maybeDep))} (version: ${chalk.bold(
100100
chalk.red(depPackageJson.version)
101101
)}) \n\n` +
102-
`Manually installing incompatible versions is known to cause hard-to-debug issues.\n\n` +
102+
`Manually installing incompatible versions is known to cause hard-to-debug issues.\n` +
103+
`If you are using Create React App in a multi-project setup, you may want to ignore this check.\n\n` +
103104
chalk.red(
104105
`If you would prefer to ignore this check, add ${chalk.bold(
105106
'SKIP_PREFLIGHT_CHECK=true'

0 commit comments

Comments
 (0)