feat(react): add Vite bundler option for buildable libraries

nrwl · Nov 24, 2022 · dd9248c · dd9248c
1 parent 61f6e2d
commit dd9248c
Show file tree

Hide file tree

Showing 26 changed files with 223 additions and 46 deletions.
diff --git a/e2e/react/src/react-package.test.ts b/e2e/react/src/react-package.test.ts
@@ -252,4 +252,20 @@ export async function h() { return 'c'; }
       }).toThrow();
     }, 250000);
   });
+
+  it('should support bundling with Vite', async () => {
+    const libName = uniq('lib');
+
+    runCLI(
+      `generate @nrwl/react:lib ${libName} --buildable --bundler=vite --no-interactive`
+    );
+
+    const result = await runCLIAsync(`build ${libName}`);
+
+    expect(result).toMatch(/Vite builder finished/);
+    checkFilesExist(
+      `dist/libs/${libName}/index.js`,
+      `dist/libs/${libName}/index.mjs`
+    );
+  });
 });
diff --git a/packages/react/src/generators/application/application.ts b/packages/react/src/generators/application/application.ts
@@ -77,6 +77,7 @@ export async function applicationGenerator(host: Tree, schema: Schema) {
   const initTask = await reactInitGenerator(host, {
     ...options,
     skipFormat: true,
+    skipBabelConfig: options.bundler === 'vite',
   });
 
   tasks.push(initTask);

diff --git a/packages/react/src/generators/application/lib/normalize-options.ts b/packages/react/src/generators/application/lib/normalize-options.ts
@@ -47,7 +47,8 @@ export function normalizeOptions(
   options.routing = options.routing ?? false;
   options.strict = options.strict ?? true;
   options.classComponent = options.classComponent ?? false;
-  options.unitTestRunner = options.unitTestRunner ?? 'jest';
+  options.unitTestRunner =
+    options.unitTestRunner ?? options.bundler === 'vite' ? 'vitest' : 'jest';
   options.e2eTestRunner = options.e2eTestRunner ?? 'cypress';
   options.compiler = options.compiler ?? 'babel';
   options.bundler = options.bundler ?? 'webpack';

diff --git a/packages/react/src/generators/application/lib/set-defaults.ts b/packages/react/src/generators/application/lib/set-defaults.ts
@@ -30,6 +30,7 @@ export function setDefaults(host: Tree, options: NormalizedSchema) {
         style: options.style,
         unitTestRunner: options.unitTestRunner,
         linter: options.linter,
+        bundler: options.bundler,
         ...prev.application,
       },
       component: {
@@ -40,6 +41,7 @@ export function setDefaults(host: Tree, options: NormalizedSchema) {
         style: options.style,
         unitTestRunner: options.unitTestRunner,
         linter: options.linter,
+        bundler: options.bundler,
         ...prev.library,
       },
     },

diff --git a/packages/react/src/generators/application/schema.json b/packages/react/src/generators/application/schema.json
@@ -184,7 +184,7 @@
     "bundler": {
       "description": "The bundler to use.",
       "enum": ["vite", "webpack"],
-      "x-prompt": "Which bundler do you want to use?",
+      "x-prompt": "Which bundler do you want to use to build the application?",
       "default": "webpack"
     }
   },

diff --git a/packages/react/src/generators/init/schema.d.ts b/packages/react/src/generators/init/schema.d.ts
@@ -1,6 +1,7 @@
 export interface InitSchema {
   unitTestRunner?: 'jest' | 'vitest' | 'none';
   e2eTestRunner?: 'cypress' | 'none';
+  skipBabelConfig?: boolean;
   skipFormat?: boolean;
   skipPackageJson?: boolean;
   js?: boolean;

diff --git a/packages/react/src/generators/init/schema.json b/packages/react/src/generators/init/schema.json
@@ -28,6 +28,11 @@
       "type": "boolean",
       "default": false
     },
+    "skipBabelConfig": {
+      "description": "Do not generate a root babel.config.json (if babel is not needed).",
+      "type": "boolean",
+      "default": false
+    },
     "js": {
       "type": "boolean",
       "default": false,

diff --git a/...rc/generators/library/files/lib/README.md → ...generators/library/files/common/README.md b/...rc/generators/library/files/lib/README.md → ...generators/library/files/common/README.md
diff --git a/...rs/library/files/lib/package.json__tmpl__ → ...library/files/common/package.json__tmpl__ b/...rs/library/files/lib/package.json__tmpl__ → ...library/files/common/package.json__tmpl__
diff --git a/...rs/library/files/lib/src/index.ts__tmpl__ → ...library/files/common/src/index.ts__tmpl__ b/...rs/library/files/lib/src/index.ts__tmpl__ → ...library/files/common/src/index.ts__tmpl__
diff --git a/...s/library/files/lib/tsconfig.json__tmpl__ → ...ibrary/files/common/tsconfig.json__tmpl__ b/...s/library/files/lib/tsconfig.json__tmpl__ → ...ibrary/files/common/tsconfig.json__tmpl__
diff --git a/...brary/files/lib/tsconfig.lib.json__tmpl__ → ...ry/files/common/tsconfig.lib.json__tmpl__ b/...brary/files/lib/tsconfig.lib.json__tmpl__ → ...ry/files/common/tsconfig.lib.json__tmpl__
diff --git a/...rators/library/files/lib/.babelrc__tmpl__ → ...brary/files/rollup-babel/.babelrc__tmpl__ b/...rators/library/files/lib/.babelrc__tmpl__ → ...brary/files/rollup-babel/.babelrc__tmpl__
diff --git a/packages/react/src/generators/library/files/vite/index.html__tmpl__ b/packages/react/src/generators/library/files/vite/index.html__tmpl__
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= className %> Demo</title>
+    <base href="/" />
+
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="./src/demo.tsx"></script>
+  </body>
+</html>
diff --git a/packages/react/src/generators/library/files/vite/src/demo.tsx__tmpl__ b/packages/react/src/generators/library/files/vite/src/demo.tsx__tmpl__
@@ -0,0 +1,19 @@
+/*
+ * This a a demo file that can be helpful when developing components by serving and interacting with them in the browser.
+ */
+<% if (component) { %>
+import * as ReactDOM from 'react-dom/client';
+import { <%= className %> } from './index';
+
+const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
+root.render(
+  <<%= className %> />
+);
+<% } else { %>
+import * as ReactDOM from 'react-dom/client';
+
+const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
+root.render(
+  <h1><%= className %> Demo</h1>
+);
+<% } %>
diff --git a/packages/react/src/generators/library/library.ts b/packages/react/src/generators/library/library.ts
@@ -44,10 +44,10 @@ import {
   typesReactRouterDomVersion,
 } from '../../utils/versions';
 import componentGenerator from '../component/component';
-import init from '../init/init';
+import initGenerator from '../init/init';
 import { Schema } from './schema';
 import { updateJestConfigContent } from '../../utils/jest-utils';
-import { vitestGenerator } from '@nrwl/vite';
+import { viteConfigurationGenerator, vitestGenerator } from '@nrwl/vite';
 export interface NormalizedSchema extends Schema {
   name: string;
   fileName: string;
@@ -72,10 +72,11 @@ export async function libraryGenerator(host: Tree, schema: Schema) {
     options.style = 'none';
   }
 
-  const initTask = await init(host, {
+  const initTask = await initGenerator(host, {
     ...options,
     e2eTestRunner: 'none',
     skipFormat: true,
+    skipBabelConfig: options.bundler === 'vite',
   });
   tasks.push(initTask);
 
@@ -90,6 +91,17 @@ export async function libraryGenerator(host: Tree, schema: Schema) {
     updateBaseTsConfig(host, options);
   }
 
+  if (options.buildable && options.bundler === 'vite') {
+    const viteTask = await viteConfigurationGenerator(host, {
+      uiFramework: 'react',
+      project: options.name,
+      newProject: true,
+      includeLib: true,
+      includeVitest: true,
+    });
+    tasks.push(viteTask);
+  }
+
   if (options.unitTestRunner === 'jest') {
     const jestTask = await jestProjectGenerator(host, {
       ...options,
@@ -110,7 +122,10 @@ export async function libraryGenerator(host: Tree, schema: Schema) {
       );
       host.write(jestConfigPath, updatedContent);
     }
-  } else if (options.unitTestRunner === 'vitest') {
+  } else if (
+    options.unitTestRunner === 'vitest' &&
+    options.bundler !== 'vite' // tests are already configured if bundler is vite
+  ) {
     const vitestTask = await vitestGenerator(host, {
       uiFramework: 'react',
       project: options.name,
@@ -299,22 +314,37 @@ function updateBaseTsConfig(host: Tree, options: NormalizedSchema) {
 }
 
 function createFiles(host: Tree, options: NormalizedSchema) {
+  const substitutions = {
+    ...options,
+    ...names(options.name),
+    tmpl: '',
+    offsetFromRoot: offsetFromRoot(options.projectRoot),
+    rootTsConfigPath: getRelativePathToRootTsConfig(host, options.projectRoot),
+  };
+
   generateFiles(
     host,
-    joinPathFragments(__dirname, './files/lib'),
+    joinPathFragments(__dirname, './files/common'),
     options.projectRoot,
-    {
-      ...options,
-      ...names(options.name),
-      tmpl: '',
-      offsetFromRoot: offsetFromRoot(options.projectRoot),
-      rootTsConfigPath: getRelativePathToRootTsConfig(
-        host,
-        options.projectRoot
-      ),
-    }
+    substitutions
   );
 
+  if (options.bundler === 'vite') {
+    generateFiles(
+      host,
+      joinPathFragments(__dirname, './files/vite'),
+      options.projectRoot,
+      substitutions
+    );
+  } else if (options.bundler === 'rollup' && options.compiler === 'babel') {
+    generateFiles(
+      host,
+      joinPathFragments(__dirname, './files/rollup-babel'),
+      options.projectRoot,
+      substitutions
+    );
+  }
+
   if (!options.publishable && !options.buildable) {
     host.delete(`${options.projectRoot}/package.json`);
   }
@@ -435,6 +465,9 @@ function normalizeOptions(host: Tree, options: Schema): NormalizedSchema {
 
   const normalized: NormalizedSchema = {
     ...options,
+    buildable: options.buildable || options.publishable,
+    compiler: options.compiler ?? 'babel',
+    bundler: options.bundler ?? 'rollup',
     fileName,
     routePath: `/${name}`,
     name: projectName,
@@ -444,6 +477,12 @@ function normalizeOptions(host: Tree, options: Schema): NormalizedSchema {
     importPath,
   };
 
+  // If lib is not buildable then there is no reason to use a bundler or compiler.
+  if (!normalized.buildable) {
+    delete normalized.compiler;
+    delete normalized.bundler;
+  }
+
   if (options.appProject) {
     const appProjectConfig = getProjects(host).get(options.appProject);
 

diff --git a/packages/react/src/generators/library/schema.d.ts b/packages/react/src/generators/library/schema.d.ts
@@ -24,5 +24,6 @@ export interface Schema {
   setParserOptionsProject?: boolean;
   standaloneConfig?: boolean;
   compiler?: 'babel' | 'swc';
+  bundler?: 'rollup' | 'vite';
   skipPackageJson?: boolean;
 }
diff --git a/packages/react/src/generators/library/schema.json b/packages/react/src/generators/library/schema.json
@@ -161,11 +161,16 @@
       "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
       "type": "boolean"
     },
+    "bundler": {
+      "description": "The bundler to use.",
+      "enum": ["vite", "rollup"],
+      "default": "rollup"
+    },
     "compiler": {
       "type": "string",
       "enum": ["babel", "swc"],
       "default": "babel",
-      "description": "Which compiler to use."
+      "description": "Which compiler to use. Does not apply if bundler is set to Vite."
     },
     "skipPackageJson": {
       "description": "Do not add dependencies to `package.json`.",

diff --git a/packages/vite/src/generators/configuration/configuration.spec.ts b/packages/vite/src/generators/configuration/configuration.spec.ts
@@ -1,4 +1,9 @@
-import { addDependenciesToPackageJson, readJson, Tree } from '@nrwl/devkit';
+import {
+  addDependenciesToPackageJson,
+  addProjectConfiguration,
+  readJson,
+  Tree,
+} from '@nrwl/devkit';
 import { createTreeWithEmptyV1Workspace } from '@nrwl/devkit/testing';
 import { nxVersion } from '../../utils/versions';
 
@@ -116,4 +121,27 @@ describe('@nrwl/vite:configuration', () => {
       expect(viteConfig).toContain('test');
     });
   });
+
+  describe('library mode', () => {
+    beforeEach(async () => {
+      tree = createTreeWithEmptyV1Workspace();
+      addProjectConfiguration(tree, 'my-lib', {
+        root: 'my-lib',
+      });
+    });
+
+    it('should add config for building library', async () => {
+      await viteConfigurationGenerator(tree, {
+        uiFramework: 'react',
+        mode: 'lib',
+        project: 'my-lib',
+        newProject: true,
+      });
+
+      const viteConfig = tree.read('my-lib/vite.config.ts').toString();
+
+      expect(viteConfig).toMatch('build: {');
+      expect(viteConfig).toMatch("external: ['react']");
+    });
+  });
 });
diff --git a/packages/vite/src/generators/configuration/schema.d.ts b/packages/vite/src/generators/configuration/schema.d.ts
@@ -4,4 +4,5 @@ export interface Schema {
   newProject?: boolean;
   includeVitest?: boolean;
   inSourceTests?: boolean;
+  includeLib?: boolean;
 }
diff --git a/packages/vite/src/generators/configuration/schema.json b/packages/vite/src/generators/configuration/schema.json
@@ -16,6 +16,12 @@
       "x-dropdown": "project",
       "x-prompt": "What is the name of the project to set up a webpack for?"
     },
+    "includeLib": {
+      "type": "boolean",
+      "description": "Add a library build option.",
+      "default": false,
+      "x-prompt": "Does this project contain a buildable library?"
+    },
     "uiFramework": {
       "type": "string",
       "description": "UI Framework to use for Vite.",