@nx/rsbuild 0.0.0-pr-29314-e664f92

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2017-2024 Narwhal Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
+
+<div style="text-align: center;">
+
+[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
+[![License](https://img.shields.io/npm/l/@nx/workspace.svg?style=flat-square)]()
+[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nx/workspace)
+[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join us on the Official Nx Discord Server](https://img.shields.io/discord/1143497901675401286?label=discord)](https://go.nx.dev/community)
+
+</div>
+
+
+<hr>
+
+# Nx: Smart Monorepos · Fast CI
+
+Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.
+
+This package is a [Rsbuild plugin for Nx](https://nx.dev/nx-api/rsbuild).
+
+## Getting Started
+
+### Creating an Nx Workspace
+
+**Using `npx`**
+
+```bash
+npx create-nx-workspace
+```
+
+**Using `npm init`**
+
+```bash
+npm init nx-workspace
+```
+
+**Using `yarn create`**
+
+```bash
+yarn create nx-workspace
+```
+
+### Adding Nx to an Existing Repository
+
+Run:
+
+```bash
+npx nx@latest init
+```
+
+## Documentation & Resources
+
+- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)
+- [Intro to Nx](https://nx.dev/getting-started/intro)
+- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)
+- [Blog Posts About Nx](https://nx.dev/blog)
+
+<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
+

package/executors.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "executors": {}
+}

package/generators.json

@@ -0,0 +1,13 @@
+{
+  "name": "Nx Rsbuild",
+  "version": "0.1",
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/init#initGeneratorInternal",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the `@nx/rsbuild` plugin.",
+      "aliases": ["ng-add"],
+      "hidden": true
+    }
+  }
+}

package/migrations.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "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",
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nrwl/nx.git",
+    "directory": "packages/rsbuild"
+  },
+  "bugs": {
+    "url": "https://github.com/nrwl/nx/issues"
+  },
+  "keywords": [
+    "Monorepo",
+    "Rspack",
+    "Webpack",
+    "Bundling",
+    "Module Federation",
+    "Rsbuild"
+  ],
+  "author": "Colum Ferry",
+  "license": "MIT",
+  "homepage": "https://nx.dev",
+  "main": "index.js",
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "dependencies": {
+    "tslib": "^2.3.0",
+    "@nx/devkit": "0.0.0-pr-29314-e664f92",
+    "@nx/js": "0.0.0-pr-29314-e664f92",
+    "@rsbuild/core": "1.1.8",
+    "minimatch": "9.0.3"
+  },
+  "peerDependencies": {},
+  "nx-migrations": {
+    "migrations": "./migrations.json"
+  },
+  "types": "./index.d.ts"
+}

package/plugin.d.ts

@@ -0,0 +1 @@
+export { createNodesV2, RsbuildPluginOptions } from './src/plugins/plugin';

package/plugin.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodesV2 = void 0;
+var plugin_1 = require("./src/plugins/plugin");
+Object.defineProperty(exports, "createNodesV2", { enumerable: true, get: function () { return plugin_1.createNodesV2; } });

package/src/generators/init/init.d.ts

@@ -0,0 +1,6 @@
+import { type Tree, type GeneratorCallback } from '@nx/devkit';
+import { InitGeneratorSchema } from './schema';
+export declare function updateDependencies(tree: Tree, schema: InitGeneratorSchema): GeneratorCallback;
+export declare function initGenerator(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
+export declare function initGeneratorInternal(tree: Tree, schema: InitGeneratorSchema): Promise<GeneratorCallback>;
+export default initGenerator;

package/src/generators/init/init.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateDependencies = updateDependencies;
+exports.initGenerator = initGenerator;
+exports.initGeneratorInternal = initGeneratorInternal;
+const devkit_1 = require("@nx/devkit");
+const add_plugin_1 = require("@nx/devkit/src/utils/add-plugin");
+const plugin_1 = require("../../plugins/plugin");
+const versions_1 = require("../../utils/versions");
+function updateDependencies(tree, schema) {
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+        '@nx/rsbuild': versions_1.nxVersion,
+        '@rsbuild/core': versions_1.rsbuildVersion,
+    }, undefined, schema.keepExistingVersions);
+}
+function initGenerator(tree, schema) {
+    return initGeneratorInternal(tree, { addPlugin: false, ...schema });
+}
+async function initGeneratorInternal(tree, schema) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    schema.addPlugin ??= addPluginDefault;
+    if (schema.addPlugin) {
+        await (0, add_plugin_1.addPlugin)(tree, await (0, devkit_1.createProjectGraphAsync)(), '@nx/rsbuild/plugin', plugin_1.createNodesV2, {
+            buildTargetName: ['build', 'rsbuild:build', 'rsbuild-build'],
+            devTargetName: ['dev', 'rsbuild:dev', 'rsbuild-dev'],
+            previewTargetName: ['preview', 'rsbuild:preview', 'rsbuild-preview'],
+            inspectTargetName: ['inspect', 'rsbuild:inspect', 'rsbuild-inspect'],
+            typecheckTargetName: [
+                'typecheck',
+                'rsbuild:typecheck',
+                'rsbuild-typecheck',
+            ],
+        }, schema.updatePackageScripts);
+    }
+    const tasks = [];
+    if (!schema.skipPackageJson) {
+        tasks.push(updateDependencies(tree, schema));
+    }
+    if (!schema.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.default = initGenerator;

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

@@ -0,0 +1,7 @@
+export interface InitGeneratorSchema {
+  keepExistingVersions?: boolean;
+  updatePackageScripts?: boolean;
+  addPlugin?: boolean;
+  skipFormat?: boolean;
+  skipPackageJson?: boolean;
+}

package/src/generators/init/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "Init",
+  "title": "Nx Rsbuild Init Generator",
+  "type": "object",
+  "description": "Rsbuild init generator.",
+  "properties": {
+    "rootProject": {
+      "type": "boolean",
+      "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update package scripts",
+      "default": false
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": []
+}

package/src/plugins/plugin.d.ts

@@ -0,0 +1,9 @@
+import { CreateNodesV2 } from '@nx/devkit';
+export interface RsbuildPluginOptions {
+    buildTargetName?: string;
+    devTargetName?: string;
+    previewTargetName?: string;
+    inspectTargetName?: string;
+    typecheckTargetName?: string;
+}
+export declare const createNodesV2: CreateNodesV2<RsbuildPluginOptions>;

package/src/plugins/plugin.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodesV2 = void 0;
+const devkit_1 = require("@nx/devkit");
+const get_named_inputs_1 = require("@nx/devkit/src/utils/get-named-inputs");
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
+const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
+const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
+const js_1 = require("@nx/js");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const minimatch_1 = require("minimatch");
+const core_1 = require("@rsbuild/core");
+const pmc = (0, devkit_1.getPackageManagerCommand)();
+function readTargetsCache(cachePath) {
+    return (0, fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
+}
+function writeTargetsCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
+}
+const rsbuildConfigGlob = '**/rsbuild.config.{js,ts,mjs,mts,cjs,cts}';
+exports.createNodesV2 = [
+    rsbuildConfigGlob,
+    async (configFilePaths, options, context) => {
+        const optionsHash = (0, file_hasher_1.hashObject)(options);
+        const cachePath = (0, path_1.join)(cache_directory_1.workspaceDataDirectory, `rsbuild-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        const isUsingTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)();
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => createNodesInternal(configFile, options, context, targetsCache, isUsingTsSolutionSetup), configFilePaths, options, context);
+        }
+        finally {
+            writeTargetsCache(cachePath, targetsCache);
+        }
+    },
+];
+async function createNodesInternal(configFilePath, options, context, targetsCache, isUsingTsSolutionSetup) {
+    const projectRoot = (0, path_1.dirname)(configFilePath);
+    // Do not create a project if package.json and project.json isn't there.
+    const siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(context.workspaceRoot, projectRoot));
+    if (!siblingFiles.includes('package.json') &&
+        !siblingFiles.includes('project.json')) {
+        return {};
+    }
+    const tsConfigFiles = siblingFiles.filter((p) => (0, minimatch_1.minimatch)(p, 'tsconfig*{.json,.*.json}')) ?? [];
+    const normalizedOptions = normalizeOptions(options);
+    const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(projectRoot, normalizedOptions, context, [(0, js_1.getLockFileName)((0, devkit_1.detectPackageManager)(context.workspaceRoot))]);
+    targetsCache[hash] ??= await createRsbuildTargets(configFilePath, projectRoot, normalizedOptions, tsConfigFiles, isUsingTsSolutionSetup, context);
+    const { targets, metadata } = targetsCache[hash];
+    return {
+        projects: {
+            [projectRoot]: {
+                root: projectRoot,
+                targets,
+                metadata,
+            },
+        },
+    };
+}
+async function createRsbuildTargets(configFilePath, projectRoot, options, tsConfigFiles, isUsingTsSolutionSetup, context) {
+    const absoluteConfigFilePath = (0, devkit_1.joinPathFragments)(context.workspaceRoot, configFilePath);
+    const rsbuildConfig = await (0, core_1.loadConfig)({
+        path: absoluteConfigFilePath,
+    });
+    if (!rsbuildConfig.filePath) {
+        return { targets: {}, metadata: {} };
+    }
+    const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
+    const { buildOutputs } = getOutputs(rsbuildConfig.content, projectRoot, context.workspaceRoot);
+    const targets = {};
+    targets[options.buildTargetName] = {
+        command: `rsbuild build`,
+        options: { cwd: projectRoot, args: ['--mode=production'] },
+        cache: true,
+        dependsOn: [`^${options.buildTargetName}`],
+        inputs: [
+            ...('production' in namedInputs
+                ? ['production', '^production']
+                : ['default', '^default']),
+            {
+                externalDependencies: ['@rsbuild/core'],
+            },
+        ],
+        outputs: buildOutputs,
+        metadata: {
+            technologies: ['rsbuild'],
+            description: `Run Rsbuild build`,
+            help: {
+                command: `${pmc.exec} rsbuild build --help`,
+                example: {
+                    options: {
+                        watch: false,
+                    },
+                },
+            },
+        },
+    };
+    targets[options.devTargetName] = {
+        command: `rsbuild dev`,
+        options: {
+            cwd: projectRoot,
+            args: ['--mode=development'],
+        },
+    };
+    targets[options.previewTargetName] = {
+        command: `rsbuild preview`,
+        options: {
+            cwd: projectRoot,
+            args: ['--mode=production'],
+        },
+    };
+    targets[options.inspectTargetName] = {
+        command: `rsbuild inspect`,
+        options: {
+            cwd: projectRoot,
+        },
+    };
+    if (tsConfigFiles.length) {
+        const tsConfigToUse = ['tsconfig.app.json', 'tsconfig.lib.json', 'tsconfig.json'].find((t) => tsConfigFiles.includes(t)) ?? tsConfigFiles[0];
+        targets[options.typecheckTargetName] = {
+            cache: true,
+            inputs: [
+                ...('production' in namedInputs
+                    ? ['production', '^production']
+                    : ['default', '^default']),
+                { externalDependencies: ['typescript'] },
+            ],
+            command: isUsingTsSolutionSetup
+                ? `tsc --build --emitDeclarationOnly --pretty --verbose`
+                : `tsc --noEmit -p ${tsConfigToUse}`,
+            options: { cwd: (0, devkit_1.joinPathFragments)(projectRoot) },
+            metadata: {
+                description: `Run Typechecking`,
+                help: {
+                    command: `${pmc.exec} tsc --help -p ${tsConfigToUse}`,
+                    example: {
+                        options: {
+                            noEmit: true,
+                        },
+                    },
+                },
+            },
+        };
+    }
+    return { targets, metadata: {} };
+}
+function getOutputs(rsbuildConfig, projectRoot, workspaceRoot) {
+    const buildOutputPath = normalizeOutputPath(rsbuildConfig?.output?.distPath?.root
+        ? (0, path_1.dirname)(rsbuildConfig?.output.distPath.root)
+        : undefined, projectRoot, workspaceRoot, 'dist');
+    return {
+        buildOutputs: [buildOutputPath],
+    };
+}
+function normalizeOutputPath(outputPath, projectRoot, workspaceRoot, path) {
+    if (!outputPath) {
+        if (projectRoot === '.') {
+            return `{projectRoot}/${path}`;
+        }
+        else {
+            return `{workspaceRoot}/${path}/{projectRoot}`;
+        }
+    }
+    else {
+        if ((0, path_1.isAbsolute)(outputPath)) {
+            return `{workspaceRoot}/${(0, path_1.relative)(workspaceRoot, outputPath)}`;
+        }
+        else {
+            if (outputPath.startsWith('..')) {
+                return (0, path_1.join)('{workspaceRoot}', (0, path_1.join)(projectRoot, outputPath));
+            }
+            else {
+                return (0, path_1.join)('{projectRoot}', outputPath);
+            }
+        }
+    }
+}
+function normalizeOptions(options) {
+    options ??= {};
+    options.buildTargetName ??= 'build';
+    options.devTargetName ??= 'dev';
+    options.previewTargetName ??= 'preview';
+    options.inspectTargetName ??= 'inspect';
+    options.typecheckTargetName ??= 'typecheck';
+    return options;
+}

package/src/utils/versions.d.ts

@@ -0,0 +1,2 @@
+export declare const nxVersion: any;
+export declare const rsbuildVersion = "1.1.8";

package/src/utils/versions.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rsbuildVersion = exports.nxVersion = void 0;
+exports.nxVersion = require('../../package.json').version;
+exports.rsbuildVersion = '1.1.8';