@nx/rsbuild 0.0.0-pr-29314-e664f92 → 20.3.0-beta.1

package/generators.json

@@ -8,6 +8,11 @@
       "description": "Initialize the `@nx/rsbuild` plugin.",
       "aliases": ["ng-add"],
       "hidden": true
+    },
+    "configuration": {
+      "factory": "./src/generators/configuration/configuration",
+      "schema": "./src/generators/configuration/schema.json",
+      "description": "Add an Rsbuild configuration for the provided project."
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nx/rsbuild",
   "description": "The Nx Plugin for Rsbuild contains an Nx plugin, executors and utilities that support building applications using Rsbuild.",
-  "version": "0.0.0-pr-29314-e664f92",
+  "version": "20.3.0-beta.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"
@@ -30,8 +30,8 @@
   "executors": "./executors.json",
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "0.0.0-pr-29314-e664f92",
-    "@nx/js": "0.0.0-pr-29314-e664f92",
+    "@nx/devkit": "20.3.0-beta.1",
+    "@nx/js": "20.3.0-beta.1",
     "@rsbuild/core": "1.1.8",
     "minimatch": "9.0.3"
   },

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

@@ -0,0 +1,4 @@
+import { GeneratorCallback, type Tree } from '@nx/devkit';
+import { type Schema } from './schema';
+export declare function configurationGenerator(tree: Tree, schema: Schema): Promise<GeneratorCallback>;
+export default configurationGenerator;

package/src/generators/configuration/configuration.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configurationGenerator = configurationGenerator;
+const devkit_1 = require("@nx/devkit");
+const lib_1 = require("./lib");
+const js_1 = require("@nx/js");
+const init_1 = require("../init/init");
+const versions_1 = require("../../utils/versions");
+const path_1 = require("path");
+async function configurationGenerator(tree, schema) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    const projects = (0, devkit_1.readProjectsConfigurationFromProjectGraph)(projectGraph);
+    const project = projects.projects[schema.project];
+    if (!project) {
+        throw new Error(`Could not find project '${schema.project}'. Please choose a project that exists in the Nx Workspace.`);
+    }
+    const options = await (0, lib_1.normalizeOptions)(tree, schema, project);
+    const tasks = [];
+    const jsInitTask = await (0, js_1.initGenerator)(tree, {
+        ...schema,
+        skipFormat: true,
+        tsConfigName: options.projectRoot === '.' ? 'tsconfig.json' : 'tsconfig.base.json',
+    });
+    tasks.push(jsInitTask);
+    const initTask = await (0, init_1.initGenerator)(tree, { skipFormat: true });
+    tasks.push(initTask);
+    if (options.skipValidation) {
+        const projectJson = (0, devkit_1.readProjectConfiguration)(tree, project.name);
+        if (projectJson.targets['build']) {
+            delete projectJson.targets['build'];
+        }
+        if (projectJson.targets['serve']) {
+            delete projectJson.targets['serve'];
+        }
+        if (projectJson.targets['dev']) {
+            delete projectJson.targets['dev'];
+        }
+    }
+    tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@rsbuild/core': versions_1.rsbuildVersion }));
+    (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, 'files'), options.projectRoot, {
+        ...options,
+        tpl: '',
+    });
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.default = configurationGenerator;

package/src/generators/configuration/files/rsbuild.config.ts__tpl__

@@ -0,0 +1,16 @@
+import { defineConfig } from '@rsbuild/core';
+
+export default defineConfig({
+    source: {
+        entry: {
+            index: '<%= entry %>'
+        },<% if (tsConfig) { %>
+        tsconfigPath: '<%= tsConfig %>',<% } %>
+    },
+    output: {
+        target: '<%= target %>',
+        distPath: {
+            root: 'dist',
+        },
+    }
+});

package/src/generators/configuration/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './normalize-options';

package/src/generators/configuration/lib/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./normalize-options"), exports);

package/src/generators/configuration/lib/normalize-options.d.ts

@@ -0,0 +1,9 @@
+import { type Tree, type ProjectConfiguration } from '@nx/devkit';
+import { type Schema } from '../schema';
+export interface NormalizedOptions extends Schema {
+    entry: string;
+    target: 'node' | 'web' | 'web-worker';
+    tsConfig: string;
+    projectRoot: string;
+}
+export declare function normalizeOptions(tree: Tree, schema: Schema, project: ProjectConfiguration): Promise<NormalizedOptions>;

package/src/generators/configuration/lib/normalize-options.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeOptions = normalizeOptions;
+const devkit_1 = require("@nx/devkit");
+const path_1 = require("path");
+async function normalizeOptions(tree, schema, project) {
+    // Paths should be relative to the project root because inferred task will run from project root
+    let options = {
+        ...schema,
+        target: schema.target ?? 'web',
+        entry: normalizeRelativePath(schema.entry ?? './src/index.ts', project.root),
+        tsConfig: normalizeRelativePath(schema.tsConfig ?? './tsconfig.json', project.root),
+        projectRoot: project.root,
+        skipFormat: schema.skipFormat ?? false,
+        skipValidation: schema.skipValidation ?? false,
+    };
+    if (!schema.tsConfig) {
+        const possibleTsConfigPaths = [
+            './tsconfig.app.json',
+            './tsconfig.lib.json',
+            './tsconfig.json',
+        ];
+        const tsConfigPath = possibleTsConfigPaths.find((p) => tree.exists((0, devkit_1.joinPathFragments)(project.root, p)));
+        options.tsConfig = tsConfigPath ?? undefined;
+    }
+    return options;
+}
+function normalizeRelativePath(filePath, projectRoot) {
+    if (filePath.startsWith('./')) {
+        return filePath;
+    }
+    filePath = filePath.startsWith(projectRoot)
+        ? (0, path_1.relative)(projectRoot, filePath)
+        : filePath;
+    return `./${filePath}`;
+}

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

@@ -0,0 +1,8 @@
+export interface Schema {
+  project: string;
+  entry?: string;
+  tsConfig?: string;
+  target?: 'node' | 'web' | 'web-worker';
+  skipValidation?: boolean;
+  skipFormat?: boolean;
+}

package/src/generators/configuration/schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "Rsbuild",
+  "title": "Nx Rsbuild Configuration Generator",
+  "description": "Rsbuild configuration generator.",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-dropdown": "project",
+      "x-prompt": "What is the name of the project to set up a Rsbuild for?",
+      "x-priority": "important"
+    },
+    "entry": {
+      "type": "string",
+      "description": "Path relative to the workspace root for the entry file. Defaults to '<projectRoot>/src/index.ts'.",
+      "x-priority": "important"
+    },
+    "tsConfig": {
+      "type": "string",
+      "description": "Path relative to the workspace root for the tsconfig file to build with. Defaults to '<projectRoot>/tsconfig.app.json'.",
+      "x-priority": "important"
+    },
+    "target": {
+      "type": "string",
+      "description": "Target platform for the build, same as the Rsbuild output.target config option.",
+      "enum": ["node", "web", "web-worker"],
+      "default": "web"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    }
+  }
+}