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

Package detail

@tom_yeoman/react-scripts

TomYeoman3MIT1.1.1

Configuration and scripts for Create React App.

readme

react-scripts

This package includes scripts and configuration used by Create React App.
Please refer to its documentation:

changelog

1.1.0 (January 15, 2018)

:rocket: New Feature

  • react-scripts

    • #3387 Add support for variable expansion in .env files. (@moos)

  • react-error-overlay

    • #3474 Allow the error overlay to be unregistered. (@Timer)

  • create-react-app

:bug: Bug Fix

  • babel-preset-react-app, react-scripts

    • #3788 Fix object destructuring inside an array on Node 6. (@gaearon)

  • react-dev-utils

  • create-react-app

  • react-scripts

    • #3537 Add mjs and jsx filename extensions to file-loader exclude pattern. (@iansu)
    • #3511 Unmount the component in the default generated test. (@gaearon)

:nail_care: Enhancement

  • react-scripts

  • create-react-app

  • react-dev-utils

  • react-dev-utils, react-error-overlay

  • react-dev-utils, react-scripts

    • #3721 Support setting none in REACT_EDITOR environment variable. (@raerpo)

  • eslint-config-react-app

:memo: Documentation

:house: Internal

Committers: 47

Migrating from 1.0.17 to 1.1.0

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.1.0

or

yarn add --exact react-scripts@1.1.0

1.0.17 (November 3, 2017)

:nail_care: Enhancement

:memo: Documentation

Committers: 3

Migrating from 1.0.16 to 1.0.17

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.17

or

yarn add --exact react-scripts@1.0.17

1.0.16 (October 31, 2017) 🎃

:bug: Bug Fix

  • react-scripts

    • #3374 Set correct image type and sizes in manifest.json. (@piotr-cz)

  • react-dev-utils

    • #3368 Fix a crash in development mode in older browsers. (@felthy)

Committers: 2

Migrating from 1.0.15 to 1.0.16

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.16

or

yarn add --exact react-scripts@1.0.16

1.0.15 (October 30, 2017)

:bug: Bug Fix

  • react-scripts

  • react-dev-utils, react-scripts

    • #3230 Fix watching for changes in src/node_modules. (@xjlim)

:nail_care: Enhancement

  • react-scripts

  • babel-preset-react-app, react-dev-utils, react-error-overlay, react-scripts

  • react-dev-utils, react-error-overlay

  • create-react-app

    • #3355 Add preflight CWD check for npm to detect bad Windows setups. (@gaearon)

:memo: Documentation

:house: Internal

  • Other

  • react-error-overlay

    • #3122 Fix for add .gitattributes file #3080. (@ijajmulani)
    • #3267 Use production React version for bundled overlay. (@Timer)
    • #3264 Add warning when using react-error-overlay in production. (@Timer)
    • #3263 react-error-overlay has no dependencies now (it's bundled). (@Timer)
    • #3142 Make error overlay run in the context of the iframe. (@tharakawj)

  • react-scripts

    • #3150 Remove an useless negation in registerServiceWorker.js. (@dunglas)
    • #3158 Remove output.path from dev webpack config. (@nikolas)
    • #3281 Add a workaround for Uglify incompatiblity with Safari 10.0 in the future. (@satyavh)
    • #3146 Fix reason-react support. (@lpalmes)
    • #3236 Update style-loader and disable inclusion of its HMR code in builds. (@insin)
    • #3246 Update url-loader to 0.6.2 for mime ReDoS vulnerability. (@d3viant0ne)
    • #2914 <!doctype html> -> <!DOCTYPE html>. (@Hurtak)

Committers: 24

Migrating from 1.0.14 to 1.0.15

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.15

or

yarn add --exact react-scripts@1.0.15

1.0.14 (September 26, 2017)

:bug: Bug Fix

  • react-dev-utils

    • #3098 Always reload the page on next compile after a runtime error. (@Timer)

  • react-error-overlay

:nail_care: Enhancement

  • react-dev-utils

    • #3077 Auto-detect running editor on Linux for error overlay. (@gulderov)

    • #3131 Display process pid in already running message. (@Pajn)

:memo: Documentation

:house: Internal

  • react-scripts

  • react-error-overlay

    • #3065 Updated react-error-overlay to latest Flow (0.54.0). (@duvet86)

    • #3102 Clean target directory before compiling overlay. (@Timer)

  • create-react-app, react-dev-utils, react-error-overlay, react-scripts

Committers: 12

Migrating from 1.0.13 to 1.0.14

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.14

or

yarn add --exact react-scripts@1.0.14

1.0.13 (September 2, 2017)

:bug: Bug Fix

  • react-error-overlay

    • #3051 Fix case-sensitivity issue with upgrading the package version. (@tharakawj)

  • react-dev-utils

  • react-scripts

:nail_care: Enhancement

  • react-scripts

    • #3033 Add an empty mock for child_process to let some libraries compile. (@McFlurriez)

:house: Internal

  • react-dev-utils, react-error-overlay

Committers: 4

Migrating from 1.0.12 to 1.0.13

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.13

or

yarn add --exact react-scripts@1.0.13

1.0.12 (August 28, 2017)

:bug: Bug Fix

  • react-error-overlay

  • react-dev-utils

:nail_care: Enhancement

:memo: Documentation

:house: Internal

  • react-error-overlay, react-scripts

  • react-dev-utils, react-error-overlay, react-scripts

Committers: 9

Migrating from 1.0.11 to 1.0.12

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.12

or

yarn add --exact react-scripts@1.0.12

Note: there’s a known issue that might cause the project to not compile after upgrading. In this case, migrate straight to 1.0.13 which doesn’t have this issue.

1.0.11 (August 9, 2017)

:bug: Bug Fix

  • create-react-app

    • #2884 Improve offline heuristic for proxied environments. (@bsyk)

      When a Yarn proxy is set, we will check its connectivity if we cannot reach Yarn's registry. This is often the case when DNS lookups must be made through the proxy.

    • #2853 Allow use of scoped packages with a pinned version. (@wileybenet)

  • react-dev-utils

    • #2796 Properly escape HTML tags in error overlay. (@ccloli)

      Elements printed in their entirety would sometimes render as HTML. This should no longer happen and should properly render as text.

  • react-dev-utils, react-scripts

  • react-scripts

:nail_care: Enhancement

  • react-scripts

    • #2818 Allow sourcemaps to be disabled. (@viankakrisna)

      As applications grow more complex, it is possible webpack may run out of memory while generating source maps. They may now be disabled by setting GENERATE_SOURCEMAP=false.

    • #2913 Allow flags to be passed to node when running react-scripts. (@koistya)

    • #2574 Upgrade to webpack@3. (@themre)
    • #2747 Simplify webpack configuration using Rule.oneOf. (@Furizaa)
  • react-dev-utils, react-scripts
  • create-react-app
    • #2785 Change error wording and list conflicting files when initializing app. (@OwenFlood)
  • react-dev-utils
  • eslint-config-react-app, react-scripts
  • eslint-config-react-app

:memo: Documentation

:house: Internal

  • create-react-app, eslint-config-react-app, react-dev-utils, react-error-overlay, react-scripts
  • eslint-config-react-app
  • Other
  • react-scripts

Committers: 26

Migrating from 1.0.10 to 1.0.11

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.11

or

yarn add --exact react-scripts@1.0.11

1.0.10 (June 29, 2017)

:bug: Bug Fix

:memo: Documentation

Committers: 5

Migrating from 1.0.9 to 1.0.10

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.10

or

yarn add --exact react-scripts@1.0.10

1.0.9 (June 29, 2017)

:bug: Bug Fix

:memo: Documentation

:house: Internal

Committers: 5

Migrating from 1.0.8 to 1.0.9

Inside any created project that has not been ejected, run:

npm install --save --save-exact react-scripts@1.0.9

or

yarn add --exact react-scripts@1.0.9

1.0.8 (June 28, 2017)

:bug: Bug Fix

:nail_care: Enhancement

  • react-scripts

  • babel-preset-react-app, react-dev-utils, react-scripts

  • create-react-app, react-scripts

  • react-dev-utils

    • #2637 Auto-detect Brackets editor from error overlay. (@petetnt)
    • #2552 Auto-detect running editor on Windows for error overlay. (@levrik)
    • #2622 Support opening PhpStorm for error overlay. (@miraage)
    • #2414 Support opening WebStorm 2017+ from error overlay. (@wirmar)
    • #2518 Warn when trying to run on port below 1024 without admin permissions under Linux/macOS. (@levrik)
    • #2385 Suggest just yarn build in output. (@gaearon)

  • create-react-app

:memo: Documentation

:house: Internal

Committers: 46

Migrating from 1.0.7 to 1.0.8

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.8

or

yarn add --dev --exact react-scripts@1.0.8

If you previously used HTTPS=true environment variable in development, make sure you aren't affected by a now-fixed vulnerability in Webpack by visiting this page. You can read more about the vulnerability here.

You may optionally then move react-scripts from devDependencies to dependencies since that’s how we’ll structure newly created projects. It is not necessary though.

If you left the service worker integration enabled and didn’t change how it works, you can replace src/registerServiceWorker.js with this updated version.

If you haven't changed the default CSS organization, you may want to apply this fix that makes index.css take precedence over App.css in your project.

1.0.7 (May 27, 2017)

:bug: Bug Fix

  • react-scripts

:nail_care: Enhancement

  • react-scripts

  • react-dev-utils, react-scripts

:memo: Documentation

Committers: 6

Migrating from 1.0.6 to 1.0.7

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.7

or

yarn add --dev --exact react-scripts@1.0.7

1.0.6 (May 24, 2017)

:bug: Bug Fix

  • eslint-config-react-app, react-error-overlay, react-scripts

  • react-dev-utils

    • #2332 Fix proxying issues with backends that don't support IPv6. (@Timer)

:nail_care: Enhancement

  • react-scripts

:memo: Documentation

Committers: 4

Migrating from 1.0.5 to 1.0.6

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.6

or

yarn add --dev --exact react-scripts@1.0.6

1.0.5 (May 22, 2017)

:bug: Bug Fix

  • react-dev-utils, react-scripts

    • #2326 Files in public/ folder should not be requested through proxy. (@gaearon)

:nail_care: Enhancement

  • react-dev-utils

  • eslint-config-react-app

    • #2325 Allow declaring variables before use in a scope above. (@gaearon)

:house: Internal

  • react-dev-utils, react-scripts

Committers: 2

Migrating from 1.0.4 to 1.0.5

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.5

or

yarn add --dev --exact react-scripts@1.0.5

1.0.4 (May 22, 2017)

:bug: Bug Fix

  • react-error-overlay
    • Fix a regression in published package.

Migrating from 1.0.3 to 1.0.4

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.4

or

yarn add --dev --exact react-scripts@1.0.4

1.0.3 (May 21, 2017)

:bug: Bug Fix

  • react-dev-utils

    • #2297 Don’t serve the development version from public IPs by default. (@Timer)

  • eslint-config-react-app

    • #2311 Disable flowtype/require-valid-file-annotation lint rule due to false positives. (@Robdel12)

  • react-dev-utils, react-error-overlay

  • react-scripts

Committers: 4

Migrating from 1.0.2 to 1.0.3

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.3

or

yarn add --dev --exact react-scripts@1.0.3

1.0.2 (May 20, 2017)

:bug: Bug Fix

  • react-dev-utils, react-scripts

    • #2276 Serve a no-op service worker in development to ensure it doesn't cache the production build even if it was served on the same port. (@jeffposnick)

  • react-dev-utils, react-error-overlay

  • react-dev-utils

:nail_care: Enhancement

  • react-scripts

:house: Internal

  • react-dev-utils, react-scripts

Committers: 6

Migrating from 1.0.1 to 1.0.2

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.2

or

yarn add --dev --exact react-scripts@1.0.2

If you previously had issues with an Invalid Host Header error, follow these new instructions to fix it.

1.0.1 (May 19, 2017)

:bug: Bug Fix

  • react-scripts

  • react-dev-utils

    • #2229 Show customized build path for serve instruction. (@chyipin)

  • react-dev-utils, react-error-overlay

  • react-error-overlay

    • #2238 Fix a crash when switching errors with arrow keys. (@Gandem)

:nail_care: Enhancement

  • eslint-config-react-app

  • react-scripts

:memo: Documentation

:house: Internal

Committers: 9

Migrating from 1.0.0 to 1.0.1

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.1

or

yarn add --dev --exact react-scripts@1.0.1

1.0.0 (May 18, 2017)

We’ve been working on this release for the past few months, and there are many big impovements, from migrating to webpack 2 to a brand new runtime error overlay and built-in support for Progressive Web Apps.

So instead of just enumerating them here, we decided to write a blog post about all the new features.
Check it out: What’s New in Create React App.

Have you read it? Now let's see how to update your app to the latest version.

Migrating from 0.9.5 to 1.0.0

First, ensure you are using the latest Node 6 LTS or newer. In 1.0.0, we have dropped support for Node 4 and NPM 2.

Inside any created project that has not been ejected, run:

npm install --save-dev --save-exact react-scripts@1.0.0

You may also optionally update the global command-line utility for bug fixes:

npm install -g create-react-app

Ensure application and test files reside in src/

We've never supported importing files from outside src/, nor have we supported running tests outside of src/.
We also never explicitly forbid doing so, which caused confusion when things didn't work like they should.

When running or building your application, you may see a message like so:

You attempted to import ... which falls outside of the project src/ directory.

To remedy this, simply move any files that you import within src/ and update your relative imports accordingly. This enforces that files that import each other stay in src/, and other folders serve different purposes (e.g. the public/ folder just gets served from the root).

If you used relative imports outside the project directory as a way to share code with another project, consider using a monorepo instead, so that other projects are symlinked to your project's node_modules/. Then you can import them as a Node modules.

While running npm test, you may notice some of your tests are missing. Please move any top-level test directory (i.e. __test__, __spec__) or files (i.e. *.test.js, *.spec.js) into src/. Conversely, if you have some similarly named files that you don’t want Jest to run, move them outside of src/.

Import required locales for Moment.js

Moment.js locales are now purposely excluded from the bundle unless explicitly depended on.

Please import the locales you need:

import moment from 'moment';
import 'moment/locale/fr';
import 'moment/locale/es';

You can no longer import file content

You can no longer import a file and expect to receive its contents as an encoded string.
This behavior was confusing and inconsistent depending on the file size.

Importing files with unknown extensions will now always include them into the build and return a valid URL.

If you'd like to import a file's contents as a string, consider contributing to #1944. For the time being, you must embed assets within an export:

// sample.txt
export default `i want
this data as a string
`;

You can then import this as so:

import sampleText from './sample.txt';

// ...

Confusing window globals can no longer be used without window qualifier

Please prefix any global method with window., you may experience this with methods such as confirm.

Simply update references from confirm to window.confirm.

Note that this new lint error will likely uncover legitimate accidental uses of global variables where you meant to define a local variable instead.

Why is my import erroring out?

You can no longer use AMD import syntax, nor define an import anywhere other than the top of the file.

This is to reduce confusion around import statements, which do not allow you to evaluate code between them.

I see many accessibility warnings

We have enabled a new set of rules to help make applications more accessible, please take time to learn about the errors and fix them.

You can search for every lint rule name in the right column and read its description on the web. The fixes are usually very simple.

I see many warnings about PropTypes and createClass

We have enabled the lint warnings about React APIs deprecated in React 15.5. You can automatically convert your project to fix them by running the corresponding codemods.

How do I make my tests work with Jest 20?

Please refer to the Jest 19 and Jest 20 breaking changes for migration instructions.

If you use snapshots, you will likely need to update them once because of the change in format.

Flexbox 2009 spec is no longer polyfilled

The old, 2009 specification for Flexbox is deprecated and is 2.3x slower than the latest specification.

We are no longer polyfilling it automatically.

I see "Definition for rule 'jsx-a11y/alt-text' was not found (jsx-a11y/alt-text)" in the editor

Follow these steps if you see errors about missing lint rules in the editor.

  1. Ensure that in your editor ESLint settings you have "Use Global ESLint" turned off
  2. Run npm install in your project (or yarn)
  3. Quit your editor completely (ensure its process doesn't hang around)
  4. Start the editor again

If you still have the problem please file an issue.

Some of my tests started crashing because of unhandled rejections

Unhandled Promise rejections will now crash tests. You can fix them by explicitly catching the errors you don’t care about.

How to turn my app into a Progressive Web App?

After the regular update procedure above, add these line to <head> in public/index.html:

    <meta name="theme-color" content="#000000">
    <!--
      manifest.json provides metadata used when your web app is added to the
      homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
    -->
    <link rel="manifest" href="%PUBLIC_URL%/manifest.json">

Then create a file called public/manifest.json that looks like this:

{
  "short_name": "React App",
  "name": "Create React App Sample",
  "icons": [
    {
      "src": "favicon.ico",
      "sizes": "192x192",
      "type": "image/png"
    }
  ],
  "start_url": "./index.html",
  "display": "standalone",
  "theme_color": "#000000",
  "background_color": "#ffffff"
}

Finally, create src/registerServiceWorker.js with this template, import it from src/index.js and call the function it exports.

Anything missing?

This was a large release, and we might have missed something.

Please file an issue and we will try to help.

Detailed Changelog

For a readable summary of the changes, check out our blog post.

:boom: Breaking Change

  • react-dev-utils, react-scripts
    • #2189 Add ModuleScopePlugin to ensure files reside in src/. (@Timer)
  • react-scripts
  • eslint-config-react-app, react-dev-utils
  • eslint-config-react-app, react-error-overlay, react-scripts
  • eslint-config-react-app, react-scripts

:rocket: New Feature

  • react-scripts
  • react-dev-utils, react-scripts
    • #1101 Add react-error-overlay, our new crash overlay. (@Timer)
    • #1590 Support specifying a node script as BROWSER environment variable. (@GAumala)
    • #1790 Support multiple proxies in development. (@jamesblight)
  • eslint-config-react-app, react-scripts

:bug: Bug Fix

:nail_care: Enhancement

:memo: Documentation

:house: Internal

Committers: 66

Releases Before 0.x

Please refer to CHANGELOG-0.x.md for earlier versions.