@nx/remix 17.0.0 → 17.2.5

package/src/executors/build/build.impl.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const js_1 = require("@nx/js");
 const fileutils_1 = require("@nx/workspace/src/utilities/fileutils");
@@ -14,95 +13,87 @@ function buildRemixBuildArgs(options) {
     }
     return args;
 }
-function runBuild(options, context) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const projectRoot = context.projectGraph.nodes[context.projectName].data.root;
-        return new Promise((resolve, reject) => {
-            const remixBin = require.resolve('@remix-run/dev/dist/cli');
-            const args = buildRemixBuildArgs(options);
-            const p = (0, child_process_1.fork)(remixBin, args, {
-                cwd: (0, path_1.join)(context.root, projectRoot),
-                stdio: 'inherit',
-            });
-            p.on('exit', (code) => {
-                if (code === 0)
-                    resolve();
-                else
-                    reject();
-            });
+async function runBuild(options, context) {
+    const projectRoot = context.projectGraph.nodes[context.projectName].data.root;
+    return new Promise((resolve, reject) => {
+        const remixBin = require.resolve('@remix-run/dev/dist/cli');
+        const args = buildRemixBuildArgs(options);
+        const p = (0, child_process_1.fork)(remixBin, args, {
+            cwd: (0, path_1.join)(context.root, projectRoot),
+            stdio: 'inherit',
+        });
+        p.on('exit', (code) => {
+            if (code === 0)
+                resolve();
+            else
+                reject();
         });
     });
 }
-function buildExecutor(options, context) {
-    var _a;
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const projectRoot = context.projectGraph.nodes[context.projectName].data.root;
-        try {
-            yield runBuild(options, context);
-        }
-        catch (error) {
-            devkit_1.logger.error(`Error occurred while trying to build application. See above for more details.`);
-            return { success: false };
-        }
-        if (!(0, fileutils_1.directoryExists)(options.outputPath)) {
-            (0, fs_extra_1.mkdir)(options.outputPath);
-        }
-        let packageJson;
-        if (options.generatePackageJson) {
-            packageJson = (0, js_1.createPackageJson)(context.projectName, context.projectGraph, {
-                target: context.targetName,
-                root: context.root,
-                isProduction: !options.includeDevDependenciesInPackageJson, // By default we remove devDependencies since this is a production build.
-            });
-            // Update `package.json` to reflect how users should run the build artifacts
-            (_a = packageJson.scripts) !== null && _a !== void 0 ? _a : (packageJson.scripts = {});
-            // Don't override existing custom script since project may have its own server.
-            if (!packageJson.scripts.start) {
-                packageJson.scripts['start'] = 'remix-serve ./build';
-            }
-            updatePackageJson(packageJson, context);
-            (0, devkit_1.writeJsonFile)(`${options.outputPath}/package.json`, packageJson);
-        }
-        else {
-            packageJson = (0, devkit_1.readJsonFile)((0, path_1.join)(projectRoot, 'package.json'));
-        }
-        if (options.generateLockfile) {
-            const packageManager = (0, devkit_1.detectPackageManager)(context.root);
-            const lockFile = (0, js_1.createLockFile)(packageJson, context.projectGraph, packageManager);
-            (0, fs_extra_1.writeFileSync)(`${options.outputPath}/${(0, js_1.getLockFileName)(packageManager)}`, lockFile, {
-                encoding: 'utf-8',
-            });
-        }
-        // If output path is different from source path, then copy over the config and public files.
-        // This is the default behavior when running `nx build <app>`.
-        if (options.outputPath.replace(/\/$/, '') !== projectRoot) {
-            (0, fs_extra_1.copySync)((0, path_1.join)(projectRoot, 'public'), (0, path_1.join)(options.outputPath, 'public'), {
-                dereference: true,
-            });
-            (0, fs_extra_1.copySync)((0, path_1.join)(projectRoot, 'build'), (0, path_1.join)(options.outputPath, 'build'), {
-                dereference: true,
-            });
+async function buildExecutor(options, context) {
+    const projectRoot = context.projectGraph.nodes[context.projectName].data.root;
+    try {
+        await runBuild(options, context);
+    }
+    catch (error) {
+        devkit_1.logger.error(`Error occurred while trying to build application. See above for more details.`);
+        return { success: false };
+    }
+    if (!(0, fileutils_1.directoryExists)(options.outputPath)) {
+        (0, fs_extra_1.mkdir)(options.outputPath);
+    }
+    let packageJson;
+    if (options.generatePackageJson) {
+        packageJson = (0, js_1.createPackageJson)(context.projectName, context.projectGraph, {
+            target: context.targetName,
+            root: context.root,
+            isProduction: !options.includeDevDependenciesInPackageJson, // By default we remove devDependencies since this is a production build.
+        });
+        // Update `package.json` to reflect how users should run the build artifacts
+        packageJson.scripts ??= {};
+        // Don't override existing custom script since project may have its own server.
+        if (!packageJson.scripts.start) {
+            packageJson.scripts['start'] = 'remix-serve ./build';
         }
-        return { success: true };
-    });
+        updatePackageJson(packageJson, context);
+        (0, devkit_1.writeJsonFile)(`${options.outputPath}/package.json`, packageJson);
+    }
+    else {
+        packageJson = (0, devkit_1.readJsonFile)((0, path_1.join)(projectRoot, 'package.json'));
+    }
+    if (options.generateLockfile) {
+        const packageManager = (0, devkit_1.detectPackageManager)(context.root);
+        const lockFile = (0, js_1.createLockFile)(packageJson, context.projectGraph, packageManager);
+        (0, fs_extra_1.writeFileSync)(`${options.outputPath}/${(0, js_1.getLockFileName)(packageManager)}`, lockFile, {
+            encoding: 'utf-8',
+        });
+    }
+    // If output path is different from source path, then copy over the config and public files.
+    // This is the default behavior when running `nx build <app>`.
+    if (options.outputPath.replace(/\/$/, '') !== projectRoot) {
+        (0, fs_extra_1.copySync)((0, path_1.join)(projectRoot, 'public'), (0, path_1.join)(options.outputPath, 'public'), {
+            dereference: true,
+        });
+        (0, fs_extra_1.copySync)((0, path_1.join)(projectRoot, 'build'), (0, path_1.join)(options.outputPath, 'build'), {
+            dereference: true,
+        });
+    }
+    return { success: true };
 }
 exports.default = buildExecutor;
 function updatePackageJson(packageJson, context) {
-    var _a, _b;
-    var _c;
     if (!packageJson.scripts) {
         packageJson.scripts = {};
     }
     if (!packageJson.scripts.start) {
         packageJson.scripts.start = 'remix-serve build';
     }
-    (_a = packageJson.dependencies) !== null && _a !== void 0 ? _a : (packageJson.dependencies = {});
+    packageJson.dependencies ??= {};
     // These are always required for a production Remix app to run.
     const requiredPackages = [
         'react',
         'react-dom',
         'isbot',
-        'typescript',
         '@remix-run/css-bundle',
         '@remix-run/node',
         '@remix-run/react',
@@ -112,8 +103,7 @@ function updatePackageJson(packageJson, context) {
     for (const pkg of requiredPackages) {
         const externalNode = context.projectGraph.externalNodes[`npm:${pkg}`];
         if (externalNode) {
-            (_b = (_c = packageJson.dependencies)[pkg]) !== null && _b !== void 0 ? _b : (_c[pkg] = externalNode.data.version);
+            packageJson.dependencies[pkg] ??= externalNode.data.version;
         }
     }
 }
-//# sourceMappingURL=build.impl.js.map

package/src/executors/serve/serve.impl.js

@@ -1,14 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const async_iterable_1 = require("@nx/devkit/src/utils/async-iterable");
 const wait_for_port_open_1 = require("@nx/web/src/utils/wait-for-port-open");
 const node_child_process_1 = require("node:child_process");
 const node_path_1 = require("node:path");
 function normalizeOptions(schema) {
-    var _a, _b, _c;
-    return Object.assign(Object.assign({}, schema), { port: (_a = schema.port) !== null && _a !== void 0 ? _a : 4200, debug: (_b = schema.debug) !== null && _b !== void 0 ? _b : false, manual: (_c = schema.manual) !== null && _c !== void 0 ? _c : false });
+    return {
+        ...schema,
+        port: schema.port ?? 4200,
+        debug: schema.debug ?? false,
+        manual: schema.manual ?? false,
+    };
 }
 function buildRemixDevArgs(options) {
     const args = [];
@@ -32,46 +35,43 @@ function buildRemixDevArgs(options) {
     }
     return args;
 }
-function serveExecutor(schema, context) {
-    return tslib_1.__asyncGenerator(this, arguments, function* serveExecutor_1() {
-        const options = normalizeOptions(schema);
-        const projectRoot = context.workspace.projects[context.projectName].root;
-        const remixBin = require.resolve('@remix-run/dev/dist/cli');
-        const args = buildRemixDevArgs(options);
-        // Cast to any to overwrite NODE_ENV
-        process.env.NODE_ENV = process.env.NODE_ENV
-            ? process.env.NODE_ENV
-            : 'development';
-        process.env.PORT = `${options.port}`;
-        yield tslib_1.__await(yield* tslib_1.__asyncDelegator(tslib_1.__asyncValues((0, async_iterable_1.createAsyncIterable)(({ done, next, error }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const server = (0, node_child_process_1.fork)(remixBin, ['dev', ...args], {
-                cwd: (0, node_path_1.join)(devkit_1.workspaceRoot, projectRoot),
-                stdio: 'inherit',
-            });
-            server.once('exit', (code) => {
-                if (code === 0) {
-                    done();
-                }
-                else {
-                    error(new Error(`Remix app exited with code ${code}`));
-                }
-            });
-            const killServer = () => {
-                if (server.connected) {
-                    server.kill('SIGTERM');
-                }
-            };
-            process.on('exit', () => killServer());
-            process.on('SIGINT', () => killServer());
-            process.on('SIGTERM', () => killServer());
-            process.on('SIGHUP', () => killServer());
-            yield (0, wait_for_port_open_1.waitForPortOpen)(options.port);
-            next({
-                success: true,
-                baseUrl: `http://localhost:${options.port}`,
-            });
-        })))));
+async function* serveExecutor(schema, context) {
+    const options = normalizeOptions(schema);
+    const projectRoot = context.workspace.projects[context.projectName].root;
+    const remixBin = require.resolve('@remix-run/dev/dist/cli');
+    const args = buildRemixDevArgs(options);
+    // Cast to any to overwrite NODE_ENV
+    process.env.NODE_ENV = process.env.NODE_ENV
+        ? process.env.NODE_ENV
+        : 'development';
+    process.env.PORT = `${options.port}`;
+    yield* (0, async_iterable_1.createAsyncIterable)(async ({ done, next, error }) => {
+        const server = (0, node_child_process_1.fork)(remixBin, ['dev', ...args], {
+            cwd: (0, node_path_1.join)(devkit_1.workspaceRoot, projectRoot),
+            stdio: 'inherit',
+        });
+        server.once('exit', (code) => {
+            if (code === 0) {
+                done();
+            }
+            else {
+                error(new Error(`Remix app exited with code ${code}`));
+            }
+        });
+        const killServer = () => {
+            if (server.connected) {
+                server.kill('SIGTERM');
+            }
+        };
+        process.on('exit', () => killServer());
+        process.on('SIGINT', () => killServer());
+        process.on('SIGTERM', () => killServer());
+        process.on('SIGHUP', () => killServer());
+        await (0, wait_for_port_open_1.waitForPortOpen)(options.port);
+        next({
+            success: true,
+            baseUrl: `http://localhost:${options.port}`,
+        });
     });
 }
 exports.default = serveExecutor;
-//# sourceMappingURL=serve.impl.js.map

package/src/generators/action/action.impl.js

@@ -1,41 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
 const devkit_1 = require("@nx/devkit");
 const insert_import_1 = require("../../utils/insert-import");
 const insert_statement_after_imports_1 = require("../../utils/insert-statement-after-imports");
 const insert_statement_in_default_function_1 = require("../../utils/insert-statement-in-default-function");
 const remix_route_utils_1 = require("../../utils/remix-route-utils");
-function default_1(tree, schema) {
-    return tslib_1.__awaiter(this, void 0, void 0, function* () {
-        const routeFilePath = (0, remix_route_utils_1.resolveRemixRouteFile)(tree, schema.path, schema.project);
-        if (!tree.exists(routeFilePath)) {
-            throw new Error(`Route path does not exist: ${routeFilePath}. Please generate a Remix route first.`);
-        }
-        (0, insert_import_1.insertImport)(tree, routeFilePath, 'ActionArgs', '@remix-run/node', {
-            typeOnly: true,
-        });
-        (0, insert_import_1.insertImport)(tree, routeFilePath, 'json', '@remix-run/node');
-        (0, insert_import_1.insertImport)(tree, routeFilePath, 'useActionData', '@remix-run/react');
-        (0, insert_statement_after_imports_1.insertStatementAfterImports)(tree, routeFilePath, `
-    export const action = async ({ request }: ActionArgs) => {
+async function default_1(tree, schema) {
+    const routeFilePath = schema.nameAndDirectoryFormat === 'as-provided'
+        ? schema.path
+        : await (0, remix_route_utils_1.resolveRemixRouteFile)(tree, schema.path, schema.project);
+    if (!tree.exists(routeFilePath)) {
+        throw new Error(`Route path does not exist: ${routeFilePath}. Please generate a Remix route first.`);
+    }
+    (0, insert_import_1.insertImport)(tree, routeFilePath, 'ActionFunctionArgs', '@remix-run/node', {
+        typeOnly: true,
+    });
+    (0, insert_import_1.insertImport)(tree, routeFilePath, 'json', '@remix-run/node');
+    (0, insert_import_1.insertImport)(tree, routeFilePath, 'useActionData', '@remix-run/react');
+    (0, insert_statement_after_imports_1.insertStatementAfterImports)(tree, routeFilePath, `
+    export const action = async ({ request }: ActionFunctionArgs) => {
       let formData = await request.formData();
 
       return json({message: formData.toString()}, { status: 200 });
     };
 
     `);
-        const statement = `\nconst actionMessage = useActionData<typeof action>();`;
-        try {
-            (0, insert_statement_in_default_function_1.insertStatementInDefaultFunction)(tree, routeFilePath, statement);
-        }
-        catch (err) {
-            // eslint-disable-next-line no-empty
-        }
-        finally {
-            yield (0, devkit_1.formatFiles)(tree);
-        }
-    });
+    const statement = `\nconst actionMessage = useActionData<typeof action>();`;
+    try {
+        (0, insert_statement_in_default_function_1.insertStatementInDefaultFunction)(tree, routeFilePath, statement);
+    }
+    catch (err) {
+        // eslint-disable-next-line no-empty
+    }
+    finally {
+        await (0, devkit_1.formatFiles)(tree);
+    }
 }
 exports.default = default_1;
-//# sourceMappingURL=action.impl.js.map

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

@@ -1,4 +1,10 @@
+import { NameAndDirectoryFormat } from '@nx/devkit/src/generators/artifact-name-and-directory-utils';
+
 export interface LoaderSchema {
   path: string;
-  project: string;
+  nameAndDirectoryFormat?: NameAndDirectoryFormat;
+  /**
+   * @deprecated Provide the `path` option instead. The project will be determined from the path provided. It will be removed in Nx v18.
+   */
+  project?: string;
 }

package/src/generators/action/schema.json

@@ -2,6 +2,7 @@
   "$schema": "http://json-schema.org/schema",
   "$id": "action",
   "type": "object",
+  "description": "Generate an action for a given route.",
   "properties": {
     "path": {
       "type": "string",
@@ -10,7 +11,12 @@
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the path of the route? (e.g. 'foo/bar')"
+      "x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
+    },
+    "nameAndDirectoryFormat": {
+      "description": "Whether to generate the action in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
     },
     "project": {
       "type": "string",
@@ -19,8 +25,9 @@
         "$source": "projectName"
       },
       "x-prompt": "What project is this route for?",
-      "pattern": "^[a-zA-Z].*$"
+      "pattern": "^[a-zA-Z].*$",
+      "x-deprecated": "Provide the `path` option instead and use the `as-provided` format. The project will be determined from the path provided. It will be removed in Nx v18."
     }
   },
-  "required": ["path", "project"]
+  "required": ["path"]
 }