@nx/remix 0.0.0-pr-22179-271588f

package/src/executors/build/schema.json

@@ -0,0 +1,38 @@
+{
+  "version": 2,
+  "outputCapture": "pipe",
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "title": "Remix Build",
+  "description": "Build a Remix app.",
+  "type": "object",
+  "properties": {
+    "outputPath": {
+      "type": "string",
+      "description": "The output path of the generated files.",
+      "x-completion-type": "directory",
+      "x-priority": "important"
+    },
+    "includeDevDependenciesInPackageJson": {
+      "type": "boolean",
+      "description": "Include `devDependencies` in the generated package.json file. By default only production `dependencies` are included.",
+      "default": false
+    },
+    "generatePackageJson": {
+      "type": "boolean",
+      "description": "Generate package.json file in the output folder.",
+      "default": false
+    },
+    "generateLockfile": {
+      "type": "boolean",
+      "description": "Generate a lockfile (e.g. package-lock.json) that matches the workspace lockfile to ensure package versions match.",
+      "default": false
+    },
+    "sourcemap": {
+      "type": "boolean",
+      "description": "Generate source maps for production.",
+      "default": false
+    }
+  },
+  "required": ["outputPath"]
+}

package/src/executors/serve/schema.d.ts

@@ -0,0 +1,9 @@
+export interface RemixServeSchema {
+  port: number;
+  devServerPort?: number;
+  debug?: boolean;
+  command?: string;
+  manual?: boolean;
+  tlsKey?: string;
+  tlsCert?: string;
+}

package/src/executors/serve/schema.json

@@ -0,0 +1,41 @@
+{
+  "version": 2,
+  "outputCapture": "pipe",
+  "cli": "nx",
+  "title": "Remix Serve",
+  "description": "Serve a Remix app.",
+  "type": "object",
+  "properties": {
+    "port": {
+      "type": "number",
+      "description": "Set PORT environment variable that can be used to serve the Remix application.",
+      "default": 4200
+    },
+    "devServerPort": {
+      "type": "number",
+      "description": "Port to start the dev server on."
+    },
+    "debug": {
+      "type": "boolean",
+      "description": "Attach a Node.js inspector.",
+      "default": false
+    },
+    "command": {
+      "type": "string",
+      "description": "Command used to run your app server."
+    },
+    "manual": {
+      "type": "boolean",
+      "description": "Enable manual mode",
+      "default": false
+    },
+    "tlsKey": {
+      "type": "string",
+      "description": "Path to TLS key (key.pem)."
+    },
+    "tlsCert": {
+      "type": "string",
+      "description": "Path to TLS certificate (cert.pem)."
+    }
+  }
+}

package/src/executors/serve/serve.impl.d.ts

@@ -0,0 +1,6 @@
+import { type ExecutorContext } from '@nx/devkit';
+import { type RemixServeSchema } from './schema';
+export default function serveExecutor(schema: RemixServeSchema, context: ExecutorContext): AsyncGenerator<{
+    success: boolean;
+    baseUrl: string;
+}, void, undefined>;

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

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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) {
+    return {
+        ...schema,
+        port: schema.port ?? 4200,
+        debug: schema.debug ?? false,
+        manual: schema.manual ?? false,
+    };
+}
+function buildRemixDevArgs(options) {
+    const args = [];
+    if (options.command) {
+        args.push(`--command=${options.command}`);
+    }
+    if (options.devServerPort) {
+        args.push(`--port=${options.devServerPort}`);
+    }
+    if (options.debug) {
+        args.push(`--debug`);
+    }
+    if (options.manual) {
+        args.push(`--manual`);
+    }
+    if (options.tlsKey) {
+        args.push(`--tls-key=${options.tlsKey}`);
+    }
+    if (options.tlsCert) {
+        args.push(`--tls-cert=${options.tlsCert}`);
+    }
+    return args;
+}
+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;

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

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { LoaderSchema } from './schema';
+export default function (tree: Tree, schema: LoaderSchema): Promise<void>;

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

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+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 {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.default = default_1;

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

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

package/src/generators/action/schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "action",
+  "type": "object",
+  "description": "Generate an action for a given route.",
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "The route path or path to the filename of the route.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "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",
+      "description": "The name of the project.",
+      "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 v19."
+    }
+  },
+  "required": ["path"]
+}