+ To get started, edit src/App.js and save to reload.
+
+
+
+ );
+ }
+}
+
+export default App;
diff --git a/fixtures/monorepos/packages/cra-app1/src/App.test.js b/fixtures/monorepos/packages/cra-app1/src/App.test.js
new file mode 100644
index 00000000000..a754b201bf9
--- /dev/null
+++ b/fixtures/monorepos/packages/cra-app1/src/App.test.js
@@ -0,0 +1,9 @@
+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);
+ ReactDOM.unmountComponentAtNode(div);
+});
diff --git a/fixtures/monorepos/packages/cra-app1/src/index.css b/fixtures/monorepos/packages/cra-app1/src/index.css
new file mode 100644
index 00000000000..b4cc7250b98
--- /dev/null
+++ b/fixtures/monorepos/packages/cra-app1/src/index.css
@@ -0,0 +1,5 @@
+body {
+ margin: 0;
+ padding: 0;
+ font-family: sans-serif;
+}
diff --git a/fixtures/monorepos/packages/cra-app1/src/index.js b/fixtures/monorepos/packages/cra-app1/src/index.js
new file mode 100644
index 00000000000..395b74997b2
--- /dev/null
+++ b/fixtures/monorepos/packages/cra-app1/src/index.js
@@ -0,0 +1,6 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import './index.css';
+import App from './App';
+
+ReactDOM.render(, document.getElementById('root'));
diff --git a/fixtures/monorepos/packages/cra-app1/src/logo.svg b/fixtures/monorepos/packages/cra-app1/src/logo.svg
new file mode 100644
index 00000000000..6b60c1042f5
--- /dev/null
+++ b/fixtures/monorepos/packages/cra-app1/src/logo.svg
@@ -0,0 +1,7 @@
+
diff --git a/fixtures/monorepos/yarn-ws/package.json b/fixtures/monorepos/yarn-ws/package.json
new file mode 100644
index 00000000000..aad9ea832aa
--- /dev/null
+++ b/fixtures/monorepos/yarn-ws/package.json
@@ -0,0 +1,4 @@
+{
+ "private": true,
+ "workspaces": ["packages/*"]
+}
diff --git a/package.json b/package.json
index 7fa42331eff..9bb5a1a0758 100644
--- a/package.json
+++ b/package.json
@@ -43,7 +43,9 @@
"eslint-plugin-react": "7.5.1",
"extract-text-webpack-plugin": "3.0.2",
"file-loader": "1.1.6",
+ "find-pkg": "1.0.0",
"fs-extra": "5.0.0",
+ "globby": "7.1.1",
"html-webpack-plugin": "2.30.1",
"identity-obj-proxy": "3.0.0",
"jest": "22.1.2",
diff --git a/scripts/eject.js b/scripts/eject.js
index 84353fc3c81..e8c64a77853 100644
--- a/scripts/eject.js
+++ b/scripts/eject.js
@@ -109,7 +109,7 @@ inquirer
const jestConfig = createJestConfig(
filePath => path.posix.join('', filePath),
null,
- true
+ paths.srcPaths
);
console.log();
@@ -205,18 +205,6 @@ inquirer
console.log(` Adding ${cyan('Jest')} configuration`);
appPackage.jest = jestConfig;
- // Add Babel config
- console.log(` Adding ${cyan('Babel')} preset`);
- appPackage.babel = {
- presets: ['react-app'],
- };
-
- // Add ESlint config
- console.log(` Adding ${cyan('ESLint')} configuration`);
- appPackage.eslintConfig = {
- extends: 'react-app',
- };
-
fs.writeFileSync(
path.join(appPath, 'package.json'),
JSON.stringify(appPackage, null, 2) + os.EOL
diff --git a/scripts/test.js b/scripts/test.js
index 470e8e35721..7d2acf77ea2 100644
--- a/scripts/test.js
+++ b/scripts/test.js
@@ -53,7 +53,7 @@ argv.push(
createJestConfig(
relativePath => path.resolve(__dirname, '..', relativePath),
path.resolve(paths.appSrc, '..'),
- false
+ paths.srcPaths
)
)
);
diff --git a/scripts/utils/createJestConfig.js b/scripts/utils/createJestConfig.js
index cdea70699c0..ea92a4f21ec 100644
--- a/scripts/utils/createJestConfig.js
+++ b/scripts/utils/createJestConfig.js
@@ -8,16 +8,19 @@
'use strict';
const fs = require('fs');
+const path = require('path');
const chalk = require('chalk');
const paths = require('../../config/paths');
-module.exports = (resolve, rootDir, isEjecting) => {
+module.exports = (resolve, rootDir, srcRoots) => {
// Use this instead of `paths.testsSetup` to avoid putting
// an absolute filename into configuration after ejecting.
const setupTestsFile = fs.existsSync(paths.testsSetup)
? '/src/setupTests.js'
: undefined;
+ const toRelRootDir = f => '/' + path.relative(rootDir || '', f);
+
// TODO: I don't know if it's safe or not to just use / as path separator
// in Jest configs. We need help from somebody with Windows to determine this.
const config = {
@@ -25,15 +28,15 @@ module.exports = (resolve, rootDir, isEjecting) => {
setupFiles: [resolve('config/polyfills.js')],
setupTestFrameworkScriptFile: setupTestsFile,
testMatch: [
- '/src/**/__tests__/**/*.{js,jsx,mjs}',
- '/src/**/?(*.)(spec|test).{js,jsx,mjs}',
+ '**/__tests__/**/*.{js,jsx,mjs}',
+ '**/?(*.)(spec|test).{js,jsx,mjs}',
],
+ // where to search for files/tests
+ roots: srcRoots.map(toRelRootDir),
testEnvironment: 'node',
testURL: 'http://localhost',
transform: {
- '^.+\\.(js|jsx|mjs)$': isEjecting
- ? '/node_modules/babel-jest'
- : resolve('config/jest/babelTransform.js'),
+ '^.+\\.(js|jsx|mjs)$': resolve('config/jest/babelTransform.js'),
'^.+\\.css$': resolve('config/jest/cssTransform.js'),
'^(?!.*\\.(js|jsx|mjs|css|json)$)': resolve(
'config/jest/fileTransform.js'
@@ -60,6 +63,7 @@ module.exports = (resolve, rootDir, isEjecting) => {
if (rootDir) {
config.rootDir = rootDir;
}
+
const overrides = Object.assign({}, require(paths.appPackageJson).jest);
const supportedKeys = [
'collectCoverageFrom',
diff --git a/template/README.md b/template/README.md
index 17a85d627f2..c5f5afe0b95 100644
--- a/template/README.md
+++ b/template/README.md
@@ -73,6 +73,7 @@ You can find the most recent version of this guide [here](https://github.com/fac
- [Developing Components in Isolation](#developing-components-in-isolation)
- [Getting Started with Storybook](#getting-started-with-storybook)
- [Getting Started with Styleguidist](#getting-started-with-styleguidist)
+- [Sharing Components in a Monorepo](#sharing-components-in-a-monorepo)
- [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)
@@ -1819,6 +1820,66 @@ Learn more about React Styleguidist:
* [GitHub Repo](https://github.com/styleguidist/react-styleguidist)
* [Documentation](https://react-styleguidist.js.org/docs/getting-started.html)
+## Sharing Components in a Monorepo
+A typical monorepo folder structure looks like this:
+```
+monorepo/
+ app1/
+ app2/
+ comp1/
+ comp2/
+```
+
+The monorepo allows components to be separated from the app, providing:
+* a level of encapsulation for components
+* sharing of components
+
+### How to Set Up a Monorepo
+Below expands on the monorepo structure above, adding the package.json files required to configure the monorepo for [yarn workspaces](https://yarnpkg.com/en/docs/workspaces).
+```
+monorepo/
+ package.json:
+ "workspaces": ["*"],
+ "private": true
+ app1/
+ package.json:
+ "dependencies": ["@myorg/comp1": ">=0.0.0", "react": "^16.2.0"],
+ "devDependencies": ["react-scripts": "2.0.0"]
+ src/
+ app.js: import comp1 from '@myorg/comp1';
+ app2/
+ package.json:
+ "dependencies": ["@myorg/comp1": ">=0.0.0", "react": "^16.2.0"],
+ "devDependencies": ["react-scripts": "2.0.0"]
+ src/
+ app.js: import comp1 from '@myorg/comp1';
+ comp1/
+ package.json:
+ "name": "@myorg/comp1",
+ "version": "0.1.0"
+ index.js
+ comp2/
+ package.json:
+ "name": "@myorg/comp2",
+ "version": "0.1.0",
+ "dependencies": ["@myorg/comp1": ">=0.0.0"],
+ "devDependencies": ["react": "^16.2.0"]
+ index.js: import comp1 from '@myorg/comp1'
+```
+* Monorepo tools work on a package level, the same level as an npm package.
+* The "workspaces" in the top-level package.json is an array of glob patterns specifying where shared packages are located in the monorepo.
+* The scoping prefixes, e.g. @myorg/, are not required, but are recommended, allowing you to differentiate your packages from others of the same name. See [scoped packages ](https://docs.npmjs.com/misc/scope) for more info.
+* Using a package in the monorepo is accomplished in the same manner as a published npm package, by specifying the shared package as dependency.
+* In order to pick up the monorepo version of a package, the specified dependency version must semantically match the package version in the monorepo. See [semver](https://docs.npmjs.com/misc/semver) for info on semantic version matching.
+
+### CRA Apps in a Monorepo
+* CRA apps in a monorepo are just a standard CRA app, they use the same react-script scripts.
+* However, when you use react-scripts for an app in a monorepo, all packages in the monorepo are treated as app sources -- they are watched, linted, transpiled, and tested in the same way as if they were part of the app itself.
+* Without this functionality, each package would need its own build/test/etc functionality and it would be challenging to link all of these together.
+
+### Lerna and Publishing
+[Lerna](https://github.com/lerna/lerna) is a popular tool for managing monorepos. Lerna can be configured to use yarn workspaces, so it will work with the monorepo structure above. It's important to note that while lerna helps publish various packages in a monorepo, react-scripts does nothing to help publish a component to npm. A component which uses JSX or ES6+ features would need to be built by another tool before it can be published to npm. See [publishing components to npm](#publishing-components-to-npm) for more info.
+
## Publishing Components to npm
Create React App doesn't provide any built-in functionality to publish a component to npm. If you're ready to extract a component from your project so other people can use it, we recommend moving it to a separate directory outside of your project and then using a tool like [nwb](https://github.com/insin/nwb#react-components-and-libraries) to prepare it for publishing.