@nx/remix 20.2.1 → 20.3.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/remix",
-  "version": "20.2.1",
+  "version": "20.3.0-beta.0",
   "description": "The Remix plugin for Nx contains executors and generators for managing Remix applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Vitest, Jest, Playwright, Cypress, and Storybook.\n\n- Generators for applications, libraries, routes, loaders, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.",
   "repository": {
     "type": "git",
@@ -29,9 +29,9 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "20.2.1",
-    "@nx/js": "20.2.1",
-    "@nx/react": "20.2.1",
+    "@nx/devkit": "20.3.0-beta.0",
+    "@nx/js": "20.3.0-beta.0",
+    "@nx/react": "20.3.0-beta.0",
     "tslib": "^2.3.1",
     "@phenomnomnominal/tsquery": "~5.0.1"
   },

package/src/generators/resource-route/resource-route.impl.js

@@ -7,13 +7,14 @@ const remix_route_utils_1 = require("../../utils/remix-route-utils");
 const action_impl_1 = require("../action/action.impl");
 const loader_impl_1 = require("../loader/loader.impl");
 async function default_1(tree, options) {
-    const { artifactName: name, directory } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
+    const { filePath: routeFilePath } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
         path: options.path.replace(/^\//, '').replace(/\/$/, ''),
+        allowedFileExtensions: ['ts', 'tsx'],
+        fileExtension: 'tsx',
     });
     if (!options.skipChecks && (0, remix_route_utils_1.checkRoutePathForErrors)(options.path)) {
         throw new Error(`Your route path has an indicator of an un-escaped dollar sign for a route param. If this was intended, include the --skipChecks flag.`);
     }
-    const routeFilePath = await (0, remix_route_utils_1.resolveRemixRouteFile)(tree, (0, devkit_1.joinPathFragments)(directory, name), undefined);
     if (tree.exists(routeFilePath))
         throw new Error(`Path already exists: ${options.path}`);
     if (!options.loader && !options.action)

package/src/generators/resource-route/schema.json

@@ -6,19 +6,23 @@
   "description": "Generate a resource route.",
   "examples": [
     {
-      "command": "g resource-route 'path/to/page'",
-      "description": "Generate resource route at /path/to/page"
+      "description": "Generate a resource route at `myapp/app/routes/foo.ts`",
+      "command": "nx g resource-route myapp/app/routes/foo.ts"
+    },
+    {
+      "description": "Generate a resource route without providing the file extension at `myapp/app/routes/foo.tsx`",
+      "command": "nx g resource-route myapp/app/routes/foo"
     }
   ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "The route path or path to the filename of the route.",
+      "description": "The file path to the route. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar')"
+      "x-prompt": "What is the route file path?"
     },
     "action": {
       "type": "boolean",

package/src/generators/route/route.impl.js

@@ -10,20 +10,15 @@ const loader_impl_1 = require("../loader/loader.impl");
 const meta_impl_1 = require("../meta/meta.impl");
 const style_impl_1 = require("../style/style.impl");
 async function default_1(tree, options) {
-    const { artifactName: name, directory, project: projectName, } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
+    const { artifactName: name, filePath: routeFilePath } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
         path: options.path.replace(/^\//, '').replace(/\/$/, ''),
+        allowedFileExtensions: ['ts', 'tsx'],
+        fileExtension: 'tsx',
     });
-    const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-    if (!project)
-        throw new Error(`Project does not exist: ${projectName}`);
     if (!options.skipChecks && (0, remix_route_utils_1.checkRoutePathForErrors)(options.path)) {
         throw new Error(`Your route path has an indicator of an un-escaped dollar sign for a route param. If this was intended, include the --skipChecks flag.`);
     }
-    const routeFilePath = await (0, remix_route_utils_1.resolveRemixRouteFile)(tree, (0, devkit_1.joinPathFragments)(directory, name), undefined);
-    const nameToUseForComponent = name.replace('.tsx', '');
-    const { className: componentName } = (0, devkit_1.names)(nameToUseForComponent === '.' || nameToUseForComponent === ''
-        ? (0, path_1.basename)((0, path_1.dirname)(routeFilePath))
-        : nameToUseForComponent);
+    const { className: componentName } = (0, devkit_1.names)(name === '.' || name === '' ? (0, path_1.basename)((0, path_1.dirname)(routeFilePath)) : name);
     if (tree.exists(routeFilePath))
         throw new Error(`Path already exists: ${routeFilePath}`);
     tree.write(routeFilePath, (0, devkit_1.stripIndents) `

package/src/generators/route/schema.json

@@ -6,19 +6,23 @@
   "type": "object",
   "examples": [
     {
-      "command": "g route 'path/to/page'",
-      "description": "Generate route at /path/to/page"
+      "description": "Generate a route at `myapp/app/routes/foo.tsx`",
+      "command": "nx g resource-route myapp/app/routes/foo.tsx"
+    },
+    {
+      "description": "Generate a route without providing the file extension at `myapp/app/routes/foo.tsx`",
+      "command": "nx g resource-route myapp/app/routes/foo"
     }
   ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "The route path or path to the filename of the route.",
+      "description": "The file path to the route. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar')"
+      "x-prompt": "What is the route file path?"
     },
     "style": {
       "type": "string",

package/src/generators/style/schema.json

@@ -6,19 +6,19 @@
   "type": "object",
   "examples": [
     {
-      "command": "g style --path='apps/demo/app/routes/path/to/page.tsx'",
-      "description": "Generate route at apps/demo/app/routes/path/to/page.tsx"
+      "description": "Generate a stylesheet at `myapp/app/styles/foo.css`",
+      "command": "nx g style myapp/app/routes/foo.tsx"
     }
   ],
   "properties": {
     "path": {
       "type": "string",
-      "description": "Route path",
+      "description": "The file path to the route. Relative to the current working directory.",
       "$default": {
         "$source": "argv",
         "index": 0
       },
-      "x-prompt": "What is the path of the route? (e.g. 'apps/demo/app/routes/foo/bar.tsx')"
+      "x-prompt": "What is the route file path?"
     }
   },
   "required": ["path"]

package/src/generators/style/style.impl.js

@@ -8,16 +8,14 @@ const insert_import_1 = require("../../utils/insert-import");
 const insert_statement_after_imports_1 = require("../../utils/insert-statement-after-imports");
 const remix_route_utils_1 = require("../../utils/remix-route-utils");
 async function default_1(tree, options) {
-    const { project: projectName, artifactName: name } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
+    const { project: projectName, directory, fileName, } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(tree, {
         path: options.path,
     });
     const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
     if (!project)
         throw new Error(`Project does not exist: ${projectName}`);
     const appDir = await (0, remix_route_utils_1.resolveRemixAppDirectory)(tree, project.name);
-    const normalizedRoutePath = `${(0, remix_route_utils_1.normalizeRoutePath)(options.path)
-        .replace(/^\//, '')
-        .replace('.tsx', '')}.css`;
+    const normalizedRoutePath = `${(0, remix_route_utils_1.normalizeRoutePath)((0, devkit_1.joinPathFragments)(directory, fileName)).replace(/^\//, '')}.css`;
     const stylesheetPath = (0, devkit_1.joinPathFragments)(appDir, 'styles', normalizedRoutePath);
     tree.write(stylesheetPath, (0, devkit_1.stripIndents) `
       :root {

package/src/utils/remix-route-utils.d.ts

@@ -1,13 +1,4 @@
 import { Tree } from '@nx/devkit';
-/**
- *
- * @param tree
- * @param path to the route which could be fully specified or just "foo/bar"
- * @param projectName the name of the project where the route should be added
- * @param fileExtension the file extension to add to resolved route file
- * @returns file path to the route
- */
-export declare function resolveRemixRouteFile(tree: Tree, path: string, projectName?: string, fileExtension?: string): Promise<string>;
 export declare function normalizeRoutePath(path: string): string;
 export declare function checkRoutePathForErrors(path: string): RegExpMatchArray;
 export declare function resolveRemixAppDirectory(tree: Tree, projectName: string): Promise<string>;

package/src/utils/remix-route-utils.js

@@ -1,57 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveRemixRouteFile = resolveRemixRouteFile;
 exports.normalizeRoutePath = normalizeRoutePath;
 exports.checkRoutePathForErrors = checkRoutePathForErrors;
 exports.resolveRemixAppDirectory = resolveRemixAppDirectory;
 const devkit_1 = require("@nx/devkit");
-const remix_config_1 = require("./remix-config");
 const path_1 = require("path");
-/**
- *
- * @param tree
- * @param path to the route which could be fully specified or just "foo/bar"
- * @param projectName the name of the project where the route should be added
- * @param fileExtension the file extension to add to resolved route file
- * @returns file path to the route
- */
-async function resolveRemixRouteFile(tree, path, projectName, fileExtension) {
-    const { name: routePath } = (0, devkit_1.names)(path.replace(/^\//, '').replace(/\/$/, ''));
-    if (!projectName) {
-        return appendRouteFileExtension(tree, routePath, fileExtension);
-    }
-    else {
-        const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-        if (!project)
-            throw new Error(`Project does not exist: ${projectName}`);
-        const normalizedRoutePath = normalizeRoutePath(routePath);
-        const fileName = appendRouteFileExtension(tree, normalizedRoutePath, fileExtension);
-        return (0, devkit_1.joinPathFragments)(await resolveRemixAppDirectory(tree, projectName), 'routes', fileName);
-    }
-}
-function appendRouteFileExtension(tree, routePath, fileExtension) {
-    // if no file extension specified, let's try to find it
-    if (!fileExtension) {
-        // see if the path already has it
-        const extensionMatch = routePath.match(/(\.[^.]+)$/);
-        if (extensionMatch) {
-            fileExtension = extensionMatch[0];
-        }
-        else {
-            // look for either .ts or .tsx to exist in tree
-            if (tree.exists(`${routePath}.ts`)) {
-                fileExtension = '.ts';
-            }
-            else {
-                // default to .tsx if nothing else found
-                fileExtension = '.tsx';
-            }
-        }
-    }
-    return routePath.endsWith(fileExtension)
-        ? routePath
-        : `${routePath}${fileExtension}`;
-}
+const remix_config_1 = require("./remix-config");
 function normalizeRoutePath(path) {
     return path.indexOf('/routes/') > -1
         ? path.substring(path.indexOf('/routes/') + 8)