@nx/react-native 18.0.0-beta.1 → 18.0.0-canary.20240201-8762c38

package/src/generators/storybook-configuration/schema.json

@@ -6,24 +6,40 @@
   "description": "Set up Storybook for a React-Native app or library.",
   "type": "object",
   "properties": {
-    "name": {
+    "project": {
       "type": "string",
-      "aliases": ["project", "projectName"],
+      "aliases": ["name", "projectName"],
       "description": "Project for which to generate Storybook configuration.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
       "x-prompt": "For which project do you want to generate Storybook configuration?",
-      "x-dropdown": "projects"
+      "x-dropdown": "projects",
+      "x-priority": "important"
+    },
+    "interactionTests": {
+      "type": "boolean",
+      "description": "Set up Storybook interaction tests.",
+      "x-prompt": "Do you want to set up Storybook interaction tests?",
+      "x-priority": "important",
+      "alias": ["configureTestRunner"],
+      "default": true
     },
     "generateStories": {
       "type": "boolean",
-      "description": "Automatically generate *.stories.ts files for components declared in this project?",
+      "description": "Automatically generate `*.stories.ts` files for components declared in this project?",
       "x-prompt": "Automatically generate *.stories.ts files for components declared in this project?",
       "default": true,
       "x-priority": "important"
     },
+    "configureStaticServe": {
+      "type": "boolean",
+      "description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
+      "x-prompt": "Configure a static file server for the storybook instance?",
+      "default": true,
+      "x-priority": "important"
+    },
     "js": {
       "type": "boolean",
       "description": "Generate JavaScript story files rather than TypeScript story files.",
@@ -40,12 +56,6 @@
       "enum": ["eslint"],
       "default": "eslint"
     },
-    "standaloneConfig": {
-      "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
-      "type": "boolean",
-      "default": true,
-      "x-deprecated": "Nx only supports standaloneConfig"
-    },
     "ignorePaths": {
       "type": "array",
       "description": "Paths to ignore when looking for components.",
@@ -65,5 +75,5 @@
       ]
     }
   },
-  "required": ["name"]
+  "required": ["project"]
 }

package/src/generators/upgrade-native/lib/normalize-options.d.ts

@@ -6,7 +6,7 @@ export interface NormalizedSchema {
     lowerCaseName: string;
     entryFile: string;
     entryFileIos: string;
-    e2eTestRunner: 'detox' | 'none';
+    e2eTestRunner: 'cypress' | 'playwright' | 'detox' | 'none';
     offsetFromRoot: string;
 }
 export declare function normalizeOptions(options: UpgradeNativeConfigureSchema, appProjectRoot: string): NormalizedSchema;

package/src/generators/upgrade-native/schema.d.ts

@@ -4,6 +4,6 @@ export interface UpgradeNativeConfigureSchema {
   name: string;
   displayName?: string;
   js: boolean; // default is false
-  e2eTestRunner: 'detox' | 'none'; // default is detox
+  e2eTestRunner: 'cypress' | 'playwright' | 'detox' | 'none'; // default is cypress
   install: boolean; // default is true
 }

package/src/generators/upgrade-native/schema.json

@@ -27,8 +27,8 @@
     "e2eTestRunner": {
       "description": "Adds the specified e2e test runner.",
       "type": "string",
-      "enum": ["detox", "none"],
-      "default": "detox"
+      "enum": ["cypress", "playwright", "detox", "none"],
+      "default": "cypress"
     },
     "install": {
       "type": "boolean",

package/src/generators/upgrade-native/upgrade-native.d.ts

@@ -1,4 +1,6 @@
 /**
+ * @deprecated use `nx run @nx/react-native:upgrade` instead.
+ * TODO (@xiongemi): remove this generator for nx v19
  * This function is a destructive command that replace React Native iOS and Android code with latest.
  * It would replace the Android and iOS folder entirely.
  */

package/src/generators/upgrade-native/upgrade-native.js

@@ -1,5 +1,7 @@
 "use strict";
 /**
+ * @deprecated use `nx run @nx/react-native:upgrade` instead.
+ * TODO (@xiongemi): remove this generator for nx v19
  * This function is a destructive command that replace React Native iOS and Android code with latest.
  * It would replace the Android and iOS folder entirely.
  */
@@ -11,6 +13,7 @@ const pod_install_task_1 = require("../../utils/pod-install-task");
 const chmod_android_gradle_files_1 = require("../../utils/chmod-android-gradle-files");
 const create_native_files_1 = require("./lib/create-native-files");
 async function reactNativeUpgradeNativeGenerator(host, schema) {
+    devkit_1.logger.warn(`Please run 'nx run @nx/react-native:upgrade ${schema.name}' instead.`);
     const { projectType, root: appProjectRoot } = (0, devkit_1.readProjectConfiguration)(host, schema.name);
     const iosProjectRoot = (0, devkit_1.joinPathFragments)(host.root, appProjectRoot, 'ios');
     const androidProjectRoot = (0, devkit_1.joinPathFragments)(host.root, appProjectRoot, 'android');

package/src/generators/web-configuration/files/base-vite/.babelrc.js.template

@@ -0,0 +1,23 @@
+module.exports = function (api) {
+  api.cache(true);
+
+  if (
+    process.env.NX_TASK_TARGET_TARGET === 'build' ||
+    process.env.NX_TASK_TARGET_TARGET.includes('storybook')
+  ) {
+    return {
+      presets: [
+        [
+          '@nx/react/babel',
+          {
+            runtime: 'automatic',
+          },
+        ],
+      ],
+    };
+  }
+
+  return {
+    presets: [['module:@react-native/babel-preset',  { "useTransformReactJSX": true }]],
+  };
+};

package/src/generators/web-configuration/files/base-vite/index.html__tmpl__

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en" style="height: 100%">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= className %></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 style="height:100%">
+    <div id="root" style="display: flex; height: 100%"></div>
+    <script type="module" src="/src/main-web.tsx"></script>
+  </body>
+</html>

package/src/generators/web-configuration/files/base-vite/src/main-web.tsx__tmpl__

@@ -0,0 +1,9 @@
+import { StrictMode } from 'react';
+import * as ReactDOM from 'react-dom/client';
+
+import App from './app/App';
+
+const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
+root.render(
+  <StrictMode><App /></StrictMode>
+);

package/src/generators/web-configuration/files/base-vite/vite.config.ts__tmpl__

@@ -0,0 +1,82 @@
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
+import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
+import * as esbuild from 'esbuild';
+import { readFileSync } from 'fs';
+
+const extensions = [
+  '.mjs',
+  '.web.tsx',
+  '.tsx',
+  '.web.ts',
+  '.ts',
+  '.web.jsx',
+  '.jsx',
+  '.web.js',
+  '.js',
+  '.css',
+  '.json',
+];
+
+const rollupPlugin = (matchers: RegExp[]) => ({
+  name: 'js-in-jsx',
+  load(id: string) {
+    if (matchers.some((matcher) => matcher.test(id)) && id.endsWith('.js')) {
+      const file = readFileSync(id, { encoding: 'utf-8' });
+      return esbuild.transformSync(file, { loader: 'jsx', jsx: 'automatic' });
+    }
+  },
+});
+
+export default defineConfig({
+  root: __dirname,
+  cacheDir: '../../node_modules/.vite/<%= fileName %>',
+  define: {
+    global: 'window',
+  },
+
+  resolve: {
+    extensions,
+    alias: {
+      'react-native': 'react-native-web',
+    },
+  },
+
+  build: {
+    reportCompressedSize: true,
+    commonjsOptions: { transformMixedEsModules: true },
+    outDir: '../../dist/apps/<%= fileName %>/web',
+    rollupOptions: {
+      plugins: [rollupPlugin([/react-native-vector-icons/])],
+    },
+  },
+
+  server: {
+    port: 4200,
+    host: 'localhost',
+    fs: {
+      // Allow serving files from one level up to the project root
+      allow: ['..'],
+    },
+  },
+
+  preview: {
+    port: 4300,
+    host: 'localhost',
+  },
+
+  optimizeDeps: {
+    esbuildOptions: {
+      resolveExtensions: extensions,
+      jsx: 'automatic',
+      loader: { '.js': 'jsx' },
+    },
+  },
+
+  plugins: [react(), nxViteTsPaths()],
+
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+});

package/src/generators/web-configuration/files/base-webpack/.babelrc.js.template

@@ -0,0 +1,23 @@
+module.exports = function (api) {
+  api.cache(true);
+
+  if (
+    process.env.NX_TASK_TARGET_TARGET === 'build' ||
+    process.env.NX_TASK_TARGET_TARGET.includes('storybook')
+  ) {
+    return {
+      presets: [
+        [
+          '@nx/react/babel',
+          {
+            runtime: 'automatic',
+          },
+        ],
+      ],
+    };
+  }
+
+  return {
+    presets: [['module:@react-native/babel-preset',  { "useTransformReactJSX": true }]],
+  };
+};

package/src/generators/web-configuration/files/base-webpack/src/index.html__tmpl__

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en" style="height: 100%">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= className %></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 style="height:100%">
+    <div id="root" style="display: flex; height: 100%"></div>
+  </body>
+</html>

package/src/generators/web-configuration/files/base-webpack/src/main-web.tsx__tmpl__

@@ -0,0 +1,9 @@
+import { StrictMode } from 'react';
+import * as ReactDOM from 'react-dom/client';
+
+import App from './app/App';
+
+const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
+root.render(
+  <StrictMode><App /></StrictMode>
+);

package/src/generators/web-configuration/files/base-webpack/webpack.config.js__tmpl__

@@ -0,0 +1,77 @@
+<% if (webpackPluginOptions) { %>
+const { NxWebpackPlugin } = require('@nx/webpack');
+const { NxReactWebpackPlugin } = require('@nx/react');
+
+module.exports = {
+  resolve: {
+    alias: {
+      'react-native$': 'react-native-web',
+    },
+    extensions: ['.web.tsx', '.web.ts', '.web.jsx', '.web.js']
+  },
+  devServer: {
+    port: 4200
+  },
+  plugins: [
+    new NxWebpackPlugin({
+      tsConfig: '<%= webpackPluginOptions.tsConfig %>',
+      compiler: '<%= webpackPluginOptions.compiler %>',
+      main: '<%= webpackPluginOptions.main %>',
+      index: '<%= webpackPluginOptions.index %>',
+      outputPath: '<%= webpackPluginOptions.outputPath %>', 
+      baseHref: '<%= webpackPluginOptions.baseHref %>',
+      assets: <%- JSON.stringify(webpackPluginOptions.assets) %>,
+      styles: <%- JSON.stringify(webpackPluginOptions.styles) %>,
+      outputHashing: process.env['NODE_ENV'] === 'production' ? 'all' : 'none',
+      optimization: process.env['NODE_ENV'] === 'production',
+    }),
+    new NxReactWebpackPlugin({
+      // Uncomment this line if you don't want to use SVGR
+      // See: https://react-svgr.com/
+      // svgr: false
+    }),
+  ],
+};
+<% } else { %>
+const { composePlugins, withNx } = require('@nx/webpack');
+const { withReact } = require('@nx/react');
+
+// Nx plugins for webpack.
+module.exports = composePlugins(
+  withNx(),
+  withReact({
+    // Uncomment this line if you don't want to use SVGR
+    // See: https://react-svgr.com/
+    // svgr: false
+  }),
+  (config) => {
+    // Update the webpack config as needed here.
+    // e.g. `config.plugins.push(new MyPlugin())`
+    
+  config.resolve.alias = {
+    ...config.resolve.alias ?? {},
+    'react-native$': 'react-native-web',
+  };
+  config.resolve.extensions = [
+    '.web.tsx',
+    '.web.ts',
+    '.web.jsx',
+    '.web.js',
+    ...config.resolve.extensions,
+  ];
+  config.module.rules.push({
+    test: /\.(js|jsx)$/,
+    include: /react-native-vector-icons/,
+    loader: 'babel-loader',
+    options: {
+      presets: [
+        '@babel/preset-env',
+        ['@babel/preset-react', { runtime: 'automatic' }],
+      ],
+    },
+  });
+  
+  return config;
+  }
+);
+<% } %>

package/src/generators/web-configuration/lib/normalize-schema.d.ts

@@ -0,0 +1,17 @@
+import { Tree } from '@nx/devkit';
+import { WebConfigurationGeneratorSchema } from '../schema';
+export interface NormalizedSchema extends WebConfigurationGeneratorSchema {
+    projectRoot: string;
+    fileName: string;
+    className: string;
+}
+export declare function normalizeSchema(tree: Tree, schema: WebConfigurationGeneratorSchema): {
+    projectRoot: string;
+    offsetFromRoot: string;
+    fileName: string;
+    className: string;
+    project: string;
+    bundler: "vite" | "webpack";
+    skipFormat?: boolean;
+    skipPackageJson?: boolean;
+};

package/src/generators/web-configuration/lib/normalize-schema.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSchema = void 0;
+const devkit_1 = require("@nx/devkit");
+function normalizeSchema(tree, schema) {
+    const project = (0, devkit_1.getProjects)(tree).get(schema.project);
+    const { fileName, className } = (0, devkit_1.names)(schema.project);
+    return {
+        ...schema,
+        projectRoot: project.root,
+        offsetFromRoot: (0, devkit_1.offsetFromRoot)(project.root),
+        fileName,
+        className,
+    };
+}
+exports.normalizeSchema = normalizeSchema;

package/src/generators/web-configuration/lib/webpack-targets.d.ts

@@ -0,0 +1,7 @@
+import { TargetConfiguration } from '@nx/devkit';
+import type { WithReactOptions } from '@nx/react';
+import type { WithNxOptions } from '@nx/webpack';
+import { NormalizedSchema } from './normalize-schema';
+export declare function createBuildTarget(options: NormalizedSchema): TargetConfiguration;
+export declare function createServeTarget(options: NormalizedSchema): TargetConfiguration;
+export declare function createNxWebpackPluginOptions(options: NormalizedSchema): WithNxOptions & WithReactOptions;

package/src/generators/web-configuration/lib/webpack-targets.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNxWebpackPluginOptions = exports.createServeTarget = exports.createBuildTarget = void 0;
+const devkit_1 = require("@nx/devkit");
+function createBuildTarget(options) {
+    return {
+        executor: '@nx/webpack:webpack',
+        outputs: ['{options.outputPath}'],
+        defaultConfiguration: 'production',
+        options: {
+            compiler: 'babel',
+            outputPath: (0, devkit_1.joinPathFragments)('dist', options.projectRoot != '.' ? options.projectRoot : options.project, 'web'),
+            index: (0, devkit_1.joinPathFragments)(options.projectRoot, 'src/index.html'),
+            baseHref: '/',
+            main: (0, devkit_1.joinPathFragments)(options.projectRoot, `src/main-web.tsx`),
+            tsConfig: (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.app.json'),
+            assets: [
+                (0, devkit_1.joinPathFragments)(options.projectRoot, 'src/favicon.ico'),
+                (0, devkit_1.joinPathFragments)(options.projectRoot, 'src/assets'),
+            ],
+            webpackConfig: (0, devkit_1.joinPathFragments)(options.projectRoot, 'webpack.config.js'),
+        },
+        configurations: {
+            development: {
+                extractLicenses: false,
+                optimization: false,
+                sourceMap: true,
+                vendorChunk: true,
+            },
+            production: {
+                optimization: true,
+                outputHashing: 'all',
+                sourceMap: false,
+                namedChunks: false,
+                extractLicenses: true,
+                vendorChunk: false,
+            },
+        },
+    };
+}
+exports.createBuildTarget = createBuildTarget;
+function createServeTarget(options) {
+    return {
+        executor: '@nx/webpack:dev-server',
+        defaultConfiguration: 'development',
+        options: {
+            buildTarget: `${options.project}:build`,
+            hmr: true,
+        },
+        configurations: {
+            development: {
+                buildTarget: `${options.project}:build:development`,
+            },
+            production: {
+                buildTarget: `${options.project}:build:production`,
+                hmr: false,
+            },
+        },
+    };
+}
+exports.createServeTarget = createServeTarget;
+function createNxWebpackPluginOptions(options) {
+    return {
+        target: 'web',
+        compiler: 'babel',
+        outputPath: (0, devkit_1.joinPathFragments)('dist', options.projectRoot != '.' ? options.projectRoot : options.project),
+        index: './src/index.html',
+        baseHref: '/',
+        main: `./src/main-web.tsx`,
+        tsConfig: './tsconfig.app.json',
+        assets: ['./src/favicon.ico', './src/assets'],
+        styles: [],
+    };
+}
+exports.createNxWebpackPluginOptions = createNxWebpackPluginOptions;

package/src/generators/web-configuration/schema.d.ts

@@ -0,0 +1,6 @@
+export interface WebConfigurationGeneratorSchema {
+  project: string;
+  bundler: 'vite' | 'webpack';
+  skipFormat?: boolean;
+  skipPackageJson?: boolean; //default is false
+}

package/src/generators/web-configuration/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "NxReactNativeWebConfiguration",
+  "description": "Setup web configuration to React Native apps using react-native-web.",
+  "title": "Nx React Native Web configuration",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "aliases": ["name", "projectName"],
+      "description": "Project for which to generate web configuration.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "For which project do you want to generate web configuration?",
+      "x-dropdown": "projects",
+      "x-priority": "important"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "bundler": {
+      "description": "The bundler to use.",
+      "type": "string",
+      "enum": ["vite", "webpack"],
+      "x-prompt": "Which bundler do you want to use to build the application?",
+      "default": "webpack",
+      "x-priority": "important"
+    }
+  },
+  "required": ["project", "bundler"]
+}

package/src/generators/web-configuration/web-configuration.d.ts

@@ -0,0 +1,12 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+import { WebConfigurationGeneratorSchema } from './schema';
+/**
+ * This function sets web configuration for react native apps with react-native-web.
+ * 1. install react-native-web
+ * 2. apply webpack or vite init generator
+ * 3. create files for webpack or vite config, index.html, assets folder, babel.config.js
+ * @param tree
+ * @param options
+ */
+export declare function webConfigurationGenerator(tree: Tree, options: WebConfigurationGeneratorSchema): Promise<GeneratorCallback>;
+export default webConfigurationGenerator;

package/src/generators/web-configuration/web-configuration.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webConfigurationGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const has_webpack_plugin_1 = require("@nx/react/src/utils/has-webpack-plugin");
+const versions_1 = require("../../utils/versions");
+const normalize_schema_1 = require("./lib/normalize-schema");
+const webpack_targets_1 = require("./lib/webpack-targets");
+/**
+ * This function sets web configuration for react native apps with react-native-web.
+ * 1. install react-native-web
+ * 2. apply webpack or vite init generator
+ * 3. create files for webpack or vite config, index.html, assets folder, babel.config.js
+ * @param tree
+ * @param options
+ */
+async function webConfigurationGenerator(tree, options) {
+    const normalizedSchema = (0, normalize_schema_1.normalizeSchema)(tree, options);
+    const tasks = [];
+    // install react-native-web
+    if (!options.skipPackageJson) {
+        const installTask = (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+            'react-native-web': versions_1.reactNativeWebVersion,
+        });
+        tasks.push(installTask);
+    }
+    // apply webpack or vite init generator
+    const bundlerTask = await addBundlerConfiguration(tree, normalizedSchema);
+    tasks.push(bundlerTask);
+    // create files for webpack and vite config, index.html
+    if (normalizedSchema.bundler === 'vite') {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, './files/base-vite'), normalizedSchema.projectRoot, { ...normalizedSchema, tmpl: '' });
+    }
+    else {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, './files/base-webpack'), normalizedSchema.projectRoot, {
+            ...normalizedSchema,
+            tmpl: '',
+            webpackPluginOptions: (0, has_webpack_plugin_1.hasWebpackPlugin)(tree)
+                ? (0, webpack_targets_1.createNxWebpackPluginOptions)(normalizedSchema)
+                : null,
+        });
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.webConfigurationGenerator = webConfigurationGenerator;
+/**
+ * Add bundler configuration
+ * - for vite, viteConfigurationGenerator contains logics to add build and serve target
+ * - for webpack, need to explict add the build and serve target
+ */
+async function addBundlerConfiguration(tree, normalizedSchema) {
+    if (normalizedSchema.bundler === 'vite') {
+        const { viteConfigurationGenerator } = (0, devkit_1.ensurePackage)('@nx/vite', versions_1.nxVersion);
+        const viteTask = await viteConfigurationGenerator(tree, {
+            uiFramework: 'react',
+            project: normalizedSchema.project,
+            newProject: true,
+            includeVitest: false,
+            compiler: 'babel',
+            skipFormat: true,
+        });
+        return viteTask;
+    }
+    else {
+        const { webpackInitGenerator } = (0, devkit_1.ensurePackage)('@nx/webpack', versions_1.nxVersion);
+        const webpackInitTask = await webpackInitGenerator(tree, {
+            skipFormat: true,
+            skipPackageJson: normalizedSchema.skipPackageJson,
+        });
+        if (!(0, has_webpack_plugin_1.hasWebpackPlugin)(tree)) {
+            const projectConfiguration = (0, devkit_1.readProjectConfiguration)(tree, normalizedSchema.project);
+            projectConfiguration.targets = {
+                ...projectConfiguration.targets,
+                build: (0, webpack_targets_1.createBuildTarget)(normalizedSchema),
+                serve: (0, webpack_targets_1.createServeTarget)(normalizedSchema),
+            };
+            (0, devkit_1.updateProjectConfiguration)(tree, normalizedSchema.project, projectConfiguration);
+        }
+        return webpackInitTask;
+    }
+}
+exports.default = webConfigurationGenerator;