diff --git a/.travis.yml b/.travis.yml index 860000b5c9b..803595b1532 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,3 +26,10 @@ matrix: env: TEST_SUITE=old-node - node_js: 6 env: TEST_SUITE=kitchensink +notifications: + slack: + rooms: + secure: bhPLCxVEdmUTTaIwkmZMBBHtJVfSmdCS0feVgRdWLcAOhiSfAkwBhf42kZfovc1fwGxIeRukDERehzC8SqmRAX0U2o9aNuY+NyXWasWzFQlR2Dz2M5HPI0k1Qp8dMdPXQTr4GfQ+hsgpSzySnObjvdwchHNpDZDBsdEIUm6ppNvdYJA9E3BO8o7CNZyDiWNhJt47jx5u3Xh+g0iXix45wuMlLuZjnjXsSkFx39NPlLGsSCh4nTalJbpyB9Txh9zjBO4KCL0PoggFC8WGCoM9G73gn/oXie20nIX+NOMaAkGyN7aG0VxrVb5mAB4puhC+u2oPJRKc85REL2MRRcMLv8AC+/6nlXMjIF5WS2MhWKrejQlccO9lqqapsdDMENYx9+Oaxs4QDdQA1Hxd4J9eWBSwAO7xrhN2sTaUiOguEp+yX3EYWUtF1WtIU3NtxB6TTvOvbGHzJYcBJvU0zIywR4tik6HQuv6ZiC0+H50yfT9mm8KmVn0zdJ4O20QO7Fa+/WBpVMGHJLxLEP7Hj1I7cTOYE/B/5Dj8ABTUUoKV/q4hY24FcfQ3rLqFmbQxWdder95oiMh1TYtdP2c44m2E1BkmwUzjtJZCoxJOEKgjAaGdEA2+OxSuAIUmUhcJ6X0cSyll8OgyoOXiNQoHhrNMv/y9FxUvGdKDgX2uH96t8pE= + on_pull_requests: false + on_success: always + on_failure: change \ No newline at end of file diff --git a/README.md b/README.md index b09630e90ba..6dbb6406b2d 100644 --- a/README.md +++ b/README.md @@ -1,224 +1,15 @@ -# Create React App [![Build Status](https://travis-ci.org/facebookincubator/create-react-app.svg?branch=master)](https://travis-ci.org/facebookincubator/create-react-app) +# `backpack-react-scripts` [![Build Status](https://travis-ci.org/Skyscanner/backpack-react-scripts.svg?branch=fork)](https://travis-ci.org/Skyscanner/backpack-react-scripts) -Create React apps with no build configuration. +**This is a fork of Facebook's [Create React App](https://github.com/facebook/create-react-app).** -* [Creating an App](#creating-an-app) – How to create a new app. -* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. +Files of interest: + - [README](packages/react-scripts/README.md) + - [CHANGELOG](packages/react-scripts/CHANGELOG.md) -Create React App works on macOS, Windows, and Linux.
-If something doesn’t work, please [file an issue](https://github.com/facebookincubator/create-react-app/issues/new). +Note that this repo also contains the following packages: + - [babel-preset-react-app](packages/babel-preset-react-app/) + - [create-react-app](packages/create-react-app/) + - [eslint-config-react-app](packages/eslint-config-react-app/) + - [react-dev-utils](packages/react-dev-utils/) + - [react-error-overlay](packages/react-error-overlay/) -## Quick Overview - -```sh -npx create-react-app my-app -cd my-app -npm start -``` - -*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))* - -Then open [http://localhost:3000/](http://localhost:3000/) to see your app.
-When you’re ready to deploy to production, create a minified bundle with `npm run build`. - -

- -

- -### Get Started Immediately - -You **don’t** need to install or configure tools like Webpack or Babel.
-They are preconfigured and hidden so that you can focus on the code. - -Just create a project, and you’re good to go. - -## Creating an App - -**You’ll need to have Node >= 6 on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to easily switch Node versions between different projects. - -To create a new app, run a single command: - -```sh -npx create-react-app my-app -``` - -*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))* - -It will create a directory called `my-app` inside the current folder.
-Inside that directory, it will generate the initial project structure and install the transitive dependencies: - -``` -my-app -├── README.md -├── node_modules -├── package.json -├── .gitignore -├── public -│ └── favicon.ico -│ └── index.html -│ └── manifest.json -└── src - └── App.css - └── App.js - └── App.test.js - └── index.css - └── index.js - └── logo.svg - └── registerServiceWorker.js -``` - -No configuration or complicated folder structures, just the files you need to build your app.
-Once the installation is done, you can open your project folder: - -```sh -cd my-app -``` - -Inside the newly created project, you can run some built-in commands: - -### `npm start` or `yarn start` - -Runs the app in development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will automatically reload if you make changes to the code.
-You will see the build errors and lint warnings in the console. - -Build errors - -### `npm test` or `yarn test` - -Runs the test watcher in an interactive mode.
-By default, runs tests related to files changed since the last commit. - -[Read more about testing.](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests) - -### `npm run build` or `yarn build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-By default, it also [includes a service worker](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) so that your app loads from local cache on future visits. - -Your app is ready to be deployed. - -## User Guide - -The [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) includes information on different topics, such as: - -- [Updating to New Releases](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#updating-to-new-releases) -- [Folder Structure](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#folder-structure) -- [Available Scripts](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#available-scripts) -- [Supported Browsers](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-browsers) -- [Supported Language Features and Polyfills](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#supported-language-features-and-polyfills) -- [Syntax Highlighting in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#syntax-highlighting-in-the-editor) -- [Displaying Lint Output in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#displaying-lint-output-in-the-editor) -- [Formatting Code Automatically](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#formatting-code-automatically) -- [Debugging in the Editor](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#debugging-in-the-editor) -- [Changing the Page ``](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#changing-the-page-title) -- [Installing a Dependency](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#installing-a-dependency) -- [Importing a Component](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#importing-a-component) -- [Code Splitting](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#code-splitting) -- [Adding a Stylesheet](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-stylesheet) -- [Post-Processing CSS](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#post-processing-css) -- [Adding a CSS Preprocessor (Sass, Less etc.)](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-css-preprocessor-sass-less-etc) -- [Adding Images, Fonts, and Files](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-images-fonts-and-files) -- [Using the `public` Folder](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-the-public-folder) -- [Using Global Variables](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-global-variables) -- [Adding Bootstrap](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-bootstrap) -- [Adding Flow](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-flow) -- [Adding a Router](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-a-router) -- [Adding Custom Environment Variables](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#adding-custom-environment-variables) -- [Can I Use Decorators?](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#can-i-use-decorators) -- [Fetching Data with AJAX Requests](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#fetching-data-with-ajax-requests) -- [Integrating with an API Backend](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#integrating-with-an-api-backend) -- [Proxying API Requests in Development](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#proxying-api-requests-in-development) -- [Using HTTPS in Development](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#using-https-in-development) -- [Generating Dynamic `<meta>` Tags on the Server](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#generating-dynamic-meta-tags-on-the-server) -- [Pre-Rendering into Static HTML Files](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#pre-rendering-into-static-html-files) -- [Running Tests](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests) -- [Debugging Tests](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#debugging-tests) -- [Developing Components in Isolation](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#developing-components-in-isolation) -- [Publishing Components to npm](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#publishing-components-to-npm) -- [Making a Progressive Web App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) -- [Analyzing the Bundle Size](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#analyzing-the-bundle-size) -- [Deployment](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#deployment) -- [Advanced Configuration](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#advanced-configuration) -- [Troubleshooting](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting) - -A copy of the user guide will be created as `README.md` in your project folder. - -## How to Update to New Versions? - -Please refer to the [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#updating-to-new-releases) for this and other information. - -## Philosophy - -* **One Dependency:** There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them. - -* **No Configuration Required:** You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code. - -* **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off. - -## What’s Included? - -Your environment will have everything you need to build a modern single-page React app: - -* React, JSX, ES6, and Flow syntax support. -* Language extras beyond ES6 like the object spread operator. -* Autoprefixed CSS, so you don’t need `-webkit` or other prefixes. -* A fast interactive unit test runner with built-in support for coverage reporting. -* A live development server that warns about common mistakes. -* A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps. -* An offline-first [service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) criteria. -* Hassle-free updates for the above tools with a single dependency. - -Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together. - -The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject) and customize it, but then you will need to maintain this configuration. - -## Popular Alternatives - -Create React App is a great fit for: - -* **Learning React** in a comfortable and feature-rich development environment. -* **Starting new single-page React applications.** -* **Creating examples** with React for your libraries and components. - -Here’s a few common cases where you might want to try something else: - -* If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html). - -* If you need to **integrate React code with a server-side template framework** like Rails or Django, or if you’re **not building a single-page app**, consider using [nwb](https://github.com/insin/nwb) or [Neutrino](https://neutrino.js.org/) which are more flexible. - -* If you need to **publish a React component**, [nwb](https://github.com/insin/nwb) can [also do this](https://github.com/insin/nwb#react-components-and-libraries), as well as [Neutrino's react-components preset](https://neutrino.js.org/packages/react-components/). - -* If you want to do **server rendering** with React and Node.js, check out [Next.js](https://github.com/zeit/next.js/) or [Razzle](https://github.com/jaredpalmer/razzle). Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles. - -* If your website is **mostly static** (for example, a portfolio or a blog), consider using [Gatsby](https://www.gatsbyjs.org/) instead. Unlike Create React App, it pre-renders the website into HTML at the build time. - -* If you want to use **TypeScript**, consider using [create-react-app-typescript](https://github.com/wmonk/create-react-app-typescript). - -* Finally, if you need **more customization**, check out [Neutrino](https://neutrino.js.org/) and its [React preset](https://neutrino.js.org/packages/react/). - -All of the above tools can work with little to no configuration. - -If you prefer configuring the build yourself, [follow this guide](https://reactjs.org/docs/add-react-to-an-existing-app.html). - -## Contributing - -We'd love to have your helping hand on `create-react-app`! See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started. - -## React Native - -Looking for something similar, but for React Native?<br> -Check out [Create React Native App](https://github.com/react-community/create-react-native-app/). - -## Acknowledgements - -We are grateful to the authors of existing related projects for their ideas and collaboration: - -* [@eanplatter](https://github.com/eanplatter) -* [@insin](https://github.com/insin) -* [@mxstbr](https://github.com/mxstbr) diff --git a/packages/babel-preset-react-app/package.json b/packages/babel-preset-react-app/package.json index 81dd0fa1fe9..8b17dded486 100644 --- a/packages/babel-preset-react-app/package.json +++ b/packages/babel-preset-react-app/package.json @@ -1,4 +1,5 @@ { + "private": true, "name": "babel-preset-react-app", "version": "3.1.2", "description": "Babel preset used by Create React App", diff --git a/packages/create-react-app/package.json b/packages/create-react-app/package.json index 4d8f4112ead..2539bbc289b 100644 --- a/packages/create-react-app/package.json +++ b/packages/create-react-app/package.json @@ -1,4 +1,5 @@ { + "private": true, "name": "create-react-app", "version": "1.5.2", "keywords": [ diff --git a/packages/eslint-config-react-app/package.json b/packages/eslint-config-react-app/package.json index c13b0417c46..c28192a83ef 100644 --- a/packages/eslint-config-react-app/package.json +++ b/packages/eslint-config-react-app/package.json @@ -1,4 +1,5 @@ { + "private": true, "name": "eslint-config-react-app", "version": "2.1.0", "description": "ESLint configuration used by Create React App", diff --git a/packages/react-dev-utils/WebpackDevServerUtils.js b/packages/react-dev-utils/WebpackDevServerUtils.js index 4add9f9c1bc..d462f9c1db0 100644 --- a/packages/react-dev-utils/WebpackDevServerUtils.js +++ b/packages/react-dev-utils/WebpackDevServerUtils.js @@ -25,6 +25,11 @@ let handleCompile; // We only use this block for testing of Create React App itself: const isSmokeTest = process.argv.some(arg => arg.indexOf('--smoke-test') > -1); if (isSmokeTest) { + // process.env.UV_THREADPOOL_SIZE default value is 4. Setting it to 20 seems to stop the build hanging. + // We only do this if the --smoke-test flag is passed because we haven't seen this in the wild yet. + // See https://github.com/sass/node-sass/issues/857 & https://github.com/jtangelder/sass-loader/issues/147. + process.env.UV_THREADPOOL_SIZE = 50; + handleCompile = (err, stats) => { if (err || stats.hasErrors() || stats.hasWarnings()) { process.exit(1); diff --git a/packages/react-dev-utils/package.json b/packages/react-dev-utils/package.json index 690c275f4d6..c0235f3c832 100644 --- a/packages/react-dev-utils/package.json +++ b/packages/react-dev-utils/package.json @@ -1,4 +1,5 @@ { + "private": true, "name": "react-dev-utils", "version": "5.0.2", "description": "Webpack utilities used by Create React App", diff --git a/packages/react-error-overlay/package.json b/packages/react-error-overlay/package.json index 06354daf1b6..ab7e80e8233 100644 --- a/packages/react-error-overlay/package.json +++ b/packages/react-error-overlay/package.json @@ -1,4 +1,5 @@ { + "private": true, "name": "react-error-overlay", "version": "4.0.1", "description": "An overlay for displaying stack frames.", diff --git a/packages/react-scripts/CHANGELOG.md b/packages/react-scripts/CHANGELOG.md new file mode 100644 index 00000000000..acfc2399cee --- /dev/null +++ b/packages/react-scripts/CHANGELOG.md @@ -0,0 +1,354 @@ +# `backpack-react-scripts` Change Log + +## 6.0.1 - 2018-02-11 +### Breaking +- Add css modules to `.css` imports. This is only valid for projects using css modules + +## 5.2.1 - 2018-09-10 +### Fixed +- Remove peer dependency warnings +- Remove usage of `bpk-component-grid` + +## 5.2.0 - 2018-09-06 +### Added +- Rebased onto `upstream/master` v1.1.5 (dc74990b89b5c6e143b522c759be3dac2c286514) +- Upgraded dependencies, mostly `eslint` based. + +## 5.1.1 - 2018-04-11 +### Fixed +- `backpack-react-scripts` listed inside of `devDependencies` instead of `dependencies` +- `registerServiceWorker.js` no longer appears in project output + +## 5.1.0 - 2018-04-10 +### Added +- Rebased onto `upstream/master` v1.1.4 (dfbc71ce2ae07547a8544cce14a1a23fac99e071) + +## 5.0.10 - 2018-03-21 +### Fixed +- New `disablePolyfills` config in `package.json`. You can opt out of including polyfills from the output bundle like so: + +```json + "backpack-react-scripts": { + "disablePolyfills": true + } +``` + +## 5.0.9 - 2018-03-14 +### Fixed +- New `crossOriginLoading` config in `package.json`. You can configure cross-origin loading of dynamic chunks: + +```json + "backpack-react-scripts": { + "crossOriginLoading": "anonymous" + } +``` + +## 5.0.8 - 2018-03-07 +### Fixed +- New `amdExcludes` config in `package.json`. You can now disable AMD parsing for specific modules like so: + +```json + "backpack-react-scripts": { + "amdExcludes": [ + "globalize" + ] + } +``` + +## 5.0.7 - 2018-03-06 +### Fixed +- Use `package.json` name field as value for `output.jsonpFunction`, this is important for when multiple webpack runtimes from different compilation are used on the same page + +## 5.0.6 - 2018-01-31 +### Fixed +- CSS Modules hashing now uses `package.json` name field as a salt + +## 5.0.5 - 2018-01-15 +### Fixed +- Added `saddlebag-` prefix to the jest config + +## 5.0.4 - 2018-01-11 +### Added +- Added `saddlebag-` prefix for saddlebag modules + +## 5.0.3 - 2017-12-21 +### Fixed +- Rebased onto `upstream/master` v1.0.17 (4b55193f0ad479f26b0f5e153bb4b152a1ee03e7) +- Peer dependency issues with `postcss-less` & `sugarss` + +## 5.0.2 - 2017-11-03 +### Fixed +- Scope the disabling of AMD for `lodash` only + +## 5.0.1 - 2017-11-02 +### Fixed +- Prevent lodash imports from leaking on to the global scope, see https://github.com/webpack/webpack/issues/3017#issuecomment-285954512 +- Upgraded `stylelint` to `^8.2.0` and `stylelint-config-skyscanner` to `^1.0.1` + +## 5.0.0 - 2017-10-30 +### Breaking +- Upgraded [`eslint-config-skyscanner`](https://github.com/Skyscanner/eslint-config-skyscanner/blob/master/changelog.md#300---upgraded-esling-config-airbnb-peer-dependencies) to `3.0.0`. + +## 4.0.8 - 2017-10-12 +### Fixed +- Rebased onto `upstream/master` (b2c0b3f74b47f0f85e3f17f7d3249b7e536cda05) +- Locked `react` & `react-dom` versions to `^15.0.0` for now + +## 4.0.7 - 2017-08-24 +### Fixed +- Fixed issue with classnames not being hashed correctly for projects using CSS Modules + +## 4.0.6 - 2017-08-22 +### Fixed +- Upgraded sass-loader to 6.0.6 which fixes peer dependency warning with webpack (caused shrinkwraps to fail) +- Upgraded bpk-mixins to 16.3.1 + +## 4.0.5 - 2017-08-17 +### Fixed +- Rebased onto `upstream/master` (e8a3e4b2995f4c6e49c0a7ed653a1646a7b5e515) + +## 4.0.3 - 2017-08-10 +### Fixed +- Production and SSR builds will now use `optimize-css-assets-webpack-plugin` with `cssnano` to optimize output CSS. This gets rid of duplication of global CSS constructs such as keyframes. + +## 4.0.2 - 2017-07-28 +### Fixed +- Deprecated BpkHeading and BpkParagraph +- Added BpkText component +- Updated all other Backpack dependencies to latest versions + +## 4.0.1 - 2017-07-27 +### Fixed +- Updated eslint-plugin-import to 2.7.0 to fix `npm shrinkwrap --save-dev` + +## 4.0.0 - 2017-07-27 +### Changed +- Updated stylelint to 8.0.0 and stylelint-config-skyscanner to 1.0.0 + +## 3.0.1 - 2017-07-12 +### Fixed +- Mocked CSS Modules for Jest, so snapshot tests include the original class names + +## 3.0.0 - 2017-07-11 +### Changed +- Enabled [CSS Modules](https://github.com/css-modules/css-modules) by default + - You can use the config option `cssModules` to opt out: + ``` + "backpack-react-scripts": { + "cssModules": false + } + ``` + In this case, Sass files will not be treated as CSS Modules by default. However, you can opt-in on a + per-file basis using the naming convention: `*.module.scss`. + - Backpack components will _always_ be treated as CSS Modules, even if you opt out + - All Backpack components need to be on these versions (or higher) to work: + - bpk-component-accordion@1.1.0 + - bpk-component-autosuggest@3.0.13 + - bpk-component-badge@0.1.0 + - bpk-component-banner-alert@1.1.0 + - bpk-component-barchart@0.1.0 + - bpk-component-blockquote@0.1.0 + - bpk-component-breakpoint@0.1.22 + - bpk-component-button@1.6.33 + - bpk-component-calendar@3.3.0 + - bpk-component-card@0.1.0 + - bpk-component-checkbox@1.2.0 + - bpk-component-close-button@0.1.0 + - bpk-component-code@0.1.0 + - bpk-component-content-container@1.1.0 + - bpk-component-datepicker@6.1.1 + - bpk-component-fieldset@0.3.1 + - bpk-component-form-validation@0.1.0 + - bpk-component-grid-toggle@0.1.0 + - bpk-component-grid@1.1.0 + - bpk-component-heading@2.1.0 + - bpk-component-horizontal-nav@0.1.0 + - bpk-component-icon@3.7.0 + - bpk-component-input@3.2.1 + - bpk-component-label@3.2.0 + - bpk-component-link@0.6.0 + - bpk-component-list@0.1.0 + - bpk-component-loading-button@0.1.0 + - bpk-component-modal@1.1.0 + - bpk-component-nudger@0.1.0 + - bpk-component-panel@0.1.0 + - bpk-component-paragraph@0.3.0 + - bpk-component-popover@1.1.0 + - bpk-component-progress@0.1.0 + - bpk-component-radio@1.1.0 + - bpk-component-router-link@0.2.0 + - bpk-component-rtl-toggle@0.0.73 + - bpk-component-select@2.1.0 + - bpk-component-spinner@2.1.0 + - bpk-component-star-rating@0.0.3 + - bpk-component-table@0.1.0 + - bpk-component-textarea@0.1.0 + - bpk-component-ticket@0.1.0 + - bpk-component-tooltip@1.1.0 + - bpk-react-utils@2.0.0 + +## 2.0.3 - 2017-07-010 +### Fixed +- Rebased onto `upstream/master` (f495c15578403cf2dbac211493ae8fb6ac742415) + +## 2.0.1 - 2017-07-04 +### Changed +- Replaced the "babelIncludeRegex" config option in `package.json` with "babelIncludePrefixes". You can now + enable transpilation for your dependencies by adding package prefixes like so: + ``` + { + ... + "backpack-react-scripts": { + "babelIncludePrefixes": [ + "my-module-prefix-", + "some-dependency" + ] + } + } + ``` + +### Changed +- Upgraded `eslint-config-skyscanner` to `2.0.0` which uses the `babel-eslint` parse + +## 1.0.1 - 2017-06-12 +### Added +- Added `babel-eslint` as dependency so it can be used with ESLint when dynamic `import()` statements are used + +### Changed +- Upgraded `eslint-config-skyscanner` to `2.0.0` which uses the `babel-eslint` parse + +## 1.0.0 - 2017-05-29 +### Changed +- Rebased from `upstream/master` (fbaeff2d6ef83ae5dc8213150e0fa6589ed29150) +- TLDR; this upgrades the upstream dependency `react-scripts` to `^1.0.0` - please read the [blog post](https://facebook.github.io/react/blog/2017/05/18/whats-new-in-create-react-app.html) for a summary of the new features this brings +- This is a major release, meaning there are a few breaking changes (summarised below). Please refer to the [`react-scripts` changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#100-may-18-2017) for detailed migration documentations. + - [Ensure application and test files reside in src/](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#ensure-application-and-test-files-reside-in-src) + - [You can no longer import file content](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#you-can-no-longer-import-file-content) + - [Confusing window globals can no longer be used without window qualifier](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#confusing-window-globals-can-no-longer-be-used-without-window-qualifier) + - [Jest snapshot format has changed](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#how-do-i-make-my-tests-work-with-jest-20) + +## 0.0.19 - 2017-05-02 +### Added +- The ability to configure "babelIncludeRegex" in package json + +## 0.0.18 - 2017-04-10 +### Added +- Support for new `bpk-icon` mixin from `bpk-mixins` + +## 0.0.17 - 2017-04-06 +### Fixed +- Rebased from `upstream/0.9.x` (ebebe80383eb15b4759a0cd5ea12015eaac94c0e) +- Now moves `react` and `react-dom` from dependencies to devDependencies + +## 0.0.16 - 2017-03-30 +### Added +- Upgrading `eslint-config-skyscanner` to v1.1.0 +- Upgrading `stylelint-config-skyscanner` to v0.1.3 +- Upgrading `eslint-plugin-react` to v6.10.3 as [undelying issue](https://github.com/yannickcr/eslint-plugin-react/issues/1117) which caused it to be pinned was resolved +- Upgrading `node-sass` to v4.5.0 to make it compatible with latest version of `bpk-mixins` +- Upgrading all Backpack dev dependencies: + - `bpk-component-button` to v1.6.6 + - `bpk-component-code` to v0.0.58 + - `bpk-component-grid` to v1.0.8 + - `bpk-component-heading` to v1.2.7 + - `bpk-component-paragraph` to v0.2.1 + - `bpk-mixins` to v11.0.2 + - `bpk-stylesheets` to v3.2.16 +- Upgrading `detect-port` to v1.1.1 + +## 0.0.15 - 2017-03-27 +### Added +- The ability to lint SCSS with `stylelint-config-skyscanner` + - run `npm run lint:scss` or just `npm run lint` for both JS and SCSS linting +- The ability to automatically fix many SCSS linting issues using `stylefmt` + - run `npm run lint:scss:fix` +- The ability to automatically fix many JS linting issues using `eslint --fix` + - run `npm run lint:js:fix` + +## 0.0.14 - 2017-03-20 +### Added +- Upgrading `eslint-config-skyscanner` to v1.0.0 + +### Fixed +- Pinning `eslint-plugin-react` to 6.10.0 to fix indent bug + +## 0.0.13 - 2017-03-09 +### Added +- The ability to configure "ssrExternals" in package json + +## 0.0.12 - 2017-03-01 +### Fixed +- The backpack module regex now works on windows + +## 0.0.11 - 2017-02-27 +### Changed +- Removed backpack logo usage from output template + +### Added +- There is now an `.editorconfig` in the output template + +## 0.0.10 - 2017-01-05 +### Changed +- Rebased from `upstream/master` (4d7b7544e74db1aaca22e847b233ed1f3b95b72b) + - Updates `babel-jest` && `jest` packages to 18.0.0 +- Upgraded `eslint` & `eslint-plugin-react` to 3.12.2 & 6.8.0 respectively + +### Added +- Added ability to configure "externals" in package json + +## 0.0.9 - 2016-12-20 +### Added +- Server Side Rendering support (proof of concept): + - `webpack.config.ssr.js`: This is a duplicate of `webpack.config.prod.js` modified to target a server side node environment + - `build.js` now checks if an `ssr.js` file exists at the app root, if so it will compile it in parallel with the optimized browser bundle leaving an + `ssr.js` file in the build directory ready to be required on the server + - See the [readme](https://github.com/Skyscanner/backpack-react-scripts/tree/master/packages/react-scripts/template#server-side-rendering-ssr) for detailed instructions. + +## 0.0.8 +### Changed +- Rebased from `upstream/master` (94c912dc60561c931232caf9cf5442082711227c) + - Mostly bug fixes and dependency upgrades, see [create-react-app's changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md) + (between versions `v0.8.0` -> `v0.8.4`) + +## 0.0.7 +### Fixed +- Added base stylesheet scripts to the template so that hover effects work + +## 0.0.6 +### Changed +- Removed eslint from webpack to a separate `npm run lint` task +- Swapped out `eslint-config-react-app` in favour of `eslint-config-skyscanner` + +### Added +- A `backpack-react-scripts` specific readme + +## 0.0.5 +### Fixed +- Rebased from `upstream/master` (bcc469c9a5c7916ec10786f133769cdda2c80188) + - Most notable change is Yarn support + +## 0.0.4 +### Fixed +- Reverted nested components dir + +## 0.0.3 +### Added +- New Backpack template + - Backpack stylesheet and Sass mixin integration + - Backpack button, code, grid, heading & paragraph components integration + - `.eslintrc` for editor integration + - Nested components into `src/components/` dir + +## 0.0.2 +### Fixed +- Removed `bundledDependencies` + +## 0.0.1 +### Changed +- Customised `react-scripts` package to be `backpack-react-scripts` +- Marked all other packages as private + +### Added +- Sass stylesheet support +- Babel will now compile imports from the `node_modules` folder that match `/bpk-*` +- Drone build configuration diff --git a/packages/react-scripts/README.md b/packages/react-scripts/README.md index 8004b887004..7efe5f91f98 100644 --- a/packages/react-scripts/README.md +++ b/packages/react-scripts/README.md @@ -1,7 +1,137 @@ -# react-scripts +# backpack-react-scripts -This package includes scripts and configuration used by [Create React App](https://github.com/facebookincubator/create-react-app).<br> -Please refer to its documentation: +This package is a fork of [Create React App](https://github.com/facebookincubator/create-react-app) (specifically the +`react-scripts` package). It's intended to be used in conjuction with `create-react-app` like so: -* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app. -* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. +```sh +# we still rely on facebooks global `create-react-app` cli +npm install -g create-react-app + +# specify `backpack-react-scripts` as the scripts package to use +create-react-app my-app --scripts-version=backpack-react-scripts + +# start your app development like you normally would with `create-react-app` +cd my-app +npm start +``` + +## Why fork? + +Out of the box, `create-react-app` doesn't work well with Backpack components because it has no support for +Sass stylesheets or uncompiled dependencies in the `node_modules` folder. We also want to be able to tailor +the template to use Backpack out-the-box. + +## What is different in our fork? + +This is a high-level overview of the changed we made to this fork. + +### Moved ESLint from Webpack to npm script + +> See `config/webpack.config.{dev,prod}.js`, `package.json`, `scripts/{eject,init}.js`, `template/.eslintrc` + +By default, react-scripts runs all code through ESLint *on build*. As our [ESLint configuration](https://github.com/Skyscanner/eslint-config-skyscanner) is quite opinionated, we have disabled this functionality. + +We have added an npm script so you can still run the linter at will using `npm run lint`. + +### Added stylelint configuration + +> See `package.json`, `template/.stylelintrc.json` + +We added Skyscanner's [Stylelint configuration](https://github.com/Skyscanner/stylelint-config-skyscanner/). + +### Added in Backpack components + +> See `scripts/init.js`, `template/src/*` + +We pre-install some Backpack components to help you get started quickly. + +### Added a server-side rendering (SSR) Webpack configuration + +> See `config/webpack.config.ssr.js` + +This Webpack configuration is used to to enable easy server-side rendering. It is derived from `config/webpack.config.prod.js`. + +Everything that we don't need from the prod config is not removed, but *commented out*. + +### Moved React and ReactDOM from `dependencies` to `devDependencies` + +> See `scripts/init.js` + +Any app built with backpack-react-scripts should always output a bundle, and therefore it is enough to keep React and ReactDOM in `devDependencies`. In many cases, they should also be external dependencies (not part of the bundle). + +As the CRA CLI install React and ReactDOM, we cannot really do anything about that; but we can move the entries in `package.json` from `dependencies` to `devDependencies`. + +### Enabled CSS Modules + +> See `config/webpack.config.{dev,prod,ssr}.js` + +All Sass files are by default treated as [CSS Modules](https://github.com/css-modules/css-modules). You can opt out of this behaviour using the following config option: + +``` +"backpack-react-scripts": { + "cssModules": false +} +``` + +If you decide to opt out, Sass files will not be treated as CSS Modules by default. However, you can opt-in on a per-file basis using the naming convention: `*.module.scss`. + +> Backpack components will _always_ be treated as CSS Modules, even if you opt out + +## Releasing a new version of `backpack-react-scripts` + +1. To publish a new version of `backpack-react-scripts`, run the following command: + + ``` + npm run publish -- --scope backpack-react-scripts + ``` + +1. You will be prompted to select a new semver version (MAJOR, MINOR, PATCH). Use the [CHANGELOG.md](./CHANGELOG.md) to decide on the nature of the changes since the last release. + * If you want to be extra careful, you can publish a prerelease by running this instead: + + ``` + npm run publish -- --scope backpack-react-scripts --canary + ``` + +1. Update the [CHANGELOG.md](./CHANGELOG.md) with the new version, taking care to follow the format of previous releases. + +## Keeping this fork updated + +We wish to keep this fork updated with the upstream repo to benefit from the ongoing open source development +of `create-react-app`. To keep this fork up to date, please follow the steps below: + +1. Ensure `master` is in sync with `upstream/master`: + + ```sh + git checkout master + git remote add upstream git@github.com:facebook/create-react-app.git + git fetch upstream + git reset --hard upstream/master + git push --force-with-lease + ``` + +1. Rebase `fork` on top of a **tagged release** on `master`: + + ```sh + git checkout fork + git rebase <commit> + ``` + + > **Note:** `<commit>` should be the SHA-1 of the latest upstream release - _not_ just the latest i.e. `upstream/master` + +1. Pair with someone else to fix any conflicts and cross examine changes in upstream with changes in our fork. + + > This is the most time consuming part. Take care to make sure you are not regressing any functionality that we have added in our fork. + +1. Re-name your local, rebased `fork` branch to something else and push it to origin. This will ensure it runs through CI and you can verify your changes. + + ```sh + git branch -m <branch> + git push origin <branch> + ``` + +1. Finally, when we are confident that the rebase has been successful, re-name your branch back to `fork` and push it to origin: + + ```sh + git branch -m fork + git push --force-with-lease + ``` diff --git a/packages/react-scripts/config/getLocalIdent.js b/packages/react-scripts/config/getLocalIdent.js new file mode 100644 index 00000000000..a6b1a7aeca1 --- /dev/null +++ b/packages/react-scripts/config/getLocalIdent.js @@ -0,0 +1,21 @@ +'use strict'; + +const getLocalIdent = require('css-loader/lib/getLocalIdent'); + +const paths = require('./paths'); +const pkgJson = require(paths.appPackageJson); + +module.exports = (context, localIdentName, localName, options) => { + const customOptions = {}; + + if (pkgJson.name) { + customOptions.hashPrefix = pkgJson.name; + } + + return getLocalIdent( + context, + localIdentName, + localName, + Object.assign(options, customOptions) + ); +}; diff --git a/packages/react-scripts/config/paths.js b/packages/react-scripts/config/paths.js index 718b898bb8d..8a6104cf083 100644 --- a/packages/react-scripts/config/paths.js +++ b/packages/react-scripts/config/paths.js @@ -46,6 +46,10 @@ function getServedPath(appPackageJson) { return ensureSlash(servedUrl, true); } +// Regex to match backpack node modules +const backpackModulesRegex = /node_modules[\\/]bpk-/; +const saddlebagModulesRegex = /node_modules[\\/]saddlebag-/; + // config after eject: we're in ./config/ module.exports = { dotenv: resolveApp('.env'), @@ -60,6 +64,9 @@ module.exports = { appNodeModules: resolveApp('node_modules'), publicUrl: getPublicUrl(resolveApp('package.json')), servedPath: getServedPath(resolveApp('package.json')), + backpackModulesRegex: backpackModulesRegex, + saddlebagModulesRegex: saddlebagModulesRegex, + appSsrJs: resolveApp('src/ssr.js'), }; // @remove-on-eject-begin @@ -83,6 +90,9 @@ module.exports = { // These properties only exist before ejecting: ownPath: resolveOwn('.'), ownNodeModules: resolveOwn('node_modules'), // This is empty on npm 3 + backpackModulesRegex: backpackModulesRegex, + saddlebagModulesRegex: saddlebagModulesRegex, + appSsrJs: resolveApp('src/ssr.js'), }; const ownPackageJson = require('../package.json'); @@ -113,6 +123,9 @@ if ( // These properties only exist before ejecting: ownPath: resolveOwn('.'), ownNodeModules: resolveOwn('node_modules'), + backpackModulesRegex: backpackModulesRegex, + saddlebagModulesRegex: saddlebagModulesRegex, + appSsrJs: resolveOwn('template/src/ssr.js'), }; } // @remove-on-eject-end diff --git a/packages/react-scripts/config/webpack.config.dev.js b/packages/react-scripts/config/webpack.config.dev.js index 9f3131b0660..6b7c9dd4c09 100644 --- a/packages/react-scripts/config/webpack.config.dev.js +++ b/packages/react-scripts/config/webpack.config.dev.js @@ -15,10 +15,14 @@ const HtmlWebpackPlugin = require('html-webpack-plugin'); const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin'); const InterpolateHtmlPlugin = require('react-dev-utils/InterpolateHtmlPlugin'); const WatchMissingNodeModulesPlugin = require('react-dev-utils/WatchMissingNodeModulesPlugin'); -const eslintFormatter = require('react-dev-utils/eslintFormatter'); +// const eslintFormatter = require('react-dev-utils/eslintFormatter'); const ModuleScopePlugin = require('react-dev-utils/ModuleScopePlugin'); +const sassFunctions = require('bpk-mixins/sass-functions'); +const camelCase = require('lodash/camelCase'); const getClientEnvironment = require('./env'); +const getLocalIdent = require('./getLocalIdent'); const paths = require('./paths'); +const pkgJson = require(paths.appPackageJson); // Webpack uses `publicPath` to determine where the app is being served from. // In development, we always serve from the root. This makes config easier. @@ -30,6 +34,34 @@ const publicUrl = ''; // Get environment variables to inject into our app. const env = getClientEnvironment(publicUrl); +const bpkReactScriptsConfig = pkgJson['backpack-react-scripts'] || {}; + +const customModuleRegexes = bpkReactScriptsConfig.babelIncludePrefixes + ? bpkReactScriptsConfig.babelIncludePrefixes.map( + prefix => new RegExp(`node_modules[\\/]${prefix}`) + ) + : []; + +const optInCssModules = bpkReactScriptsConfig.cssModules === false; + +const postcssOptions = { + // Necessary for external CSS imports to work + // https://github.com/facebookincubator/create-react-app/issues/2677 + ident: 'postcss', + plugins: () => [ + require('postcss-flexbugs-fixes'), + autoprefixer({ + browsers: [ + '>1%', + 'last 4 versions', + 'Firefox ESR', + 'not ie < 9', // React doesn't support IE8 anyway + ], + flexbox: 'no-2009', + }), + ], +}; + // This is the development configuration. // It is focused on developer experience and fast rebuilds. // The production configuration is different and lives in a separate file. @@ -40,27 +72,30 @@ module.exports = { // These are the "entry points" to our application. // This means they will be the "root" imports that are included in JS bundle. // The first two entry points enable "hot" CSS and auto-refreshes for JS. - entry: [ - // We ship a few polyfills by default: - require.resolve('./polyfills'), - // Include an alternative client for WebpackDevServer. A client's job is to - // connect to WebpackDevServer by a socket and get notified about changes. - // When you save a file, the client will either apply hot updates (in case - // of CSS changes), or refresh the page (in case of JS changes). When you - // make a syntax error, this client will display a syntax error overlay. - // Note: instead of the default WebpackDevServer client, we use a custom one - // to bring better experience for Create React App users. You can replace - // the line below with these two lines if you prefer the stock client: - // require.resolve('webpack-dev-server/client') + '?/', - // require.resolve('webpack/hot/dev-server'), - require.resolve('react-dev-utils/webpackHotDevClient'), - // Finally, this is your app's code: - paths.appIndexJs, - // We include the app code last so that if there is a runtime error during - // initialization, it doesn't blow up the WebpackDevServer client, and - // changing JS code would still trigger a refresh. - ], + entry: bpkReactScriptsConfig.disablePolyfills + ? [require.resolve('react-dev-utils/webpackHotDevClient'), paths.appIndexJs] + : [ + // We ship a few polyfills by default: + require.resolve('./polyfills'), + // Include an alternative client for WebpackDevServer. A client's job is to + // connect to WebpackDevServer by a socket and get notified about changes. + // When you save a file, the client will either apply hot updates (in case + // of CSS changes), or refresh the page (in case of JS changes). When you + // make a syntax error, this client will display a syntax error overlay. + // Note: instead of the default WebpackDevServer client, we use a custom one + // to bring better experience for Create React App users. You can replace + // the line below with these two lines if you prefer the stock client: + // require.resolve('webpack-dev-server/client') + '?/', + // require.resolve('webpack/hot/dev-server'), + require.resolve('react-dev-utils/webpackHotDevClient'), + // Finally, this is your app's code: + paths.appIndexJs, + // We include the app code last so that if there is a runtime error during + // initialization, it doesn't blow up the WebpackDevServer client, and + // changing JS code would still trigger a refresh. + ], output: { + jsonpFunction: camelCase(pkgJson.name + 'JsonpCallback'), // Add /* filename */ comments to generated require()s in the output. pathinfo: true, // This does not produce a real file. It's just the virtual path that is @@ -123,26 +158,36 @@ module.exports = { // First, run the linter. // It's important to do this before Babel processes the JS. + // { + // test: /\.(js|jsx|mjs)$/, + // enforce: 'pre', + // use: [ + // { + // options: { + // formatter: eslintFormatter, + // eslintPath: require.resolve('eslint'), + // // @remove-on-eject-begin + // baseConfig: { + // extends: [require.resolve('eslint-config-react-app')], + // }, + // ignore: false, + // useEslintrc: false, + // // @remove-on-eject-end + // }, + // loader: require.resolve('eslint-loader'), + // }, + // ], + // include: paths.appSrc, + // }, { - test: /\.(js|jsx|mjs)$/, - enforce: 'pre', - use: [ - { - options: { - formatter: eslintFormatter, - eslintPath: require.resolve('eslint'), - // @remove-on-eject-begin - baseConfig: { - extends: [require.resolve('eslint-config-react-app')], - }, - ignore: false, - useEslintrc: false, - // @remove-on-eject-end - }, - loader: require.resolve('eslint-loader'), - }, - ], - include: paths.appSrc, + test: new RegExp( + `(^|/)(${(bpkReactScriptsConfig.amdExcludes || []) + .concat('lodash') + .join('|')})(/|.|$)` + ), + parser: { + amd: false, + }, }, { // "oneOf" will traverse all following loaders until one will @@ -163,7 +208,12 @@ module.exports = { // Process JS with Babel. { test: /\.(js|jsx|mjs)$/, - include: paths.appSrc, + include: [ + paths.appSrc, + paths.backpackModulesRegex, + paths.saddlebagModulesRegex, + ...customModuleRegexes, + ], loader: require.resolve('babel-loader'), options: { // @remove-on-eject-begin @@ -182,34 +232,116 @@ module.exports = { // In production, we use a plugin to extract that CSS to a file, but // in development "style" loader enables hot editing of CSS. { - test: /\.css$/, + test: /\.scss$/, + exclude: optInCssModules + ? [/\.module\.scss$/, paths.backpackModulesRegex] + : [], + use: [ + require.resolve('style-loader'), + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.scss$/, + { and: [paths.backpackModulesRegex, /\.scss$/] }, + ], + }, + ], + }, use: [ require.resolve('style-loader'), { loader: require.resolve('css-loader'), options: { importLoaders: 1, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, }, }, { loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + { + test: /\.css$/, + exclude: optInCssModules + ? [/\.module\.css$/, paths.backpackModulesRegex] + : [], + use: [ + require.resolve('style-loader'), + { + loader: require.resolve('css-loader'), options: { - // Necessary for external CSS imports to work - // https://github.com/facebookincubator/create-react-app/issues/2677 - ident: 'postcss', - plugins: () => [ - require('postcss-flexbugs-fixes'), - autoprefixer({ - browsers: [ - '>1%', - 'last 4 versions', - 'Firefox ESR', - 'not ie < 9', // React doesn't support IE8 anyway - ], - flexbox: 'no-2009', - }), + importLoaders: 1, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + ], + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.css$/, + { and: [paths.backpackModulesRegex, /\.css$/] }, ], }, + ], + }, + use: [ + require.resolve('style-loader'), + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, }, ], }, diff --git a/packages/react-scripts/config/webpack.config.prod.js b/packages/react-scripts/config/webpack.config.prod.js index 3b2a2068db2..b3d94cde40d 100644 --- a/packages/react-scripts/config/webpack.config.prod.js +++ b/packages/react-scripts/config/webpack.config.prod.js @@ -15,11 +15,16 @@ const HtmlWebpackPlugin = require('html-webpack-plugin'); const ExtractTextPlugin = require('extract-text-webpack-plugin'); const ManifestPlugin = require('webpack-manifest-plugin'); const InterpolateHtmlPlugin = require('react-dev-utils/InterpolateHtmlPlugin'); +const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin'); const SWPrecacheWebpackPlugin = require('sw-precache-webpack-plugin'); -const eslintFormatter = require('react-dev-utils/eslintFormatter'); +// const eslintFormatter = require('react-dev-utils/eslintFormatter'); const ModuleScopePlugin = require('react-dev-utils/ModuleScopePlugin'); +const sassFunctions = require('bpk-mixins/sass-functions'); +const camelCase = require('lodash/camelCase'); const paths = require('./paths'); const getClientEnvironment = require('./env'); +const getLocalIdent = require('./getLocalIdent'); +const pkgJson = require(paths.appPackageJson); // Webpack uses `publicPath` to determine where the app is being served from. // It requires a trailing slash, or the file assets will get an incorrect path. @@ -54,6 +59,35 @@ const extractTextPluginOptions = shouldUseRelativeAssetPaths { publicPath: Array(cssFilename.split('/').length).join('../') } : {}; +const bpkReactScriptsConfig = pkgJson['backpack-react-scripts'] || {}; + +const customModuleRegexes = bpkReactScriptsConfig.babelIncludePrefixes + ? bpkReactScriptsConfig.babelIncludePrefixes.map( + prefix => new RegExp(`node_modules[\\/]${prefix}`) + ) + : []; + +const optInCssModules = bpkReactScriptsConfig.cssModules === false; +const crossOriginLoading = bpkReactScriptsConfig.crossOriginLoading || false; + +const postcssOptions = { + // Necessary for external CSS imports to work + // https://github.com/facebookincubator/create-react-app/issues/2677 + ident: 'postcss', + plugins: () => [ + require('postcss-flexbugs-fixes'), + autoprefixer({ + browsers: [ + '>1%', + 'last 4 versions', + 'Firefox ESR', + 'not ie < 9', // React doesn't support IE8 anyway + ], + flexbox: 'no-2009', + }), + ], +}; + // This is the production configuration. // It compiles slowly and is focused on producing a fast and minimal bundle. // The development configuration is different and lives in a separate file. @@ -64,8 +98,11 @@ module.exports = { // You can exclude the *.map files from the build during deployment. devtool: shouldUseSourceMap ? 'source-map' : false, // In production, we only want to load the polyfills and the app code. - entry: [require.resolve('./polyfills'), paths.appIndexJs], + entry: bpkReactScriptsConfig.disablePolyfills + ? paths.appIndexJs + : [require.resolve('./polyfills'), paths.appIndexJs], output: { + jsonpFunction: camelCase(pkgJson.name + 'JsonpCallback'), // The build folder. path: paths.appBuild, // Generated JS file names (with nested folders). @@ -73,6 +110,7 @@ module.exports = { // We don't currently advertise code splitting but Webpack supports it. filename: 'static/js/[name].[chunkhash:8].js', chunkFilename: 'static/js/[name].[chunkhash:8].chunk.js', + crossOriginLoading, // We inferred the "public path" (such as / or /my-project) from homepage. publicPath: publicPath, // Point sourcemap entries to original disk location (format as URL on Windows) @@ -81,6 +119,7 @@ module.exports = { .relative(paths.appSrc, info.absoluteResourcePath) .replace(/\\/g, '/'), }, + externals: bpkReactScriptsConfig.externals, resolve: { // This allows you to set a fallback for where Webpack should look for modules. // We placed these paths second because we want `node_modules` to "win" @@ -129,28 +168,38 @@ module.exports = { // First, run the linter. // It's important to do this before Babel processes the JS. + // { + // test: /\.(js|jsx|mjs)$/, + // enforce: 'pre', + // use: [ + // { + // options: { + // formatter: eslintFormatter, + // eslintPath: require.resolve('eslint'), + // // @remove-on-eject-begin + // // TODO: consider separate config for production, + // // e.g. to enable no-console and no-debugger only in production. + // baseConfig: { + // extends: [require.resolve('eslint-config-react-app')], + // }, + // ignore: false, + // useEslintrc: false, + // // @remove-on-eject-end + // }, + // loader: require.resolve('eslint-loader'), + // }, + // ], + // include: paths.appSrc, + // }, { - test: /\.(js|jsx|mjs)$/, - enforce: 'pre', - use: [ - { - options: { - formatter: eslintFormatter, - eslintPath: require.resolve('eslint'), - // @remove-on-eject-begin - // TODO: consider separate config for production, - // e.g. to enable no-console and no-debugger only in production. - baseConfig: { - extends: [require.resolve('eslint-config-react-app')], - }, - ignore: false, - useEslintrc: false, - // @remove-on-eject-end - }, - loader: require.resolve('eslint-loader'), - }, - ], - include: paths.appSrc, + test: new RegExp( + `(^|/)(${(bpkReactScriptsConfig.amdExcludes || []) + .concat('lodash') + .join('|')})(/|.|$)` + ), + parser: { + amd: false, + }, }, { // "oneOf" will traverse all following loaders until one will @@ -170,7 +219,12 @@ module.exports = { // Process JS with Babel. { test: /\.(js|jsx|mjs)$/, - include: paths.appSrc, + include: [ + paths.appSrc, + paths.backpackModulesRegex, + paths.saddlebagModulesRegex, + ...customModuleRegexes, + ], loader: require.resolve('babel-loader'), options: { // @remove-on-eject-begin @@ -192,8 +246,104 @@ module.exports = { // tags. If you use code splitting, however, any async bundles will still // use the "style" loader inside the async code so CSS from them won't be // in the main CSS file. + { + test: /\.scss$/, + exclude: optInCssModules + ? [/\.module\.scss$/, paths.backpackModulesRegex] + : [], + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.scss$/, + { and: [paths.backpackModulesRegex, /\.scss$/] }, + ], + }, + ], + }, + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, { test: /\.css$/, + exclude: optInCssModules + ? [/\.module\.css$/, paths.backpackModulesRegex] + : [], loader: ExtractTextPlugin.extract( Object.assign( { @@ -210,28 +360,59 @@ module.exports = { importLoaders: 1, minimize: true, sourceMap: shouldUseSourceMap, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, }, }, { loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.css$/, + { and: [paths.backpackModulesRegex, /\.css$/] }, + ], + }, + ], + }, + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), options: { - // Necessary for external CSS imports to work - // https://github.com/facebookincubator/create-react-app/issues/2677 - ident: 'postcss', - plugins: () => [ - require('postcss-flexbugs-fixes'), - autoprefixer({ - browsers: [ - '>1%', - 'last 4 versions', - 'Firefox ESR', - 'not ie < 9', // React doesn't support IE8 anyway - ], - flexbox: 'no-2009', - }), - ], + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, }, }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, ], }, extractTextPluginOptions @@ -356,6 +537,20 @@ module.exports = { // https://github.com/jmblog/how-to-optimize-momentjs-with-webpack // You can remove this if you don't use Moment.js: new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/), + new OptimizeCssAssetsPlugin({ + cssProcessorOptions: { + postcssZindex: { + disable: true, + }, + autoprefixer: { disable: true }, + postcssDiscardComments: { + disable: true, + }, + map: { + inline: false, + }, + }, + }), ], // Some libraries import Node modules but don't use them in the browser. // Tell Webpack to provide empty mocks for them so importing them works. diff --git a/packages/react-scripts/config/webpack.config.ssr.js b/packages/react-scripts/config/webpack.config.ssr.js new file mode 100644 index 00000000000..6e6fcc82978 --- /dev/null +++ b/packages/react-scripts/config/webpack.config.ssr.js @@ -0,0 +1,567 @@ +// @remove-on-eject-begin +/** + * Copyright (c) 2015-present, Facebook, Inc. + * + * This source code is licensed under the MIT license found in the + * LICENSE file in the root directory of this source tree. + */ +// @remove-on-eject-end +'use strict'; + +const autoprefixer = require('autoprefixer'); +const path = require('path'); +const webpack = require('webpack'); +// const HtmlWebpackPlugin = require('html-webpack-plugin'); +const ExtractTextPlugin = require('extract-text-webpack-plugin'); +// const ManifestPlugin = require('webpack-manifest-plugin'); +// const InterpolateHtmlPlugin = require('react-dev-utils/InterpolateHtmlPlugin'); +const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin'); +// const SWPrecacheWebpackPlugin = require('sw-precache-webpack-plugin'); +// const eslintFormatter = require('react-dev-utils/eslintFormatter'); +const ModuleScopePlugin = require('react-dev-utils/ModuleScopePlugin'); +const sassFunctions = require('bpk-mixins/sass-functions'); +// const camelCase = require('lodash/camelCase'); +const paths = require('./paths'); +const getClientEnvironment = require('./env'); +const getLocalIdent = require('./getLocalIdent'); +const pkgJson = require(paths.appPackageJson); + +// Webpack uses `publicPath` to determine where the app is being served from. +// It requires a trailing slash, or the file assets will get an incorrect path. +const publicPath = paths.servedPath; +// Some apps do not use client-side routing with pushState. +// For these, "homepage" can be set to "." to enable relative asset paths. +const shouldUseRelativeAssetPaths = publicPath === './'; +// Source maps are resource heavy and can cause out of memory issue for large source files. +const shouldUseSourceMap = process.env.GENERATE_SOURCEMAP !== 'false'; +// `publicUrl` is just like `publicPath`, but we will provide it to our app +// as %PUBLIC_URL% in `index.html` and `process.env.PUBLIC_URL` in JavaScript. +// Omit trailing slash as %PUBLIC_URL%/xyz looks better than %PUBLIC_URL%xyz. +const publicUrl = publicPath.slice(0, -1); +// Get environment variables to inject into our app. +const env = getClientEnvironment(publicUrl); + +// Assert this just to be safe. +// Development builds of React are slow and not intended for production. +if (env.stringified['process.env'].NODE_ENV !== '"production"') { + throw new Error('Production builds must have NODE_ENV=production.'); +} + +// Note: defined here because it will be used more than once. +const cssFilename = 'static/css/[name].[contenthash:8].css'; + +// ExtractTextPlugin expects the build output to be flat. +// (See https://github.com/webpack-contrib/extract-text-webpack-plugin/issues/27) +// However, our output is structured with css, js and media folders. +// To have this structure working with relative paths, we have to use custom options. +const extractTextPluginOptions = shouldUseRelativeAssetPaths + ? // Making sure that the publicPath goes back to to build folder. + { publicPath: Array(cssFilename.split('/').length).join('../') } + : {}; + +const bpkReactScriptsConfig = pkgJson['backpack-react-scripts'] || {}; + +const customModuleRegexes = bpkReactScriptsConfig.babelIncludePrefixes + ? bpkReactScriptsConfig.babelIncludePrefixes.map( + prefix => new RegExp(`node_modules[\\/]${prefix}`) + ) + : []; + +const optInCssModules = bpkReactScriptsConfig.cssModules === false; +// const crossOriginLoading = bpkReactScriptsConfig.crossOriginLoading || false; + +const postcssOptions = { + // Necessary for external CSS imports to work + // https://github.com/facebookincubator/create-react-app/issues/2677 + ident: 'postcss', + plugins: () => [ + require('postcss-flexbugs-fixes'), + autoprefixer({ + browsers: [ + '>1%', + 'last 4 versions', + 'Firefox ESR', + 'not ie < 9', // React doesn't support IE8 anyway + ], + flexbox: 'no-2009', + }), + ], +}; + +// This is the production configuration. +// It compiles slowly and is focused on producing a fast and minimal bundle. +// The development configuration is different and lives in a separate file. +module.exports = { + // Don't attempt to continue if there are any errors. + bail: true, + // We generate sourcemaps in production. This is slow but gives good results. + // You can exclude the *.map files from the build during deployment. + // devtool: shouldUseSourceMap ? 'source-map' : false, + // In production, we only want to load the polyfills and the app code. + // entry: bpkReactScriptsConfig.disablePolyfills + // ? paths.appIndexJs + // : [require.resolve('./polyfills'), paths.appIndexJs], + entry: paths.appSsrJs, + target: 'node', + output: { + // jsonpFunction: camelCase(pkgJson.name + 'JsonpCallback'), + // The build folder. + path: paths.appBuild, + // Generated JS file names (with nested folders). + // There will be one main bundle, and one file per asynchronous chunk. + // We don't currently advertise code splitting but Webpack supports it. + // filename: 'static/js/[name].[chunkhash:8].js', + // chunkFilename: 'static/js/[name].[chunkhash:8].chunk.js', + // crossOriginLoading, + filename: 'ssr.js', + // We inferred the "public path" (such as / or /my-project) from homepage. + // publicPath: publicPath, + libraryTarget: 'commonjs2', + // Point sourcemap entries to original disk location (format as URL on Windows) + devtoolModuleFilenameTemplate: info => + path + .relative(paths.appSrc, info.absoluteResourcePath) + .replace(/\\/g, '/'), + }, + // externals: bpkReactScriptsConfig.externals, + externals: bpkReactScriptsConfig.ssrExternals || [], + resolve: { + // This allows you to set a fallback for where Webpack should look for modules. + // We placed these paths second because we want `node_modules` to "win" + // if there are any conflicts. This matches Node resolution mechanism. + // https://github.com/facebookincubator/create-react-app/issues/253 + modules: ['node_modules', paths.appNodeModules].concat( + // It is guaranteed to exist because we tweak it in `env.js` + process.env.NODE_PATH.split(path.delimiter).filter(Boolean) + ), + // These are the reasonable defaults supported by the Node ecosystem. + // We also include JSX as a common component filename extension to support + // some tools, although we do not recommend using it, see: + // https://github.com/facebookincubator/create-react-app/issues/290 + // `web` extension prefixes have been added for better support + // for React Native Web. + extensions: ['.web.js', '.mjs', '.js', '.json', '.web.jsx', '.jsx'], + alias: { + // @remove-on-eject-begin + // Resolve Babel runtime relative to react-scripts. + // It usually still works on npm 3 without this but it would be + // unfortunate to rely on, as react-scripts could be symlinked, + // and thus babel-runtime might not be resolvable from the source. + 'babel-runtime': path.dirname( + require.resolve('babel-runtime/package.json') + ), + // @remove-on-eject-end + // Support React Native Web + // https://www.smashingmagazine.com/2016/08/a-glimpse-into-the-future-with-react-native-for-web/ + 'react-native': 'react-native-web', + }, + plugins: [ + // Prevents users from importing files from outside of src/ (or node_modules/). + // This often causes confusion because we only process files within src/ with babel. + // To fix this, we prevent you from importing files out of src/ -- if you'd like to, + // please link the files into your node_modules/ and let module-resolution kick in. + // Make sure your source files are compiled, as they will not be processed in any way. + new ModuleScopePlugin(paths.appSrc, [paths.appPackageJson]), + ], + }, + module: { + strictExportPresence: true, + rules: [ + // TODO: Disable require.ensure as it's not a standard language feature. + // We are waiting for https://github.com/facebookincubator/create-react-app/issues/2176. + // { parser: { requireEnsure: false } }, + + // First, run the linter. + // It's important to do this before Babel processes the JS. + // { + // test: /\.(js|jsx|mjs)$/, + // enforce: 'pre', + // use: [ + // { + // options: { + // formatter: eslintFormatter, + // eslintPath: require.resolve('eslint'), + // // @remove-on-eject-begin + // // TODO: consider separate config for production, + // // e.g. to enable no-console and no-debugger only in production. + // baseConfig: { + // extends: [require.resolve('eslint-config-react-app')], + // }, + // ignore: false, + // useEslintrc: false, + // // @remove-on-eject-end + // }, + // loader: require.resolve('eslint-loader'), + // }, + // ], + // include: paths.appSrc, + // }, + { + test: new RegExp( + `(^|/)(${(bpkReactScriptsConfig.amdExcludes || []) + .concat('lodash') + .join('|')})(/|.|$)` + ), + parser: { + amd: false, + }, + }, + { + // "oneOf" will traverse all following loaders until one will + // match the requirements. When no loader matches it will fall + // back to the "file" loader at the end of the loader list. + oneOf: [ + // "url" loader works just like "file" loader but it also embeds + // assets smaller than specified size as data URLs to avoid requests. + { + test: [/\.bmp$/, /\.gif$/, /\.jpe?g$/, /\.png$/], + loader: require.resolve('url-loader'), + options: { + limit: 10000, + name: 'static/media/[name].[hash:8].[ext]', + }, + }, + // Process JS with Babel. + { + test: /\.(js|jsx|mjs)$/, + include: [ + paths.appSrc, + paths.backpackModulesRegex, + paths.saddlebagModulesRegex, + ...customModuleRegexes, + ], + loader: require.resolve('babel-loader'), + options: { + // @remove-on-eject-begin + babelrc: false, + presets: [require.resolve('babel-preset-react-app')], + // @remove-on-eject-end + compact: true, + }, + }, + // The notation here is somewhat confusing. + // "postcss" loader applies autoprefixer to our CSS. + // "css" loader resolves paths in CSS and adds assets as dependencies. + // "style" loader normally turns CSS into JS modules injecting <style>, + // but unlike in development configuration, we do something different. + // `ExtractTextPlugin` first applies the "postcss" and "css" loaders + // (second argument), then grabs the result CSS and puts it into a + // separate file in our build process. This way we actually ship + // a single CSS file in production instead of JS code injecting <style> + // tags. If you use code splitting, however, any async bundles will still + // use the "style" loader inside the async code so CSS from them won't be + // in the main CSS file. + { + test: /\.scss$/, + exclude: optInCssModules + ? [/\.module\.scss$/, paths.backpackModulesRegex] + : [], + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.scss$/, + { and: [paths.backpackModulesRegex, /\.scss$/] }, + ], + }, + ], + }, + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + { + loader: require.resolve('sass-loader'), + options: { + functions: sassFunctions, + }, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + { + test: /\.css$/, + exclude: optInCssModules + ? [/\.module\.css$/, paths.backpackModulesRegex] + : [], + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: !optInCssModules, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + { + test: { + and: [ + () => optInCssModules, + { + or: [ + /\.module\.css$/, + { and: [paths.backpackModulesRegex, /\.css$/] }, + ], + }, + ], + }, + loader: ExtractTextPlugin.extract( + Object.assign( + { + fallback: { + loader: require.resolve('style-loader'), + options: { + hmr: false, + }, + }, + use: [ + { + loader: require.resolve('css-loader'), + options: { + importLoaders: 1, + minimize: true, + sourceMap: shouldUseSourceMap, + modules: true, + localIdentName: '[local]-[hash:base64:5]', + getLocalIdent: getLocalIdent, + }, + }, + { + loader: require.resolve('postcss-loader'), + options: postcssOptions, + }, + ], + }, + extractTextPluginOptions + ) + ), + // Note: this won't work without `new ExtractTextPlugin()` in `plugins`. + }, + // "file" loader makes sure assets end up in the `build` folder. + // When you `import` an asset, you get its filename. + // This loader doesn't use a "test" so it will catch all modules + // that fall through the other loaders. + { + loader: require.resolve('file-loader'), + // Exclude `js` files to keep "css" loader working as it injects + // it's runtime that would otherwise processed through "file" loader. + // Also exclude `html` and `json` extensions so they get processed + // by webpacks internal loaders. + exclude: [/\.(js|jsx|mjs)$/, /\.html$/, /\.json$/], + options: { + name: 'static/media/[name].[hash:8].[ext]', + }, + }, + // ** STOP ** Are you adding a new loader? + // Make sure to add the new loader(s) before the "file" loader. + ], + }, + ], + }, + plugins: [ + // Makes some environment variables available in index.html. + // The public URL is available as %PUBLIC_URL% in index.html, e.g.: + // <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico"> + // In production, it will be an empty string unless you specify "homepage" + // in `package.json`, in which case it will be the pathname of that URL. + // new InterpolateHtmlPlugin(env.raw), + // Generates an `index.html` file with the <script> injected. + // new HtmlWebpackPlugin({ + // inject: true, + // template: paths.appHtml, + // minify: { + // removeComments: true, + // collapseWhitespace: true, + // removeRedundantAttributes: true, + // useShortDoctype: true, + // removeEmptyAttributes: true, + // removeStyleLinkTypeAttributes: true, + // keepClosingSlash: true, + // minifyJS: true, + // minifyCSS: true, + // minifyURLs: true, + // }, + // }), + // Makes some environment variables available to the JS code, for example: + // if (process.env.NODE_ENV === 'production') { ... }. See `./env.js`. + // It is absolutely essential that NODE_ENV was set to production here. + // Otherwise React will be compiled in the very slow development mode. + new webpack.DefinePlugin(env.stringified), + // Minify the code. + // new webpack.optimize.UglifyJsPlugin({ + // compress: { + // warnings: false, + // // Disabled because of an issue with Uglify breaking seemingly valid code: + // // https://github.com/facebookincubator/create-react-app/issues/2376 + // // Pending further investigation: + // // https://github.com/mishoo/UglifyJS2/issues/2011 + // comparisons: false, + // }, + // output: { + // comments: false, + // // Turned on because emoji and regex is not minified properly using default + // // https://github.com/facebookincubator/create-react-app/issues/2488 + // ascii_only: true, + // }, + // sourceMap: shouldUseSourceMap, + // }), + // Note: this won't work without ExtractTextPlugin.extract(..) in `loaders`. + new ExtractTextPlugin({ + // filename: cssFilename, + filename: 'ssr.css', + }), + // Generate a manifest file which contains a mapping of all asset filenames + // to their corresponding output file so that tools can pick it up without + // having to parse `index.html`. + // new ManifestPlugin({ + // fileName: 'asset-manifest.json', + // }), + // Generate a service worker script that will precache, and keep up to date, + // the HTML & assets that are part of the Webpack build. + // new SWPrecacheWebpackPlugin({ + // By default, a cache-busting query parameter is appended to requests + // // used to populate the caches, to ensure the responses are fresh. + // // If a URL is already hashed by Webpack, then there is no concern + // // about it being stale, and the cache-busting can be skipped. + // dontCacheBustUrlsMatching: /\.\w{8}\./, + // filename: 'service-worker.js', + // logger(message) { + // if (message.indexOf('Total precache size is') === 0) { + // // This message occurs for every build and is a bit too noisy. + // return; + // } + // if (message.indexOf('Skipping static resource') === 0) { + // // This message obscures real errors so we ignore it. + // // https://github.com/facebookincubator/create-react-app/issues/2612 + // return; + // } + // console.log(message); + // }, + // minify: true, + // // For unknown URLs, fallback to the index page + // navigateFallback: publicUrl + '/index.html', + // // Ignores URLs starting from /__ (useful for Firebase): + // // https://github.com/facebookincubator/create-react-app/issues/2237#issuecomment-302693219 + // navigateFallbackWhitelist: [/^(?!\/__).*/], + // // Don't precache sourcemaps (they're large) and build asset manifest: + // staticFileGlobsIgnorePatterns: [/\.map$/, /asset-manifest\.json$/], + // }), + // Moment.js is an extremely popular library that bundles large locale files + // by default due to how Webpack interprets its code. This is a practical + // solution that requires the user to opt into importing specific locales. + // https://github.com/jmblog/how-to-optimize-momentjs-with-webpack + // You can remove this if you don't use Moment.js: + new webpack.IgnorePlugin(/^\.\/locale$/, /moment$/), + new OptimizeCssAssetsPlugin({ + cssProcessorOptions: { + postcssZindex: { + disable: true, + }, + autoprefixer: { disable: true }, + postcssDiscardComments: { + disable: true, + }, + map: { + inline: false, + }, + }, + }), + ], + // Some libraries import Node modules but don't use them in the browser. + // Tell Webpack to provide empty mocks for them so importing them works. + // node: { + // dgram: 'empty', + // fs: 'empty', + // net: 'empty', + // tls: 'empty', + // child_process: 'empty', + // }, +}; diff --git a/packages/react-scripts/package.json b/packages/react-scripts/package.json index ecb94de4970..4cac3f08dad 100644 --- a/packages/react-scripts/package.json +++ b/packages/react-scripts/package.json @@ -1,15 +1,12 @@ { - "name": "react-scripts", - "version": "1.1.5", - "description": "Configuration and scripts for Create React App.", - "repository": "facebookincubator/create-react-app", + "name": "backpack-react-scripts", + "version": "6.0.0", + "description": "Backpack configuration and scripts for Create React App.", + "repository": "Skyscanner/backpack-react-scripts", "license": "MIT", "engines": { "node": ">=6" }, - "bugs": { - "url": "https://github.com/facebookincubator/create-react-app/issues" - }, "files": [ "bin", "config", @@ -23,36 +20,46 @@ "dependencies": { "autoprefixer": "7.1.6", "babel-core": "6.26.0", - "babel-eslint": "7.2.3", + "babel-eslint": "^8.2.6", "babel-jest": "20.0.3", "babel-loader": "7.1.2", "babel-preset-react-app": "^3.1.2", "babel-runtime": "6.26.0", + "bpk-mixins": "^17.2.1", "case-sensitive-paths-webpack-plugin": "2.1.1", "chalk": "1.1.3", "css-loader": "0.28.7", "dotenv": "4.0.0", "dotenv-expand": "4.2.0", - "eslint": "4.10.0", - "eslint-config-react-app": "^2.1.0", - "eslint-loader": "1.9.0", - "eslint-plugin-flowtype": "2.39.1", - "eslint-plugin-import": "2.8.0", - "eslint-plugin-jsx-a11y": "5.1.1", - "eslint-plugin-react": "7.4.0", + "eslint": "^4.19.1", + "eslint-config-airbnb": "^16.1.0", + "eslint-config-skyscanner": "^3.0.0", + "eslint-plugin-import": "^2.14.0", + "eslint-plugin-jsx-a11y": "^6.1.1", + "eslint-plugin-react": "^7.11.1", "extract-text-webpack-plugin": "3.0.2", "file-loader": "1.1.5", "fs-extra": "3.0.1", "html-webpack-plugin": "2.29.0", + "identity-obj-proxy": "^3.0.0", "jest": "20.0.4", + "lodash": "^4.17.10", + "node-sass": "^4.9.3", "object-assign": "4.1.1", + "optimize-css-assets-webpack-plugin": "^3.2.0", "postcss-flexbugs-fixes": "3.2.0", + "postcss-less": ">=1.1.0", "postcss-loader": "2.0.8", "promise": "8.0.1", "raf": "3.4.0", "react-dev-utils": "^5.0.2", "resolve": "1.6.0", + "sass-loader": "^7.1.0", "style-loader": "0.19.0", + "stylefmt": "^6.0.2", + "stylelint": "^8.4.0", + "stylelint-config-skyscanner": "^1.0.1", + "sugarss": ">=1.0.0", "sw-precache-webpack-plugin": "0.11.4", "url-loader": "0.6.2", "webpack": "3.8.1", @@ -61,8 +68,12 @@ "whatwg-fetch": "2.0.3" }, "devDependencies": { - "react": "^16.0.0", - "react-dom": "^16.0.0" + "bpk-component-button": "^2.1.17", + "bpk-component-code": "^1.1.21", + "bpk-component-text": "^1.0.77", + "bpk-stylesheets": "^3.2.124", + "react": "^16.4.2", + "react-dom": "^16.4.2" }, "optionalDependencies": { "fsevents": "^1.1.3" diff --git a/packages/react-scripts/scripts/build.js b/packages/react-scripts/scripts/build.js index 930897008e1..e3366fe9c40 100644 --- a/packages/react-scripts/scripts/build.js +++ b/packages/react-scripts/scripts/build.js @@ -27,6 +27,7 @@ const chalk = require('chalk'); const fs = require('fs-extra'); const webpack = require('webpack'); const config = require('../config/webpack.config.prod'); +const ssrConfig = require('../config/webpack.config.ssr'); const paths = require('../config/paths'); const checkRequiredFiles = require('react-dev-utils/checkRequiredFiles'); const formatWebpackMessages = require('react-dev-utils/formatWebpackMessages'); @@ -112,12 +113,42 @@ measureFileSizesBeforeBuild(paths.appBuild) function build(previousFileSizes) { console.log('Creating an optimized production build...'); - let compiler = webpack(config); + let finalConfig = config; + + // If an SSR entry file is found, lets make use of webpacks multi-compiler + // functionality to bundle it in parallel + var compileSsr = fs.existsSync(paths.appSsrJs); + if (compileSsr) { + finalConfig = [ssrConfig, config]; + } + + let compiler = webpack(finalConfig); return new Promise((resolve, reject) => { compiler.run((err, stats) => { if (err) { return reject(err); } + + // We don't want to make too many changes as it makes syncing back + // with upstream a pain. The rest of the code in this function relies on + // `config` and `stats` being an object as opposed to an array (from + // webpack's multi-compiler feature.) + if (compileSsr) { + stats = stats.stats[1]; + } + + // The SSR config still omits a css file - it's not yet possible to omit + // file output in ExtractTextPlugin. This is not needed so lets clean + // it up to avoid confusion. + var ssrCssPath = path.join(paths.appBuild, 'ssr.css'); + var ssrCssMapPath = path.join(paths.appBuild, 'ssr.css.map'); + if (fs.existsSync(ssrCssPath)) { + fs.unlinkSync(ssrCssPath); + } + if (fs.existsSync(ssrCssMapPath)) { + fs.unlinkSync(ssrCssMapPath); + } + const messages = formatWebpackMessages(stats.toJson({}, true)); if (messages.errors.length) { // Only keep the first error. Others are often indicative diff --git a/packages/react-scripts/scripts/eject.js b/packages/react-scripts/scripts/eject.js index c8438f5d156..3f6a36b56e6 100644 --- a/packages/react-scripts/scripts/eject.js +++ b/packages/react-scripts/scripts/eject.js @@ -211,10 +211,10 @@ inquirer }; // Add ESlint config - console.log(` Adding ${cyan('ESLint')} configuration`); - appPackage.eslintConfig = { - extends: 'react-app', - }; + // console.log(` Adding ${cyan('ESLint')} configuration`); + // appPackage.eslintConfig = { + // extends: 'react-app', + // }; fs.writeFileSync( path.join(appPath, 'package.json'), diff --git a/packages/react-scripts/scripts/init.js b/packages/react-scripts/scripts/init.js index b283bad6ee6..9fce3a26b11 100644 --- a/packages/react-scripts/scripts/init.js +++ b/packages/react-scripts/scripts/init.js @@ -40,6 +40,11 @@ module.exports = function( start: 'react-scripts start', build: 'react-scripts build', test: 'react-scripts test --env=jsdom', + 'lint:scss': "stylelint 'src/**/*.scss' --syntax scss", + 'lint:scss:fix': "stylefmt --recursive 'src/**/*.scss'", + 'lint:js': 'eslint . --ignore-path .gitignore --ext .js,.jsx', + 'lint:js:fix': 'npm run lint:js -- --fix', + lint: 'npm run lint:js && npm run lint:scss', eject: 'react-scripts eject', }; @@ -94,10 +99,10 @@ module.exports = function( if (useYarn) { command = 'yarnpkg'; - args = ['add']; + args = ['add', '--dev']; } else { command = 'npm'; - args = ['install', '--save', verbose && '--verbose'].filter(e => e); + args = ['install', '--save-dev', verbose && '--verbose'].filter(e => e); } args.push('react', 'react-dom'); @@ -119,16 +124,19 @@ module.exports = function( // Install react and react-dom for backward compatibility with old CRA cli // which doesn't install react and react-dom along with react-scripts // or template is presetend (via --internal-testing-template) - if (!isReactInstalled(appPackage) || template) { - console.log(`Installing react and react-dom using ${command}...`); - console.log(); + // if (!isReactInstalled(appPackage) || template) { + // console.log(`Installing react and react-dom using ${command}...`); + console.log( + `Installing ${chalk.cyan('Backpack')} dependencies using ${command}...` + ); + console.log(); - const proc = spawn.sync(command, args, { stdio: 'inherit' }); - if (proc.status !== 0) { - console.error(`\`${command} ${args.join(' ')}\` failed`); - return; - } + const proc = spawn.sync(command, args, { stdio: 'inherit' }); + if (proc.status !== 0) { + console.error(`\`${command} ${args.join(' ')}\` failed`); + return; } + // } // Display the most elegant way to cd. // This needs to handle an undefined originalDirectory for @@ -158,6 +166,9 @@ module.exports = function( console.log(chalk.cyan(` ${displayedCommand} test`)); console.log(' Starts the test runner.'); console.log(); + console.log(chalk.cyan(` ${displayedCommand} lint`)); + console.log(' Lints all JavaScript & SCSS.'); + console.log(); console.log( chalk.cyan(` ${displayedCommand} ${useYarn ? '' : 'run '}eject`) ); @@ -184,11 +195,11 @@ module.exports = function( console.log('Happy hacking!'); }; -function isReactInstalled(appPackage) { - const dependencies = appPackage.dependencies || {}; +// function isReactInstalled(appPackage) { +// const dependencies = appPackage.dependencies || {}; - return ( - typeof dependencies.react !== 'undefined' && - typeof dependencies['react-dom'] !== 'undefined' - ); -} +// return ( +// typeof dependencies.react !== 'undefined' && +// typeof dependencies['react-dom'] !== 'undefined' +// ); +// } diff --git a/packages/react-scripts/scripts/utils/createJestConfig.js b/packages/react-scripts/scripts/utils/createJestConfig.js index 4c428004a84..1be7fd3a586 100644 --- a/packages/react-scripts/scripts/utils/createJestConfig.js +++ b/packages/react-scripts/scripts/utils/createJestConfig.js @@ -11,6 +11,17 @@ const fs = require('fs'); const chalk = require('chalk'); const paths = require('../../config/paths'); +const pkgJson = require(paths.appPackageJson); +const bpkReactScriptsConfig = pkgJson['backpack-react-scripts'] || {}; + +const includePrefixes = bpkReactScriptsConfig.babelIncludePrefixes || []; +includePrefixes.unshift('bpk-'); +includePrefixes.unshift('saddlebag-'); + +const transformIgnorePattern = `[/\\\\]node_modules[/\\\\](?!${includePrefixes.join( + '|' +)}).+\\.(js|jsx|mjs)$`; + module.exports = (resolve, rootDir, isEjecting) => { // Use this instead of `paths.testsSetup` to avoid putting // an absolute filename into configuration after ejecting. @@ -34,14 +45,15 @@ module.exports = (resolve, rootDir, isEjecting) => { '^.+\\.(js|jsx|mjs)$': isEjecting ? '<rootDir>/node_modules/babel-jest' : resolve('config/jest/babelTransform.js'), - '^.+\\.css$': resolve('config/jest/cssTransform.js'), - '^(?!.*\\.(js|jsx|mjs|css|json)$)': resolve( + '^.+\\.s?css$': resolve('config/jest/cssTransform.js'), + '^(?!.*\\.(js|jsx|mjs|css|scss|json)$)': resolve( 'config/jest/fileTransform.js' ), }, - transformIgnorePatterns: ['[/\\\\]node_modules[/\\\\].+\\.(js|jsx|mjs)$'], + transformIgnorePatterns: [transformIgnorePattern], moduleNameMapper: { '^react-native$': 'react-native-web', + '^.+\\.s?css$': 'identity-obj-proxy', }, moduleFileExtensions: [ 'web.js', diff --git a/packages/react-scripts/template/.editorconfig b/packages/react-scripts/template/.editorconfig new file mode 100644 index 00000000000..6cd012bcc83 --- /dev/null +++ b/packages/react-scripts/template/.editorconfig @@ -0,0 +1,10 @@ +# http://editorconfig.org/ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/packages/react-scripts/template/.eslintrc b/packages/react-scripts/template/.eslintrc new file mode 100644 index 00000000000..82d0bc22bb9 --- /dev/null +++ b/packages/react-scripts/template/.eslintrc @@ -0,0 +1,15 @@ +{ + "extends": "skyscanner", + "env": { + "browser": true, + "jest": true + }, + "rules": { + "import/no-extraneous-dependencies": [ + "error", + { + "devDependencies": true + } + ] + } +} diff --git a/packages/react-scripts/template/.stylelintrc.json b/packages/react-scripts/template/.stylelintrc.json new file mode 100644 index 00000000000..4970010e461 --- /dev/null +++ b/packages/react-scripts/template/.stylelintrc.json @@ -0,0 +1,3 @@ +{ + "extends": "stylelint-config-skyscanner" +} diff --git a/packages/react-scripts/template/.template.dependencies.json b/packages/react-scripts/template/.template.dependencies.json new file mode 100644 index 00000000000..52ba7ce8173 --- /dev/null +++ b/packages/react-scripts/template/.template.dependencies.json @@ -0,0 +1,9 @@ +{ + "dependencies": { + "bpk-component-button": "*", + "bpk-component-code": "*", + "bpk-component-text": "*", + "bpk-mixins": "*", + "bpk-stylesheets": "*" + } +} diff --git a/packages/react-scripts/template/README.md b/packages/react-scripts/template/README.md index 5bbfc5f676f..15abe3db3b0 100644 --- a/packages/react-scripts/template/README.md +++ b/packages/react-scripts/template/README.md @@ -1,2486 +1,228 @@ -This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). +> *This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app) + + [backpack-react-scripts](https://github.com/Skyscanner/backpack-react-scripts/tree/master/packages/react-scripts).* + It is very similar to one that you would create using [Create React App](https://github.com/facebookincubator/create-react-app) + without [backpack-react-scripts](https://github.com/Skyscanner/backpack-react-scripts/tree/master/packages/react-scripts), + so please refer to [it's documentation](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) + for more usage information. -Below you will find some information on how to perform common tasks.<br> -You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md). +# [_Put your project name here_] -## Table of Contents +[_Add a brief description of your project here._] -- [Updating to New Releases](#updating-to-new-releases) -- [Sending Feedback](#sending-feedback) -- [Folder Structure](#folder-structure) -- [Available Scripts](#available-scripts) - - [npm start](#npm-start) - - [npm test](#npm-test) - - [npm run build](#npm-run-build) - - [npm run eject](#npm-run-eject) -- [Supported Browsers](#supported-browsers) -- [Supported Language Features and Polyfills](#supported-language-features-and-polyfills) -- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor) -- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor) -- [Debugging in the Editor](#debugging-in-the-editor) -- [Formatting Code Automatically](#formatting-code-automatically) -- [Changing the Page `<title>`](#changing-the-page-title) -- [Installing a Dependency](#installing-a-dependency) -- [Importing a Component](#importing-a-component) -- [Code Splitting](#code-splitting) -- [Adding a Stylesheet](#adding-a-stylesheet) -- [Post-Processing CSS](#post-processing-css) -- [Adding a CSS Preprocessor (Sass, Less etc.)](#adding-a-css-preprocessor-sass-less-etc) -- [Adding Images, Fonts, and Files](#adding-images-fonts-and-files) -- [Using the `public` Folder](#using-the-public-folder) - - [Changing the HTML](#changing-the-html) - - [Adding Assets Outside of the Module System](#adding-assets-outside-of-the-module-system) - - [When to Use the `public` Folder](#when-to-use-the-public-folder) -- [Using Global Variables](#using-global-variables) -- [Adding Bootstrap](#adding-bootstrap) - - [Using a Custom Theme](#using-a-custom-theme) -- [Adding Flow](#adding-flow) -- [Adding a Router](#adding-a-router) -- [Adding Custom Environment Variables](#adding-custom-environment-variables) - - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html) - - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell) - - [Adding Development Environment Variables In `.env`](#adding-development-environment-variables-in-env) -- [Can I Use Decorators?](#can-i-use-decorators) -- [Fetching Data with AJAX Requests](#fetching-data-with-ajax-requests) -- [Integrating with an API Backend](#integrating-with-an-api-backend) - - [Node](#node) - - [Ruby on Rails](#ruby-on-rails) -- [Proxying API Requests in Development](#proxying-api-requests-in-development) - - ["Invalid Host Header" Errors After Configuring Proxy](#invalid-host-header-errors-after-configuring-proxy) - - [Configuring the Proxy Manually](#configuring-the-proxy-manually) - - [Configuring a WebSocket Proxy](#configuring-a-websocket-proxy) -- [Using HTTPS in Development](#using-https-in-development) -- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server) -- [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files) -- [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page) -- [Running Tests](#running-tests) - - [Filename Conventions](#filename-conventions) - - [Command Line Interface](#command-line-interface) - - [Version Control Integration](#version-control-integration) - - [Writing Tests](#writing-tests) - - [Testing Components](#testing-components) - - [Using Third Party Assertion Libraries](#using-third-party-assertion-libraries) - - [Initializing Test Environment](#initializing-test-environment) - - [Focusing and Excluding Tests](#focusing-and-excluding-tests) - - [Coverage Reporting](#coverage-reporting) - - [Continuous Integration](#continuous-integration) - - [Disabling jsdom](#disabling-jsdom) - - [Snapshot Testing](#snapshot-testing) - - [Editor Integration](#editor-integration) -- [Debugging Tests](#debugging-tests) - - [Debugging Tests in Chrome](#debugging-tests-in-chrome) - - [Debugging Tests in Visual Studio Code](#debugging-tests-in-visual-studio-code) -- [Developing Components in Isolation](#developing-components-in-isolation) - - [Getting Started with Storybook](#getting-started-with-storybook) - - [Getting Started with Styleguidist](#getting-started-with-styleguidist) -- [Publishing Components to npm](#publishing-components-to-npm) -- [Making a Progressive Web App](#making-a-progressive-web-app) - - [Opting Out of Caching](#opting-out-of-caching) - - [Offline-First Considerations](#offline-first-considerations) - - [Progressive Web App Metadata](#progressive-web-app-metadata) -- [Analyzing the Bundle Size](#analyzing-the-bundle-size) -- [Deployment](#deployment) - - [Static Server](#static-server) - - [Other Solutions](#other-solutions) - - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing) - - [Building for Relative Paths](#building-for-relative-paths) - - [Azure](#azure) - - [Firebase](#firebase) - - [GitHub Pages](#github-pages) - - [Heroku](#heroku) - - [Netlify](#netlify) - - [Now](#now) - - [S3 and CloudFront](#s3-and-cloudfront) - - [Surge](#surge) -- [Advanced Configuration](#advanced-configuration) -- [Troubleshooting](#troubleshooting) - - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes) - - [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra) - - [`npm run build` exits too early](#npm-run-build-exits-too-early) - - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku) - - [`npm run build` fails to minify](#npm-run-build-fails-to-minify) - - [Moment.js locales are missing](#momentjs-locales-are-missing) -- [Alternatives to Ejecting](#alternatives-to-ejecting) -- [Something Missing?](#something-missing) +## npm script commands -## Updating to New Releases +`backpack-react-scripts` is listed as a `devDependency` in your [package.json](./package.json) and exposes the following +npm scripts: -Create React App is divided into two packages: +- `npm start`: Runs the app in development mode. Open [http://localhost:3000/](http://localhost:3000/) to + view it in the browser. The page will reload if you make edits. You will see the build errors in the console. +- `npm test`: Runs the test watcher in an interactive mode. By default, runs tests related to files changes + since the last commit. +- `npm run build`: Builds the app for production to the build folder. It correctly bundles React in production mode + and optimizes the build for the best performance. The build is minified and the filenames include the hashes. + Your app is ready to be deployed! +- `npm run lint`: Lints all javascript using [`eslint-config-skyscanner`](https://www.npmjs.com/package/eslint-config-skyscanner). -* `create-react-app` is a global command-line utility that you use to create new projects. -* `react-scripts` is a development dependency in the generated projects (including this one). +## Excluding React / ReactDOM from the output bundle -You almost never need to update `create-react-app` itself: it delegates all the setup to `react-scripts`. - -When you run `create-react-app`, it always creates the project with the latest version of `react-scripts` so you’ll get all the new features and improvements in newly created apps automatically. - -To update an existing project to a new version of `react-scripts`, [open the changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md), find the version you’re currently on (check `package.json` in this folder if you’re not sure), and apply the migration instructions for the newer versions. - -In most cases bumping the `react-scripts` version in `package.json` and running `npm install` in this folder should be enough, but it’s good to consult the [changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md) for potential breaking changes. - -We commit to keeping the breaking changes minimal so you can upgrade `react-scripts` painlessly. - -## Sending Feedback - -We are always open to [your feedback](https://github.com/facebookincubator/create-react-app/issues). - -## Folder Structure - -After creation, your project should look like this: - -``` -my-app/ - README.md - node_modules/ - package.json - public/ - index.html - favicon.ico - src/ - App.css - App.js - App.test.js - index.css - index.js - logo.svg -``` - -For the project to build, **these files must exist with exact filenames**: - -* `public/index.html` is the page template; -* `src/index.js` is the JavaScript entry point. - -You can delete or rename the other files. - -You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br> -You need to **put any JS and CSS files inside `src`**, otherwise Webpack won’t see them. - -Only files inside `public` can be used from `public/index.html`.<br> -Read instructions below for using assets from JavaScript and HTML. - -You can, however, create more top-level directories.<br> -They will not be included in the production build so you can use them for things like documentation. - -## Available Scripts - -In the project directory, you can run: - -### `npm start` - -Runs the app in the development mode.<br> -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.<br> -You will also see any lint errors in the console. - -### `npm test` - -Launches the test runner in the interactive watch mode.<br> -See the section about [running tests](#running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.<br> -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.<br> -Your app is ready to be deployed! - -See the section about [deployment](#deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Supported Browsers - -By default, the generated project uses the latest version of React. - -You can refer [to the React documentation](https://reactjs.org/docs/react-dom.html#browser-support) for more information about supported browsers. - -## Supported Language Features and Polyfills - -This project supports a superset of the latest JavaScript standard.<br> -In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports: - -* [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016). -* [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017). -* [Object Rest/Spread Properties](https://github.com/sebmarkbage/ecmascript-rest-spread) (stage 3 proposal). -* [Dynamic import()](https://github.com/tc39/proposal-dynamic-import) (stage 3 proposal) -* [Class Fields and Static Properties](https://github.com/tc39/proposal-class-public-fields) (part of stage 3 proposal). -* [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) and [Flow](https://flowtype.org/) syntax. - -Learn more about [different proposal stages](https://babeljs.io/docs/plugins/#presets-stage-x-experimental-presets-). - -While we recommend using experimental proposals with some caution, Facebook heavily uses these features in the product code, so we intend to provide [codemods](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) if any of these proposals change in the future. - -Note that **the project only includes a few ES6 [polyfills](https://en.wikipedia.org/wiki/Polyfill)**: - -* [`Object.assign()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) via [`object-assign`](https://github.com/sindresorhus/object-assign). -* [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) via [`promise`](https://github.com/then/promise). -* [`fetch()`](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) via [`whatwg-fetch`](https://github.com/github/fetch). - -If you use any other ES6+ features that need **runtime support** (such as `Array.from()` or `Symbol`), make sure you are including the appropriate polyfills manually, or that the browsers you are targeting already support them. - -Also note that using some newer syntax features like `for...of` or `[...nonArrayValue]` causes Babel to emit code that depends on ES6 runtime features and might not work without a polyfill. When in doubt, use [Babel REPL](https://babeljs.io/repl/) to see what any specific syntax compiles down to. - -## Syntax Highlighting in the Editor - -To configure the syntax highlighting in your favorite text editor, head to the [relevant Babel documentation page](https://babeljs.io/docs/editors) and follow the instructions. Some of the most popular editors are covered. - -## Displaying Lint Output in the Editor - ->Note: this feature is available with `react-scripts@0.2.0` and higher.<br> ->It also only works with npm 3 or higher. - -Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint. - -They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do. - -You would need to install an ESLint plugin for your editor first. Then, add a file called `.eslintrc` to the project root: - -```js -{ - "extends": "react-app" -} -``` - -Now your editor should report the linting warnings. - -Note that even if you edit your `.eslintrc` file further, these changes will **only affect the editor integration**. They won’t affect the terminal and in-browser lint output. This is because Create React App intentionally provides a minimal set of rules that find common mistakes. - -If you want to enforce a coding style for your project, consider using [Prettier](https://github.com/jlongster/prettier) instead of ESLint style rules. - -## Debugging in the Editor - -**This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) and [WebStorm](https://www.jetbrains.com/webstorm/).** - -Visual Studio Code and WebStorm support debugging out of the box with Create React App. This enables you as a developer to write and debug your React code without leaving the editor, and most importantly it enables you to have a continuous development workflow, where context switching is minimal, as you don’t have to switch between tools. - -### Visual Studio Code - -You would need to have the latest version of [VS Code](https://code.visualstudio.com) and VS Code [Chrome Debugger Extension](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) installed. - -Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory. +Sometimes you need to exclude React (or any module) from your app's bundle for performance / code sharing reasons +(i.e. if it's on the page already). To do this, add the following to your `package.json`: ```json { - "version": "0.2.0", - "configurations": [{ - "name": "Chrome", - "type": "chrome", - "request": "launch", - "url": "http://localhost:3000", - "webRoot": "${workspaceRoot}/src", - "sourceMapPathOverrides": { - "webpack:///src/*": "${webRoot}/*" + ... + "backpack-react-scripts": { + "externals": { + "react": "React", + "react-dom": "ReactDOM" } - }] + } } ``` ->Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration). - -Start your app by running `npm start`, and start debugging in VS Code by pressing `F5` or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor. - -Having problems with VS Code Debugging? Please see their [troubleshooting guide](https://github.com/Microsoft/vscode-chrome-debug/blob/master/README.md#troubleshooting). - -### WebStorm - -You would need to have [WebStorm](https://www.jetbrains.com/webstorm/) and [JetBrains IDE Support](https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji) Chrome extension installed. - -In the WebStorm menu `Run` select `Edit Configurations...`. Then click `+` and select `JavaScript Debug`. Paste `http://localhost:3000` into the URL field and save the configuration. - ->Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration). - -Start your app by running `npm start`, then press `^D` on macOS or `F9` on Windows and Linux or click the green debug icon to start debugging in WebStorm. - -The same way you can debug your application in IntelliJ IDEA Ultimate, PhpStorm, PyCharm Pro, and RubyMine. -## Formatting Code Automatically +Now when you run `npm run build`, every `'react'` / `'react-dom'` import is replaced with `window.React` / `window.ReactDOM`. +You'll also notice that the output bundle size is dramatically smaller. *Note:* You are responsible for ensuring that React is +loaded before your app is! -Prettier is an opinionated code formatter with support for JavaScript, CSS and JSON. With Prettier you can format the code you write automatically to ensure a code style within your project. See the [Prettier's GitHub page](https://github.com/prettier/prettier) for more information, and look at this [page to see it in action](https://prettier.github.io/prettier/). +## Server Side Rendering (SSR) -To format our code whenever we make a commit in git, we need to install the following dependencies: +Most of the time you wont need server side rendering, however if you need to generate your app's HTML on +the server and send the markup down on the initial request to improve perceived page load or to allow search engines +to crawl your pages for SEO purposes, then create a file named `ssr.js` in your app's root folder: -```sh -npm install --save husky lint-staged prettier ``` - -Alternatively you may use `yarn`: - -```sh -yarn add husky lint-staged prettier +my-app/ + src/ + ... + index.js + ssr.js // <-- create this file ``` -* `husky` makes it easy to use githooks as if they are npm scripts. -* `lint-staged` allows us to run scripts on staged files in git. See this [blog post about lint-staged to learn more about it](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8). -* `prettier` is the JavaScript formatter we will run before commits. +Inside `ssr.js`, export the components that you wish to expose for server side rendering - the file contents should look +something like this: -Now we can make sure every file is formatted correctly by adding a few lines to the `package.json` in the project root. - -Add the following line to `scripts` section: - -```diff - "scripts": { -+ "precommit": "lint-staged", - "start": "react-scripts start", - "build": "react-scripts build", -``` - -Next we add a 'lint-staged' field to the `package.json`, for example: +```js +import App from './App'; -```diff - "dependencies": { - // ... - }, -+ "lint-staged": { -+ "src/**/*.{js,jsx,json,css}": [ -+ "prettier --single-quote --write", -+ "git add" -+ ] -+ }, - "scripts": { +export default { App }; ``` -Now, whenever you make a commit, Prettier will format the changed files automatically. You can also run `./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx,json,css}"` to format your entire project for the first time. - -Next you might want to integrate Prettier in your favorite editor. Read the section on [Editor Integration](https://prettier.io/docs/en/editors.html) on the Prettier GitHub page. - -## Changing the Page `<title>` - -You can find the source HTML file in the `public` folder of the generated project. You may edit the `<title>` tag in it to change the title from “React App” to anything else. - -Note that normally you wouldn’t edit files in the `public` folder very often. For example, [adding a stylesheet](#adding-a-stylesheet) is done without touching the HTML. - -If you need to dynamically update the page title based on the content, you can use the browser [`document.title`](https://developer.mozilla.org/en-US/docs/Web/API/Document/title) API. For more complex scenarios when you want to change the title from React components, you can use [React Helmet](https://github.com/nfl/react-helmet), a third party library. - -If you use a custom server for your app in production and want to modify the title before it gets sent to the browser, you can follow advice in [this section](#generating-dynamic-meta-tags-on-the-server). Alternatively, you can pre-build each page as a static HTML file which then loads the JavaScript bundle, which is covered [here](#pre-rendering-into-static-html-files). - -## Installing a Dependency - -The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency. You may install other dependencies (for example, React Router) with `npm`: - -```sh -npm install --save react-router +Run `npm run build` as you would to build a production browser bundle - you should notice an additional `ssr.js` file in +the output directory: ``` - -Alternatively you may use `yarn`: - -```sh -yarn add react-router +my-app/ + build/ + static/ + asset-manifest.json + favicon.ico + index.html + ssr.js // <-- new output file ``` -This works for any library, not just `react-router`. - -## Importing a Component - -This project setup supports ES6 modules thanks to Babel.<br> -While you can still use `require()` and `module.exports`, we encourage you to use [`import` and `export`](http://exploringjs.com/es6/ch_modules.html) instead. +This file can now be required and pre-rendered on the server like so (rough implementation): -For example: - -### `Button.js` +`server.js`: ```js -import React, { Component } from 'react'; - -class Button extends Component { - render() { - // ... - } -} - -export default Button; // Don’t forget to use export default! -``` +const React = require('react'); +const express = require('express'); +const ReactDOMServer = require('react-dom/server'); -### `DangerButton.js` +const components = require('./my-app/build/ssr').default; +const router = express.Router(); -```js -import React, { Component } from 'react'; -import Button from './Button'; // Import a component from another file +router.get('/', (req, res) => { + const element = React.createElement(components.App); + const html = ReactDOMServer.renderToString(element); -class DangerButton extends Component { - render() { - return <Button color="red" />; - } -} + res.render('index', { html }); +}); -export default DangerButton; +module.exports = router; ``` -Be aware of the [difference between default and named exports](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281). It is a common source of mistakes. - -We suggest that you stick to using default imports and exports when a module only exports a single thing (for example, a component). That’s what you get when you use `export default Button` and `import Button from './Button'`. - -Named exports are useful for utility modules that export several functions. A module may have at most one default export and as many named exports as you like. - -Learn more about ES6 modules: - -* [When to use the curly braces?](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281) -* [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html) -* [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules) - -## Code Splitting +`index.html`: -Instead of downloading the entire app before users can use it, code splitting allows you to split your code into small chunks which you can then load on demand. - -This project setup supports code splitting via [dynamic `import()`](http://2ality.com/2017/01/import-operator.html#loading-code-on-demand). Its [proposal](https://github.com/tc39/proposal-dynamic-import) is in stage 3. The `import()` function-like form takes the module name as an argument and returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which always resolves to the namespace object of the module. - -Here is an example: - -### `moduleA.js` - -```js -const moduleA = 'Hello'; - -export { moduleA }; +```html +<div id="root">{{{html}}}</div> ``` -### `App.js` -```js -import React, { Component } from 'react'; +If you call `ReactDOM.render()` on a node that already has this server-rendered markup (`<div id="root">` in the example +above), React will preserve it and only attach event handlers, allowing you to have a very performant first-load experience. -class App extends Component { - handleClick = () => { - import('./moduleA') - .then(({ moduleA }) => { - // Use moduleA - }) - .catch(err => { - // Handle failure - }); - }; +**Note:** Your external module imports (anything you import from `node_modules/` i.e. `import React from 'react';`) are bundled +into the `ssr.js` output file. If you want to exclude any external modules from the output file for performance / code sharing +reasons (i.e. if it's beign required elsewhere and is already in memory) you can do so by adding the following to your +`package.json`: - render() { - return ( - <div> - <button onClick={this.handleClick}>Load</button> - </div> - ); +```json +{ + ... + "backpack-react-scripts": { + "ssrExternals": [ + "react", + "react-dom" + ] } } - -export default App; -``` - -This will make `moduleA.js` and all its unique dependencies as a separate chunk that only loads after the user clicks the 'Load' button. - -You can also use it with `async` / `await` syntax if you prefer it. - -### With React Router - -If you are using React Router check out [this tutorial](http://serverless-stack.com/chapters/code-splitting-in-create-react-app.html) on how to use code splitting with it. You can find the companion GitHub repository [here](https://github.com/AnomalyInnovations/serverless-stack-demo-client/tree/code-splitting-in-create-react-app). - -Also check out the [Code Splitting](https://reactjs.org/docs/code-splitting.html) section in React documentation. - -## Adding a Stylesheet - -This project setup uses [Webpack](https://webpack.js.org/) for handling all assets. Webpack offers a custom way of “extending” the concept of `import` beyond JavaScript. To express that a JavaScript file depends on a CSS file, you need to **import the CSS from the JavaScript file**: - -### `Button.css` - -```css -.Button { - padding: 20px; -} ``` -### `Button.js` +## Compiling `node_modules` dependencies -```js -import React, { Component } from 'react'; -import './Button.css'; // Tell Webpack that Button.js uses these styles +By default, modules imported from your app's `node_modules` directory will not get compiled by Babel. This is mostly for webpack +performance reasons but also because 3rd party dependencies published to npm typically only expose precompiled ES5 code. +Publishing non ES5 code is not advised as there is no reliable way for the consumer to know what ES2015 features you are using. +That being said there are some exceptions, particularly when you want to share React components that import CSS stylesheets. +For this purpose you can add the following to your `package.json`: -class Button extends Component { - render() { - // You can use them as regular CSS styles - return <div className="Button" />; +```json +{ + ... + "backpack-react-scripts": { + "babelIncludePrefixes": [ + "my-module-prefix-", + "some-module" + ] } } ``` -**This is not required for React** but many people find this feature convenient. You can read about the benefits of this approach [here](https://medium.com/seek-blog/block-element-modifying-your-javascript-components-d7f99fcab52b). However you should be aware that this makes your code less portable to other build tools and environments than Webpack. - -In development, expressing dependencies this way allows your styles to be reloaded on the fly as you edit them. In production, all CSS files will be concatenated into a single minified `.css` file in the build output. - -If you are concerned about using Webpack-specific semantics, you can put all your CSS right into `src/index.css`. It would still be imported from `src/index.js`, but you could always remove that import if you later migrate to a different build tool. - -## Post-Processing CSS - -This project setup minifies your CSS and adds vendor prefixes to it automatically through [Autoprefixer](https://github.com/postcss/autoprefixer) so you don’t need to worry about it. - -For example, this: +The above example assumes that the module you want to compile is named with the prefix `my-module-prefix-` and a module +with the name `some-module`. All entries in this array act as prefixes. It is used by all webpack configurations +as well as the Jest configuration — if you want to avoid compiling a dependency in tests, you should mock it. -```css -.App { - display: flex; - flex-direction: row; - align-items: center; -} -``` +## Disabling AMD parsing for certain modules -becomes this: +If you need to disable AMD module support for whatever reason, you can add the following to your `package.json`: -```css -.App { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-orient: horizontal; - -webkit-box-direction: normal; - -ms-flex-direction: row; - flex-direction: row; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; +```json +{ + ... + "backpack-react-scripts": { + "amdExcludes": [ + "globalize" + ] + } } ``` -If you need to disable autoprefixing for some reason, [follow this section](https://github.com/postcss/autoprefixer#disabling). - -## Adding a CSS Preprocessor (Sass, Less etc.) - -Generally, we recommend that you don’t reuse the same CSS classes across different components. For example, instead of using a `.Button` CSS class in `<AcceptButton>` and `<RejectButton>` components, we recommend creating a `<Button>` component with its own `.Button` styles, that both `<AcceptButton>` and `<RejectButton>` can render (but [not inherit](https://facebook.github.io/react/docs/composition-vs-inheritance.html)). - -Following this rule often makes CSS preprocessors less useful, as features like mixins and nesting are replaced by component composition. You can, however, integrate a CSS preprocessor if you find it valuable. In this walkthrough, we will be using Sass, but you can also use Less, or another alternative. - -First, let’s install the command-line interface for Sass: - -```sh -npm install --save node-sass-chokidar -``` - -Alternatively you may use `yarn`: - -```sh -yarn add node-sass-chokidar -``` - -Then in `package.json`, add the following lines to `scripts`: - -```diff - "scripts": { -+ "build-css": "node-sass-chokidar src/ -o src/", -+ "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive", - "start": "react-scripts start", - "build": "react-scripts build", - "test": "react-scripts test --env=jsdom", -``` - ->Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation. - -Now you can rename `src/App.css` to `src/App.scss` and run `npm run watch-css`. The watcher will find every Sass file in `src` subdirectories, and create a corresponding CSS file next to it, in our case overwriting `src/App.css`. Since `src/App.js` still imports `src/App.css`, the styles become a part of your application. You can now edit `src/App.scss`, and `src/App.css` will be regenerated. - -To share variables between Sass files, you can use Sass imports. For example, `src/App.scss` and other component style files could include `@import "./shared.scss";` with variable definitions. - -To enable importing files without using relative paths, you can add the `--include-path` option to the command in `package.json`. - -``` -"build-css": "node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/", -"watch-css": "npm run build-css && node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/ --watch --recursive", -``` - -This will allow you to do imports like - -```scss -@import 'styles/_colors.scss'; // assuming a styles directory under src/ -@import 'nprogress/nprogress'; // importing a css file from the nprogress node module -``` - -At this point you might want to remove all CSS files from the source control, and add `src/**/*.css` to your `.gitignore` file. It is generally a good practice to keep the build products outside of the source control. - -As a final step, you may find it convenient to run `watch-css` automatically with `npm start`, and run `build-css` as a part of `npm run build`. You can use the `&&` operator to execute two scripts sequentially. However, there is no cross-platform way to run two scripts in parallel, so we will install a package for this: - -```sh -npm install --save npm-run-all -``` - -Alternatively you may use `yarn`: +The above example disables AMD support for the `globalize` dependency and overcomes issues such as: ```sh -yarn add npm-run-all -``` - -Then we can change `start` and `build` scripts to include the CSS preprocessor commands: - -```diff - "scripts": { - "build-css": "node-sass-chokidar src/ -o src/", - "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive", -- "start": "react-scripts start", -- "build": "react-scripts build", -+ "start-js": "react-scripts start", -+ "start": "npm-run-all -p watch-css start-js", -+ "build-js": "react-scripts build", -+ "build": "npm-run-all build-css build-js", - "test": "react-scripts test --env=jsdom", - "eject": "react-scripts eject" - } -``` - -Now running `npm start` and `npm run build` also builds Sass files. - -**Why `node-sass-chokidar`?** - -`node-sass` has been reported as having the following issues: - -- `node-sass --watch` has been reported to have *performance issues* in certain conditions when used in a virtual machine or with docker. - -- Infinite styles compiling [#1939](https://github.com/facebookincubator/create-react-app/issues/1939) - -- `node-sass` has been reported as having issues with detecting new files in a directory [#1891](https://github.com/sass/node-sass/issues/1891) - - `node-sass-chokidar` is used here as it addresses these issues. - -## Adding Images, Fonts, and Files - -With Webpack, using static assets like images and fonts works similarly to CSS. - -You can **`import` a file right in a JavaScript module**. This tells Webpack to include that file in the bundle. Unlike CSS imports, importing a file gives you a string value. This value is the final path you can reference in your code, e.g. as the `src` attribute of an image or the `href` of a link to a PDF. - -To reduce the number of requests to the server, importing images that are less than 10,000 bytes returns a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) instead of a path. This applies to the following file extensions: bmp, gif, jpg, jpeg, and png. SVG files are excluded due to [#1153](https://github.com/facebookincubator/create-react-app/issues/1153). - -Here is an example: - -```js -import React from 'react'; -import logo from './logo.png'; // Tell Webpack this JS file uses this image - -console.log(logo); // /logo.84287d09.png - -function Header() { - // Import result is the URL of your image - return <img src={logo} alt="Logo" />; -} - -export default Header; +Failed to compile. +./node_modules/globalize/dist/globalize.js +Module not found: Can't resolve 'cldr' in './node_modules/globalize/dist' ``` -This ensures that when the project is built, Webpack will correctly move the images into the build folder, and provide us with correct paths. +## Cross-origin loading of dynamic chunks -This works in CSS too: +You can configure [cross-origin loading](https://webpack.js.org/configuration/output/#output-crossoriginloading) of dynamic chunks like so: -```css -.Logo { - background-image: url(./logo.png); -} +```json + "backpack-react-scripts": { + "crossOriginLoading": "anonymous" + } ``` -Webpack finds all relative module references in CSS (they start with `./`) and replaces them with the final paths from the compiled bundle. If you make a typo or accidentally delete an important file, you will see a compilation error, just like when you import a non-existent JavaScript module. The final filenames in the compiled bundle are generated by Webpack from content hashes. If the file content changes in the future, Webpack will give it a different name in production so you don’t need to worry about long-term caching of assets. - -Please be advised that this is also a custom feature of Webpack. - -**It is not required for React** but many people enjoy it (and React Native uses a similar mechanism for images).<br> -An alternative way of handling static assets is described in the next section. - -## Using the `public` Folder +> **Note:** `lodash` is disabled by default. ->Note: this feature is available with `react-scripts@0.5.0` and higher. +## CSS Modules -### Changing the HTML +All Sass files are by default treated as [CSS Modules](https://github.com/css-modules/css-modules). You can opt out of this behaviour using the following config option: -The `public` folder contains the HTML file so you can tweak it, for example, to [set the page title](#changing-the-page-title). -The `<script>` tag with the compiled code will be added to it automatically during the build process. - -### Adding Assets Outside of the Module System - -You can also add other assets to the `public` folder. - -Note that we normally encourage you to `import` assets in JavaScript files instead. -For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-fonts-and-files). -This mechanism provides a number of benefits: - -* Scripts and stylesheets get minified and bundled together to avoid extra network requests. -* Missing files cause compilation errors instead of 404 errors for your users. -* Result filenames include content hashes so you don’t need to worry about browsers caching their old versions. - -However there is an **escape hatch** that you can use to add an asset outside of the module system. - -If you put a file into the `public` folder, it will **not** be processed by Webpack. Instead it will be copied into the build folder untouched. To reference assets in the `public` folder, you need to use a special variable called `PUBLIC_URL`. - -Inside `index.html`, you can use it like this: - -```html -<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico"> ``` - -Only files inside the `public` folder will be accessible by `%PUBLIC_URL%` prefix. If you need to use a file from `src` or `node_modules`, you’ll have to copy it there to explicitly specify your intention to make this file a part of the build. - -When you run `npm run build`, Create React App will substitute `%PUBLIC_URL%` with a correct absolute path so your project works even if you use client-side routing or host it at a non-root URL. - -In JavaScript code, you can use `process.env.PUBLIC_URL` for similar purposes: - -```js -render() { - // Note: this is an escape hatch and should be used sparingly! - // Normally we recommend using `import` for getting asset URLs - // as described in “Adding Images and Fonts” above this section. - return <img src={process.env.PUBLIC_URL + '/img/logo.png'} />; +"backpack-react-scripts": { + "cssModules": false } ``` -Keep in mind the downsides of this approach: - -* None of the files in `public` folder get post-processed or minified. -* Missing files will not be called at compilation time, and will cause 404 errors for your users. -* Result filenames won’t include content hashes so you’ll need to add query arguments or rename them every time they change. - -### When to Use the `public` Folder - -Normally we recommend importing [stylesheets](#adding-a-stylesheet), [images, and fonts](#adding-images-fonts-and-files) from JavaScript. -The `public` folder is useful as a workaround for a number of less common cases: - -* You need a file with a specific name in the build output, such as [`manifest.webmanifest`](https://developer.mozilla.org/en-US/docs/Web/Manifest). -* You have thousands of images and need to dynamically reference their paths. -* You want to include a small script like [`pace.js`](http://github.hubspot.com/pace/docs/welcome/) outside of the bundled code. -* Some library may be incompatible with Webpack and you have no other option but to include it as a `<script>` tag. - -Note that if you add a `<script>` that declares global variables, you also need to read the next section on using them. - -## Using Global Variables - -When you include a script in the HTML file that defines global variables and try to use one of these variables in the code, the linter will complain because it cannot see the definition of the variable. - -You can avoid this by reading the global variable explicitly from the `window` object, for example: - -```js -const $ = window.$; -``` - -This makes it obvious you are using a global variable intentionally rather than because of a typo. - -Alternatively, you can force the linter to ignore any line by adding `// eslint-disable-line` after it. - -## Adding Bootstrap - -You don’t have to use [React Bootstrap](https://react-bootstrap.github.io) together with React but it is a popular library for integrating Bootstrap with React apps. If you need it, you can integrate it with Create React App by following these steps: - -Install React Bootstrap and Bootstrap from npm. React Bootstrap does not include Bootstrap CSS so this needs to be installed as well: - -```sh -npm install --save react-bootstrap bootstrap@3 -``` - -Alternatively you may use `yarn`: - -```sh -yarn add react-bootstrap bootstrap@3 -``` - -Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your ```src/index.js``` file: - -```js -import 'bootstrap/dist/css/bootstrap.css'; -import 'bootstrap/dist/css/bootstrap-theme.css'; -// Put any other imports below so that CSS from your -// components takes precedence over default styles. -``` - -Import required React Bootstrap components within ```src/App.js``` file or your custom component files: - -```js -import { Navbar, Jumbotron, Button } from 'react-bootstrap'; -``` - -Now you are ready to use the imported React Bootstrap components within your component hierarchy defined in the render method. Here is an example [`App.js`](https://gist.githubusercontent.com/gaearon/85d8c067f6af1e56277c82d19fd4da7b/raw/6158dd991b67284e9fc8d70b9d973efe87659d72/App.js) redone using React Bootstrap. - -### Using a Custom Theme - -Sometimes you might need to tweak the visual styles of Bootstrap (or equivalent package).<br> -We suggest the following approach: - -* Create a new package that depends on the package you wish to customize, e.g. Bootstrap. -* Add the necessary build steps to tweak the theme, and publish your package on npm. -* Install your own theme npm package as a dependency of your app. - -Here is an example of adding a [customized Bootstrap](https://medium.com/@tacomanator/customizing-create-react-app-aa9ffb88165) that follows these steps. - -## Adding Flow - -Flow is a static type checker that helps you write code with fewer bugs. Check out this [introduction to using static types in JavaScript](https://medium.com/@preethikasireddy/why-use-static-types-in-javascript-part-1-8382da1e0adb) if you are new to this concept. - -Recent versions of [Flow](http://flowtype.org/) work with Create React App projects out of the box. - -To add Flow to a Create React App project, follow these steps: - -1. Run `npm install --save flow-bin` (or `yarn add flow-bin`). -2. Add `"flow": "flow"` to the `scripts` section of your `package.json`. -3. Run `npm run flow init` (or `yarn flow init`) to create a [`.flowconfig` file](https://flowtype.org/docs/advanced-configuration.html) in the root directory. -4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`). - -Now you can run `npm run flow` (or `yarn flow`) to check the files for type errors. -You can optionally use an IDE like [Nuclide](https://nuclide.io/docs/languages/flow/) for a better integrated experience. -In the future we plan to integrate it into Create React App even more closely. - -To learn more about Flow, check out [its documentation](https://flowtype.org/). - -## Adding a Router - -Create React App doesn't prescribe a specific routing solution, but [React Router](https://reacttraining.com/react-router/) is the most popular one. - -To add it, run: - -```sh -npm install --save react-router-dom -``` - -Alternatively you may use `yarn`: - -```sh -yarn add react-router-dom -``` - -To try it, delete all the code in `src/App.js` and replace it with any of the examples on its website. The [Basic Example](https://reacttraining.com/react-router/web/example/basic) is a good place to get started. - -Note that [you may need to configure your production server to support client-side routing](#serving-apps-with-client-side-routing) before deploying your app. - -## Adding Custom Environment Variables - ->Note: this feature is available with `react-scripts@0.2.3` and higher. - -Your project can consume variables declared in your environment as if they were declared locally in your JS files. By -default you will have `NODE_ENV` defined for you, and any other environment variables starting with -`REACT_APP_`. - -**The environment variables are embedded during the build time**. Since Create React App produces a static HTML/CSS/JS bundle, it can’t possibly read them at runtime. To read them at runtime, you would need to load HTML into memory on the server and replace placeholders in runtime, just like [described here](#injecting-data-from-the-server-into-the-page). Alternatively you can rebuild the app on the server anytime you change them. - ->Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid accidentally [exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running. - -These environment variables will be defined for you on `process.env`. For example, having an environment -variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`. - -There is also a special built-in environment variable called `NODE_ENV`. You can read it from `process.env.NODE_ENV`. When you run `npm start`, it is always equal to `'development'`, when you run `npm test` it is always equal to `'test'`, and when you run `npm run build` to make a production bundle, it is always equal to `'production'`. **You cannot override `NODE_ENV` manually.** This prevents developers from accidentally deploying a slow development build to production. - -These environment variables can be useful for displaying information conditionally based on where the project is -deployed or consuming sensitive data that lives outside of version control. - -First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined -in the environment inside a `<form>`: - -```jsx -render() { - return ( - <div> - <small>You are running this application in <b>{process.env.NODE_ENV}</b> mode.</small> - <form> - <input type="hidden" defaultValue={process.env.REACT_APP_SECRET_CODE} /> - </form> - </div> - ); -} -``` - -During the build, `process.env.REACT_APP_SECRET_CODE` will be replaced with the current value of the `REACT_APP_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically. - -When you load the app in the browser and inspect the `<input>`, you will see its value set to `abcdef`, and the bold text will show the environment provided when using `npm start`: - -```html -<div> - <small>You are running this application in <b>development</b> mode.</small> - <form> - <input type="hidden" value="abcdef" /> - </form> -</div> -``` - -The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this -value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in -a `.env` file. Both of these ways are described in the next few sections. - -Having access to the `NODE_ENV` is also useful for performing actions conditionally: - -```js -if (process.env.NODE_ENV !== 'production') { - analytics.disable(); -} -``` - -When you compile the app with `npm run build`, the minification step will strip out this condition, and the resulting bundle will be smaller. - -### Referencing Environment Variables in the HTML - ->Note: this feature is available with `react-scripts@0.9.0` and higher. - -You can also access the environment variables starting with `REACT_APP_` in the `public/index.html`. For example: - -```html -<title>%REACT_APP_WEBSITE_NAME% -``` - -Note that the caveats from the above section apply: - -* Apart from a few built-in variables (`NODE_ENV` and `PUBLIC_URL`), variable names must start with `REACT_APP_` to work. -* The environment variables are injected at build time. If you need to inject them at runtime, [follow this approach instead](#generating-dynamic-meta-tags-on-the-server). - -### Adding Temporary Environment Variables In Your Shell - -Defining environment variables can vary between OSes. It’s also important to know that this manner is temporary for the -life of the shell session. - -#### Windows (cmd.exe) - -```cmd -set "REACT_APP_SECRET_CODE=abcdef" && npm start -``` - -(Note: Quotes around the variable assignment are required to avoid a trailing whitespace.) - -#### Windows (Powershell) - -```Powershell -($env:REACT_APP_SECRET_CODE = "abcdef") -and (npm start) -``` - -#### Linux, macOS (Bash) - -```bash -REACT_APP_SECRET_CODE=abcdef npm start -``` - -### Adding Development Environment Variables In `.env` - ->Note: this feature is available with `react-scripts@0.5.0` and higher. - -To define permanent environment variables, create a file called `.env` in the root of your project: - -``` -REACT_APP_SECRET_CODE=abcdef -``` ->Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid [accidentally exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running. - -`.env` files **should be** checked into source control (with the exclusion of `.env*.local`). - -#### What other `.env` files can be used? - ->Note: this feature is **available with `react-scripts@1.0.0` and higher**. - -* `.env`: Default. -* `.env.local`: Local overrides. **This file is loaded for all environments except test.** -* `.env.development`, `.env.test`, `.env.production`: Environment-specific settings. -* `.env.development.local`, `.env.test.local`, `.env.production.local`: Local overrides of environment-specific settings. - -Files on the left have more priority than files on the right: - -* `npm start`: `.env.development.local`, `.env.development`, `.env.local`, `.env` -* `npm run build`: `.env.production.local`, `.env.production`, `.env.local`, `.env` -* `npm test`: `.env.test.local`, `.env.test`, `.env` (note `.env.local` is missing) - -These variables will act as the defaults if the machine does not explicitly set them.
-Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details. - ->Note: If you are defining environment variables for development, your CI and/or hosting platform will most likely need -these defined as well. Consult their documentation how to do this. For example, see the documentation for [Travis CI](https://docs.travis-ci.com/user/environment-variables/) or [Heroku](https://devcenter.heroku.com/articles/config-vars). - -#### Expanding Environment Variables In `.env` - ->Note: this feature is available with `react-scripts@1.1.0` and higher. - -Expand variables already on your machine for use in your `.env` file (using [dotenv-expand](https://github.com/motdotla/dotenv-expand)). - -For example, to get the environment variable `npm_package_version`: - -``` -REACT_APP_VERSION=$npm_package_version -# also works: -# REACT_APP_VERSION=${npm_package_version} -``` - -Or expand variables local to the current `.env` file: - -``` -DOMAIN=www.example.com -REACT_APP_FOO=$DOMAIN/foo -REACT_APP_BAR=$DOMAIN/bar -``` - -## Can I Use Decorators? - -Many popular libraries use [decorators](https://medium.com/google-developers/exploring-es7-decorators-76ecb65fb841) in their documentation.
-Create React App doesn’t support decorator syntax at the moment because: - -* It is an experimental proposal and is subject to change. -* The current specification version is not officially supported by Babel. -* If the specification changes, we won’t be able to write a codemod because we don’t use them internally at Facebook. - -However in many cases you can rewrite decorator-based code without decorators just as fine.
-Please refer to these two threads for reference: - -* [#214](https://github.com/facebookincubator/create-react-app/issues/214) -* [#411](https://github.com/facebookincubator/create-react-app/issues/411) - -Create React App will add decorator support when the specification advances to a stable stage. - -## Fetching Data with AJAX Requests - -React doesn't prescribe a specific approach to data fetching, but people commonly use either a library like [axios](https://github.com/axios/axios) or the [`fetch()` API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) provided by the browser. Conveniently, Create React App includes a polyfill for `fetch()` so you can use it without worrying about the browser support. - -The global `fetch` function allows to easily makes AJAX requests. It takes in a URL as an input and returns a `Promise` that resolves to a `Response` object. You can find more information about `fetch` [here](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch). - -This project also includes a [Promise polyfill](https://github.com/then/promise) which provides a full implementation of Promises/A+. A Promise represents the eventual result of an asynchronous operation, you can find more information about Promises [here](https://www.promisejs.org/) and [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). Both axios and `fetch()` use Promises under the hood. You can also use the [`async / await`](https://davidwalsh.name/async-await) syntax to reduce the callback nesting. - -You can learn more about making AJAX requests from React components in [the FAQ entry on the React website](https://reactjs.org/docs/faq-ajax.html). - -## Integrating with an API Backend - -These tutorials will help you to integrate your app with an API backend running on another port, -using `fetch()` to access it. - -### Node -Check out [this tutorial](https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/). -You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo). - -### Ruby on Rails - -Check out [this tutorial](https://www.fullstackreact.com/articles/how-to-get-create-react-app-to-work-with-your-rails-api/). -You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo-rails). - -## Proxying API Requests in Development - ->Note: this feature is available with `react-scripts@0.2.3` and higher. - -People often serve the front-end React app from the same host and port as their backend implementation.
-For example, a production setup might look like this after the app is deployed: - -``` -/ - static server returns index.html with React app -/todos - static server returns index.html with React app -/api/todos - server handles any /api/* requests using the backend implementation -``` - -Such setup is **not** required. However, if you **do** have a setup like this, it is convenient to write requests like `fetch('/api/todos')` without worrying about redirecting them to another host or port during development. - -To tell the development server to proxy any unknown requests to your API server in development, add a `proxy` field to your `package.json`, for example: - -```js - "proxy": "http://localhost:4000", -``` - -This way, when you `fetch('/api/todos')` in development, the development server will recognize that it’s not a static asset, and will proxy your request to `http://localhost:4000/api/todos` as a fallback. The development server will **only** attempt to send requests without `text/html` in its `Accept` header to the proxy. - -Conveniently, this avoids [CORS issues](http://stackoverflow.com/questions/21854516/understanding-ajax-cors-and-security-considerations) and error messages like this in development: - -``` -Fetch API cannot load http://localhost:4000/api/todos. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:3000' is therefore not allowed access. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled. -``` - -Keep in mind that `proxy` only has effect in development (with `npm start`), and it is up to you to ensure that URLs like `/api/todos` point to the right thing in production. You don’t have to use the `/api` prefix. Any unrecognized request without a `text/html` accept header will be redirected to the specified `proxy`. - -The `proxy` option supports HTTP, HTTPS and WebSocket connections.
-If the `proxy` option is **not** flexible enough for you, alternatively you can: - -* [Configure the proxy yourself](#configuring-the-proxy-manually) -* Enable CORS on your server ([here’s how to do it for Express](http://enable-cors.org/server_expressjs.html)). -* Use [environment variables](#adding-custom-environment-variables) to inject the right server host and port into your app. - -### "Invalid Host Header" Errors After Configuring Proxy - -When you enable the `proxy` option, you opt into a more strict set of host checks. This is necessary because leaving the backend open to remote hosts makes your computer vulnerable to DNS rebinding attacks. The issue is explained in [this article](https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a) and [this issue](https://github.com/webpack/webpack-dev-server/issues/887). - -This shouldn’t affect you when developing on `localhost`, but if you develop remotely like [described here](https://github.com/facebookincubator/create-react-app/issues/2271), you will see this error in the browser after enabling the `proxy` option: - ->Invalid Host header - -To work around it, you can specify your public development host in a file called `.env.development` in the root of your project: - -``` -HOST=mypublicdevhost.com -``` - -If you restart the development server now and load the app from the specified host, it should work. - -If you are still having issues or if you’re using a more exotic environment like a cloud editor, you can bypass the host check completely by adding a line to `.env.development.local`. **Note that this is dangerous and exposes your machine to remote code execution from malicious websites:** - -``` -# NOTE: THIS IS DANGEROUS! -# It exposes your machine to attacks from the websites you visit. -DANGEROUSLY_DISABLE_HOST_CHECK=true -``` - -We don’t recommend this approach. - -### Configuring the Proxy Manually - ->Note: this feature is available with `react-scripts@1.0.0` and higher. - -If the `proxy` option is **not** flexible enough for you, you can specify an object in the following form (in `package.json`).
-You may also specify any configuration value [`http-proxy-middleware`](https://github.com/chimurai/http-proxy-middleware#options) or [`http-proxy`](https://github.com/nodejitsu/node-http-proxy#options) supports. -```js -{ - // ... - "proxy": { - "/api": { - "target": "", - "ws": true - // ... - } - } - // ... -} -``` - -All requests matching this path will be proxies, no exceptions. This includes requests for `text/html`, which the standard `proxy` option does not proxy. - -If you need to specify multiple proxies, you may do so by specifying additional entries. -Matches are regular expressions, so that you can use a regexp to match multiple paths. -```js -{ - // ... - "proxy": { - // Matches any request starting with /api - "/api": { - "target": "", - "ws": true - // ... - }, - // Matches any request starting with /foo - "/foo": { - "target": "", - "ssl": true, - "pathRewrite": { - "^/foo": "/foo/beta" - } - // ... - }, - // Matches /bar/abc.html but not /bar/sub/def.html - "/bar/[^/]*[.]html": { - "target": "", - // ... - }, - // Matches /baz/abc.html and /baz/sub/def.html - "/baz/.*/.*[.]html": { - "target": "" - // ... - } - } - // ... -} -``` - -### Configuring a WebSocket Proxy - -When setting up a WebSocket proxy, there are a some extra considerations to be aware of. - -If you’re using a WebSocket engine like [Socket.io](https://socket.io/), you must have a Socket.io server running that you can use as the proxy target. Socket.io will not work with a standard WebSocket server. Specifically, don't expect Socket.io to work with [the websocket.org echo test](http://websocket.org/echo.html). - -There’s some good documentation available for [setting up a Socket.io server](https://socket.io/docs/). - -Standard WebSockets **will** work with a standard WebSocket server as well as the websocket.org echo test. You can use libraries like [ws](https://github.com/websockets/ws) for the server, with [native WebSockets in the browser](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket). - -Either way, you can proxy WebSocket requests manually in `package.json`: - -```js -{ - // ... - "proxy": { - "/socket": { - // Your compatible WebSocket server - "target": "ws://", - // Tell http-proxy-middleware that this is a WebSocket proxy. - // Also allows you to proxy WebSocket requests without an additional HTTP request - // https://github.com/chimurai/http-proxy-middleware#external-websocket-upgrade - "ws": true - // ... - } - } - // ... -} -``` - -## Using HTTPS in Development - ->Note: this feature is available with `react-scripts@0.4.0` and higher. - -You may require the dev server to serve pages over HTTPS. One particular case where this could be useful is when using [the "proxy" feature](#proxying-api-requests-in-development) to proxy requests to an API server when that API server is itself serving HTTPS. - -To do this, set the `HTTPS` environment variable to `true`, then start the dev server as usual with `npm start`: - -#### Windows (cmd.exe) - -```cmd -set HTTPS=true&&npm start -``` - -#### Windows (Powershell) - -```Powershell -($env:HTTPS = $true) -and (npm start) -``` - -(Note: the lack of whitespace is intentional.) - -#### Linux, macOS (Bash) - -```bash -HTTPS=true npm start -``` - -Note that the server will use a self-signed certificate, so your web browser will almost definitely display a warning upon accessing the page. - -## Generating Dynamic `` Tags on the Server - -Since Create React App doesn’t support server rendering, you might be wondering how to make `` tags dynamic and reflect the current URL. To solve this, we recommend to add placeholders into the HTML, like this: - -```html - - - - - -``` - -Then, on the server, regardless of the backend you use, you can read `index.html` into memory and replace `__OG_TITLE__`, `__OG_DESCRIPTION__`, and any other placeholders with values depending on the current URL. Just make sure to sanitize and escape the interpolated values so that they are safe to embed into HTML! - -If you use a Node server, you can even share the route matching logic between the client and the server. However duplicating it also works fine in simple cases. - -## Pre-Rendering into Static HTML Files - -If you’re hosting your `build` with a static hosting provider you can use [react-snapshot](https://www.npmjs.com/package/react-snapshot) or [react-snap](https://github.com/stereobooster/react-snap) to generate HTML pages for each route, or relative link, in your application. These pages will then seamlessly become active, or “hydrated”, when the JavaScript bundle has loaded. - -There are also opportunities to use this outside of static hosting, to take the pressure off the server when generating and caching routes. - -The primary benefit of pre-rendering is that you get the core content of each page _with_ the HTML payload—regardless of whether or not your JavaScript bundle successfully downloads. It also increases the likelihood that each route of your application will be picked up by search engines. - -You can read more about [zero-configuration pre-rendering (also called snapshotting) here](https://medium.com/superhighfives/an-almost-static-stack-6df0a2791319). - -## Injecting Data from the Server into the Page - -Similarly to the previous section, you can leave some placeholders in the HTML that inject global variables, for example: - -```js - - - - -``` - -Then, on the server, you can replace `__SERVER_DATA__` with a JSON of real data right before sending the response. The client code can then read `window.SERVER_DATA` to use it. **Make sure to [sanitize the JSON before sending it to the client](https://medium.com/node-security/the-most-common-xss-vulnerability-in-react-js-applications-2bdffbcc1fa0) as it makes your app vulnerable to XSS attacks.** - -## Running Tests - ->Note: this feature is available with `react-scripts@0.3.0` and higher.
->[Read the migration guide to learn how to enable it in older projects!](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#migrating-from-023-to-030) - -Create React App uses [Jest](https://facebook.github.io/jest/) as its test runner. To prepare for this integration, we did a [major revamp](https://facebook.github.io/jest/blog/2016/09/01/jest-15.html) of Jest so if you heard bad things about it years ago, give it another try. - -Jest is a Node-based runner. This means that the tests always run in a Node environment and not in a real browser. This lets us enable fast iteration speed and prevent flakiness. - -While Jest provides browser globals such as `window` thanks to [jsdom](https://github.com/tmpvar/jsdom), they are only approximations of the real browser behavior. Jest is intended to be used for unit tests of your logic and your components rather than the DOM quirks. - -We recommend that you use a separate tool for browser end-to-end tests if you need them. They are beyond the scope of Create React App. - -### Filename Conventions - -Jest will look for test files with any of the following popular naming conventions: - -* Files with `.js` suffix in `__tests__` folders. -* Files with `.test.js` suffix. -* Files with `.spec.js` suffix. - -The `.test.js` / `.spec.js` files (or the `__tests__` folders) can be located at any depth under the `src` top level folder. - -We recommend to put the test files (or `__tests__` folders) next to the code they are testing so that relative imports appear shorter. For example, if `App.test.js` and `App.js` are in the same folder, the test just needs to `import App from './App'` instead of a long relative path. Colocation also helps find tests more quickly in larger projects. - -### Command Line Interface - -When you run `npm test`, Jest will launch in the watch mode. Every time you save a file, it will re-run the tests, just like `npm start` recompiles the code. - -The watcher includes an interactive command-line interface with the ability to run all tests, or focus on a search pattern. It is designed this way so that you can keep it open and enjoy fast re-runs. You can learn the commands from the “Watch Usage” note that the watcher prints after every run: - -![Jest watch mode](http://facebook.github.io/jest/img/blog/15-watch.gif) - -### Version Control Integration - -By default, when you run `npm test`, Jest will only run the tests related to files changed since the last commit. This is an optimization designed to make your tests run fast regardless of how many tests you have. However it assumes that you don’t often commit the code that doesn’t pass the tests. - -Jest will always explicitly mention that it only ran tests related to the files changed since the last commit. You can also press `a` in the watch mode to force Jest to run all tests. - -Jest will always run all tests on a [continuous integration](#continuous-integration) server or if the project is not inside a Git or Mercurial repository. - -### Writing Tests - -To create tests, add `it()` (or `test()`) blocks with the name of the test and its code. You may optionally wrap them in `describe()` blocks for logical grouping but this is neither required nor recommended. - -Jest provides a built-in `expect()` global function for making assertions. A basic test could look like this: - -```js -import sum from './sum'; - -it('sums numbers', () => { - expect(sum(1, 2)).toEqual(3); - expect(sum(2, 2)).toEqual(4); -}); -``` - -All `expect()` matchers supported by Jest are [extensively documented here](https://facebook.github.io/jest/docs/en/expect.html#content).
-You can also use [`jest.fn()` and `expect(fn).toBeCalled()`](https://facebook.github.io/jest/docs/en/expect.html#tohavebeencalled) to create “spies” or mock functions. - -### Testing Components - -There is a broad spectrum of component testing techniques. They range from a “smoke test” verifying that a component renders without throwing, to shallow rendering and testing some of the output, to full rendering and testing component lifecycle and state changes. - -Different projects choose different testing tradeoffs based on how often components change, and how much logic they contain. If you haven’t decided on a testing strategy yet, we recommend that you start with creating simple smoke tests for your components: - -```js -import React from 'react'; -import ReactDOM from 'react-dom'; -import App from './App'; - -it('renders without crashing', () => { - const div = document.createElement('div'); - ReactDOM.render(, div); -}); -``` - -This test mounts a component and makes sure that it didn’t throw during rendering. Tests like this provide a lot of value with very little effort so they are great as a starting point, and this is the test you will find in `src/App.test.js`. - -When you encounter bugs caused by changing components, you will gain a deeper insight into which parts of them are worth testing in your application. This might be a good time to introduce more specific tests asserting specific expected output or behavior. - -If you’d like to test components in isolation from the child components they render, we recommend using [`shallow()` rendering API](http://airbnb.io/enzyme/docs/api/shallow.html) from [Enzyme](http://airbnb.io/enzyme/). To install it, run: - -```sh -npm install --save enzyme enzyme-adapter-react-16 react-test-renderer -``` - -Alternatively you may use `yarn`: - -```sh -yarn add enzyme enzyme-adapter-react-16 react-test-renderer -``` - -As of Enzyme 3, you will need to install Enzyme along with an Adapter corresponding to the version of React you are using. (The examples above use the adapter for React 16.) - -The adapter will also need to be configured in your [global setup file](#initializing-test-environment): - -#### `src/setupTests.js` -```js -import { configure } from 'enzyme'; -import Adapter from 'enzyme-adapter-react-16'; - -configure({ adapter: new Adapter() }); -``` - ->Note: Keep in mind that if you decide to "eject" before creating `src/setupTests.js`, the resulting `package.json` file won't contain any reference to it. [Read here](#initializing-test-environment) to learn how to add this after ejecting. - -Now you can write a smoke test with it: - -```js -import React from 'react'; -import { shallow } from 'enzyme'; -import App from './App'; - -it('renders without crashing', () => { - shallow(); -}); -``` - -Unlike the previous smoke test using `ReactDOM.render()`, this test only renders `` and doesn’t go deeper. For example, even if `` itself renders a `