Include all workspace files in webpack / rollup build configurations (#…

…2219) * Construct the include directories from all workspaces * Support Windows paths * Create tough-mugs-dream.md * Add tests and fixtures * Fix packages * Fix changeset
jpmorganchase · Dec 1, 2022 · 4a541a9 · 4a541a9
1 parent e2cbdc3
commit 4a541a9
Show file tree

Hide file tree

Showing 29 changed files with 399 additions and 13 deletions.
diff --git a/.changeset/tough-mugs-dream.md b/.changeset/tough-mugs-dream.md
@@ -0,0 +1,5 @@
+---
+"modular-scripts": patch
+---
+
+Fix `modular build` crashing when the selected workspace(s) are not in `packages`.
diff --git a/__fixtures__/custom-workspace-root/apps/alpha/package.json b/__fixtures__/custom-workspace-root/apps/alpha/package.json
@@ -0,0 +1,9 @@
+{
+  "name": "alpha",
+  "private": false,
+  "modular": {
+    "type": "package"
+  },
+  "main": "./src/index.ts",
+  "version": "1.0.0"
+}
diff --git a/__fixtures__/custom-workspace-root/apps/alpha/src/__tests__/index.test.ts b/__fixtures__/custom-workspace-root/apps/alpha/src/__tests__/index.test.ts
@@ -0,0 +1,5 @@
+import add from '../index';
+
+test('it should add two numbers', () => {
+  expect(add(0.1, 0.2)).toEqual(0.30000000000000004);
+});
diff --git a/__fixtures__/custom-workspace-root/apps/alpha/src/index.ts b/__fixtures__/custom-workspace-root/apps/alpha/src/index.ts
@@ -0,0 +1,3 @@
+export default function add(a: number, b: number): number {
+  return a + b;
+}
diff --git a/__fixtures__/custom-workspace-root/apps/app/package.json b/__fixtures__/custom-workspace-root/apps/app/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "app",
+  "private": true,
+  "modular": {
+    "type": "app"
+  },
+  "version": "1.0.0"
+}
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/favicon.ico b/__fixtures__/custom-workspace-root/apps/app/public/favicon.ico
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/index.html b/__fixtures__/custom-workspace-root/apps/app/public/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta
+      name="description"
+      content="Web site created using create-modular-app"
+    />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/logo192.png b/__fixtures__/custom-workspace-root/apps/app/public/logo192.png
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/logo512.png b/__fixtures__/custom-workspace-root/apps/app/public/logo512.png
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/manifest.json b/__fixtures__/custom-workspace-root/apps/app/public/manifest.json
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/__fixtures__/custom-workspace-root/apps/app/public/robots.txt b/__fixtures__/custom-workspace-root/apps/app/public/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/App.css b/__fixtures__/custom-workspace-root/apps/app/src/App.css
@@ -0,0 +1,38 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  height: 40vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .App-logo {
+    animation: App-logo-spin infinite 20s linear;
+  }
+}
+
+.App-header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/App.tsx b/__fixtures__/custom-workspace-root/apps/app/src/App.tsx
@@ -0,0 +1,26 @@
+import * as React from 'react';
+import logo from './logo.svg';
+import './App.css';
+
+function App(): JSX.Element {
+  return (
+    <div className="App">
+      <header className="App-header">
+        <img src={logo} className="App-logo" alt="logo" />
+        <p>
+          Edit <code>src/App.tsx</code> and save to reload.
+        </p>
+        <a
+          className="App-link"
+          href="https://reactjs.org"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Learn React
+        </a>
+      </header>
+    </div>
+  );
+}
+
+export default App;
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/__tests__/App.test.tsx b/__fixtures__/custom-workspace-root/apps/app/src/__tests__/App.test.tsx
@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { render, screen } from '@testing-library/react';
+import App from '../App';
+
+test('renders learn react link', () => {
+  render(<App />);
+  const linkElement = screen.getByText(/learn react/i);
+  expect(linkElement).toBeInTheDocument();
+});
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/index.css b/__fixtures__/custom-workspace-root/apps/app/src/index.css
@@ -0,0 +1,13 @@
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+    sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+code {
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
+    monospace;
+}
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/index.tsx b/__fixtures__/custom-workspace-root/apps/app/src/index.tsx
@@ -0,0 +1,12 @@
+import * as React from 'react';
+import * as ReactDOM from 'react-dom';
+
+import App from './App';
+import './index.css';
+
+ReactDOM.render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+  document.getElementById('root'),
+);
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/logo.svg b/__fixtures__/custom-workspace-root/apps/app/src/logo.svg
diff --git a/__fixtures__/custom-workspace-root/apps/app/src/react-app-env.d.ts b/__fixtures__/custom-workspace-root/apps/app/src/react-app-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="modular-scripts/react-app-env" />
diff --git a/__fixtures__/custom-workspace-root/apps/app/tsconfig.json b/__fixtures__/custom-workspace-root/apps/app/tsconfig.json
@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.json"
+}
diff --git a/__fixtures__/custom-workspace-root/modular/setupEnvironment.ts b/__fixtures__/custom-workspace-root/modular/setupEnvironment.ts
@@ -0,0 +1,2 @@
+// Allows for adding setup configuration to Jest
+export {};
diff --git a/__fixtures__/custom-workspace-root/modular/setupTests.ts b/__fixtures__/custom-workspace-root/modular/setupTests.ts
@@ -0,0 +1,5 @@
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom/extend-expect';
diff --git a/__fixtures__/custom-workspace-root/package.json b/__fixtures__/custom-workspace-root/package.json
@@ -0,0 +1,59 @@
+{
+  "name": "roots",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "workspaces": [
+    "packages/**",
+    "apps/**"
+  ],
+  "modular": {
+    "type": "root"
+  },
+  "scripts": {
+    "start": "modular start",
+    "build": "modular build",
+    "test": "modular test",
+    "lint": "eslint . --ext .js,.ts,.tsx",
+    "prettier": "prettier --write ."
+  },
+  "eslintConfig": {
+    "extends": "modular-app"
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "all",
+    "printWidth": 80,
+    "proseWrap": "always"
+  },
+  "dependencies": {
+    "@testing-library/dom": "^8.19.0",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^7.2.1",
+    "@types/jest": "^29.2.3",
+    "@types/node": "^18.7.14",
+    "@types/react": "^18.0.25",
+    "@types/react-dom": "^18.0.9",
+    "eslint-config-modular-app": "^3.0.2",
+    "modular-scripts": "^3.6.0",
+    "modular-template-app": "^1.1.0",
+    "prettier": "^2.7.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": ">=4.2.1 <4.5.0"
+  }
+}
diff --git a/__fixtures__/custom-workspace-root/packages/README.md b/__fixtures__/custom-workspace-root/packages/README.md
@@ -0,0 +1 @@
+This will be the readme inside /packages
diff --git a/__fixtures__/custom-workspace-root/tsconfig.json b/__fixtures__/custom-workspace-root/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "modular-scripts/tsconfig.json",
+  "include": ["modular", "packages/**/src", "apps/**/src"]
+}
diff --git a/packages/modular-scripts/react-scripts/config/parts/baseConfig.js b/packages/modular-scripts/react-scripts/config/parts/baseConfig.js
@@ -168,7 +168,7 @@ function createConfig({
             // Process application JS with esbuild.
             {
               test: /\.(js|mjs|jsx)$/,
-              include: paths.modularSrc,
+              include: paths.includeDirectories,
               loader: require.resolve('esbuild-loader'),
               options: {
                 implementation: require('esbuild'),
@@ -178,7 +178,7 @@ function createConfig({
             },
             {
               test: /\.ts$/,
-              include: paths.modularSrc,
+              include: paths.includeDirectories,
               loader: require.resolve('esbuild-loader'),
               options: {
                 implementation: require('esbuild'),
@@ -188,7 +188,7 @@ function createConfig({
             },
             {
               test: /\.tsx$/,
-              include: paths.modularSrc,
+              include: paths.includeDirectories,
               loader: require.resolve('esbuild-loader'),
               options: {
                 implementation: require('esbuild'),

diff --git a/packages/modular-scripts/react-scripts/config/paths.js b/packages/modular-scripts/react-scripts/config/paths.js
@@ -2,6 +2,7 @@
 
 const path = require('path');
 const fs = require('fs');
+const globby = require('globby');
 const getPublicUrlOrPath = require('../../react-dev-utils/getPublicUrlOrPath');
 
 if (!process.env.MODULAR_ROOT) {
@@ -77,6 +78,21 @@ const resolveModule = (resolveFn, filePath) => {
   return resolveFn(`${filePath}.js`);
 };
 
+// Get the workspaces field from the manifest to calculate the possible workspace directories
+const rootManifest = require(resolveModular('package.json'));
+const workspaceDefinitions =
+  (Array.isArray(rootManifest?.workspaces)
+    ? rootManifest?.workspaces
+    : rootManifest?.workspaces?.packages) || [];
+
+// Calculate all the possible workspace directories. We need to convert paths to posix separator to feed it into globby
+// and convert back to native separator after
+const workspaceDirectories = globby
+  .sync(workspaceDefinitions.map(resolveModular).map(toPosix), {
+    onlyDirectories: true,
+  })
+  .map(fromPosix);
+
 // config after eject: we're in ./config/
 module.exports = {
   appPath: resolveApp('.'),
@@ -86,8 +102,8 @@ module.exports = {
   appIndexJs: resolveModule(resolveApp, 'src/index'),
   appPackageJson: resolveApp('package.json'),
   appSrc: resolveApp('src'),
-  modularSrc: [
-    resolveModular('packages'),
+  includeDirectories: [
+    workspaceDirectories,
     resolveModular('node_modules/.modular'),
   ],
   appTsConfig: resolveApp('tsconfig.json'),
@@ -101,3 +117,11 @@ module.exports = {
 };
 
 module.exports.moduleFileExtensions = moduleFileExtensions;
+
+function toPosix(pathString) {
+  return pathString.split(path.sep).join(path.posix.sep);
+}
+
+function fromPosix(pathString) {
+  return pathString.split(path.posix.sep).join(path.sep);
+}