@nx/remix 23.3.0 → 24.0.0-beta.1

package/dist/src/generators/utils/update-dependencies.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateDependencies = updateDependencies;
-const devkit_1 = require("@nx/devkit");
-const internal_1 = require("@nx/devkit/internal");
-const versions_1 = require("../../utils/versions");
-function updateDependencies(tree) {
-    // Vite depends on esbuild, whose install script only validates the prebuilt
-    // binary that ships as an optional dependency.
-    (0, internal_1.acknowledgeBuildScripts)(tree, (0, devkit_1.detectPackageManager)(tree.root), {
-        esbuild: false,
-    });
-    return (0, devkit_1.addDependenciesToPackageJson)(tree, {
-        '@remix-run/node': versions_1.remixVersion,
-        '@remix-run/react': versions_1.remixVersion,
-        isbot: versions_1.isbotVersion,
-        react: versions_1.reactVersion,
-        'react-dom': versions_1.reactDomVersion,
-    }, {
-        '@types/react': versions_1.typesReactVersion,
-        '@types/react-dom': versions_1.typesReactDomVersion,
-        eslint: versions_1.eslintVersion,
-        typescript: versions_1.typescriptVersion,
-        vite: versions_1.viteVersion,
-        '@nx/vite': versions_1.nxVersion,
-        '@nx/vitest': versions_1.nxVersion,
-    }, undefined, 
-    // Don't overwrite a user's installed versions (e.g. React 19 from @nx/react).
-    // Remix v2's fresh-install defaults are React 18 / Vite 6, but an existing
-    // pin is respected.
-    true);
-}

package/dist/src/utils/assert-and-pin-remix-typescript.d.ts

@@ -1,21 +0,0 @@
-import { type GeneratorCallback, type Tree } from '@nx/devkit';
-/**
- * Remix has no TypeScript 6-capable release, so Remix generators must keep the
- * workspace on TS 5.x. It keys off the DECLARED `typescript` version, consulting
- * the installed version only when it satisfies that declared range, and:
- * - throws a hard, actionable error when the workspace resolves to TS >= 6 (the
- *   declared floor is >= 6, or an open range like `>=5.9.0` is satisfied by an
- *   installed >= 6);
- * - pins TS to Remix's own `~5.9.2` only when `typescript` is absent, never
- *   overwriting an existing (5.x) pin. A typescript present only transitively
- *   (hoisted, no direct declaration) is treated as absent and gets the pin.
- *
- * Dist-tags (`latest`/`next`) and unparseable ranges have no resolvable floor,
- * so the throw is skipped for them, consistent with devkit's
- * `assertSupportedPackageVersion`.
- *
- * Call before any dependency install in Remix generators that install deps;
- * generators that delegate to the init generator (e.g. application) inherit
- * the guard from it.
- */
-export declare function assertAndPinRemixTypescript(tree: Tree): GeneratorCallback;

package/dist/src/utils/assert-and-pin-remix-typescript.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertAndPinRemixTypescript = assertAndPinRemixTypescript;
-const devkit_1 = require("@nx/devkit");
-const internal_1 = require("@nx/js/internal");
-const versions_1 = require("./versions");
-/**
- * Remix has no TypeScript 6-capable release, so Remix generators must keep the
- * workspace on TS 5.x. It keys off the DECLARED `typescript` version, consulting
- * the installed version only when it satisfies that declared range, and:
- * - throws a hard, actionable error when the workspace resolves to TS >= 6 (the
- *   declared floor is >= 6, or an open range like `>=5.9.0` is satisfied by an
- *   installed >= 6);
- * - pins TS to Remix's own `~5.9.2` only when `typescript` is absent, never
- *   overwriting an existing (5.x) pin. A typescript present only transitively
- *   (hoisted, no direct declaration) is treated as absent and gets the pin.
- *
- * Dist-tags (`latest`/`next`) and unparseable ranges have no resolvable floor,
- * so the throw is skipped for them, consistent with devkit's
- * `assertSupportedPackageVersion`.
- *
- * Call before any dependency install in Remix generators that install deps;
- * generators that delegate to the init generator (e.g. application) inherit
- * the guard from it.
- */
-function assertAndPinRemixTypescript(tree) {
-    const declared = (0, devkit_1.getDependencyVersionFromPackageJson)(tree, 'typescript');
-    const minimum = declared ? (0, internal_1.getRangeMinimum)(declared) : undefined;
-    if (minimum && (0, internal_1.isTypescriptVersionAtLeast)(tree, '6.0.0')) {
-        throw new Error(`Remix does not support TypeScript 6 (detected \`typescript@${declared}\`).\n\n` +
-            `Keep \`typescript\` on a 5.x version to continue using Remix, or migrate to ` +
-            `React Router v7 by generating an application with the @nx/react generator: ` +
-            `\`nx g @nx/react:application <name> --routing --useReactRouter\`.`);
-    }
-    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { typescript: versions_1.typescriptVersion }, undefined, true);
-}

package/dist/src/utils/get-default-export-name.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function getDefaultExportName(tree: Tree, path: string): string;

package/dist/src/utils/get-default-export-name.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultExportName = getDefaultExportName;
-const get_default_export_1 = require("./get-default-export");
-function getDefaultExportName(tree, path) {
-    return (0, get_default_export_1.getDefaultExport)(tree, path)?.name.text ?? 'Unknown';
-}

package/dist/src/utils/get-default-export.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function getDefaultExport(tree: Tree, path: string): import("typescript").FunctionDeclaration;

package/dist/src/utils/get-default-export.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultExport = getDefaultExport;
-const typescript_1 = require("typescript");
-function getDefaultExport(tree, path) {
-    const contents = tree.read(path, 'utf-8');
-    const sourceFile = (0, typescript_1.createSourceFile)(path, contents, typescript_1.ScriptTarget.ESNext);
-    const functionDeclarations = sourceFile.statements.filter(typescript_1.isFunctionDeclaration);
-    return functionDeclarations.find((functionDeclaration) => {
-        const isDefault = functionDeclaration.modifiers.find((mod) => mod.kind === typescript_1.SyntaxKind.DefaultKeyword);
-        const isExport = functionDeclaration.modifiers.find((mod) => mod.kind === typescript_1.SyntaxKind.ExportKeyword);
-        return isDefault && isExport;
-    });
-}

package/dist/src/utils/insert-import.d.ts

@@ -1,4 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function insertImport(tree: Tree, path: string, name: string, modulePath: string, options?: {
-    typeOnly: boolean;
-}): void;

package/dist/src/utils/insert-import.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.insertImport = insertImport;
-const devkit_1 = require("@nx/devkit");
-const typescript_1 = require("typescript");
-const insert_statement_after_imports_1 = require("./insert-statement-after-imports");
-function insertImport(tree, path, name, modulePath, options = { typeOnly: false }) {
-    if (!tree.exists(path))
-        throw Error(`Could not insert import ${name} from ${modulePath} in ${path}: path not found`);
-    const contents = tree.read(path, 'utf-8');
-    const sourceFile = (0, typescript_1.createSourceFile)(path, contents, typescript_1.ScriptTarget.ESNext);
-    let importStatements = sourceFile.statements.filter(typescript_1.isImportDeclaration);
-    if (options.typeOnly) {
-        importStatements = importStatements.filter((node) => node.importClause.isTypeOnly);
-    }
-    else {
-        importStatements = importStatements.filter((node) => !node.importClause.isTypeOnly);
-    }
-    const existingImport = importStatements.find((statement) => (0, typescript_1.isStringLiteral)(statement.moduleSpecifier) &&
-        statement.moduleSpecifier
-            .getText(sourceFile)
-            .replace(/['"`]/g, '')
-            .trim() === modulePath &&
-        statement.importClause.namedBindings &&
-        (0, typescript_1.isNamedImports)(statement.importClause.namedBindings));
-    if (!existingImport) {
-        (0, insert_statement_after_imports_1.insertStatementAfterImports)(tree, path, options.typeOnly
-            ? `import type { ${name} } from '${modulePath}';`
-            : `import { ${name} } from '${modulePath}';`);
-        return;
-    }
-    const namedImports = existingImport.importClause
-        .namedBindings;
-    const alreadyImported = namedImports.elements.find((element) => element.name.escapedText === name) !== undefined;
-    if (!alreadyImported) {
-        const index = namedImports.getEnd() - 1;
-        let text;
-        if (namedImports.elements.hasTrailingComma) {
-            text = `${name},`;
-        }
-        else {
-            text = `,${name}`;
-        }
-        const newContents = (0, devkit_1.applyChangesToString)(contents, [
-            {
-                type: devkit_1.ChangeType.Insert,
-                index,
-                text,
-            },
-        ]);
-        tree.write(path, newContents);
-    }
-}

package/dist/src/utils/insert-statement-after-imports.d.ts

@@ -1,5 +0,0 @@
-import { Tree } from '@nx/devkit';
-/**
- * Insert a statement after the last import statement in a file
- */
-export declare function insertStatementAfterImports(tree: Tree, path: string, statement: string): void;

package/dist/src/utils/insert-statement-after-imports.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.insertStatementAfterImports = insertStatementAfterImports;
-const devkit_1 = require("@nx/devkit");
-const typescript_1 = require("typescript");
-/**
- * Insert a statement after the last import statement in a file
- */
-function insertStatementAfterImports(tree, path, statement) {
-    const contents = tree.read(path, 'utf-8');
-    const sourceFile = (0, typescript_1.createSourceFile)(path, contents, typescript_1.ScriptTarget.ESNext);
-    const importStatements = sourceFile.statements.filter(typescript_1.isImportDeclaration);
-    const index = importStatements.length > 0
-        ? importStatements[importStatements.length - 1].getEnd()
-        : 0;
-    if (importStatements.length > 0) {
-        statement = `\n${statement}`;
-    }
-    const newContents = (0, devkit_1.applyChangesToString)(contents, [
-        {
-            type: devkit_1.ChangeType.Insert,
-            index,
-            text: statement,
-        },
-    ]);
-    tree.write(path, newContents);
-}

package/dist/src/utils/insert-statement-in-default-function.d.ts

@@ -1,2 +0,0 @@
-import { Tree } from '@nx/devkit';
-export declare function insertStatementInDefaultFunction(tree: Tree, path: string, statement: any): void;

package/dist/src/utils/insert-statement-in-default-function.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.insertStatementInDefaultFunction = insertStatementInDefaultFunction;
-const devkit_1 = require("@nx/devkit");
-const get_default_export_1 = require("./get-default-export");
-function insertStatementInDefaultFunction(tree, path, statement) {
-    const defaultExport = (0, get_default_export_1.getDefaultExport)(tree, path);
-    if (!defaultExport) {
-        throw Error('No default export found!');
-    }
-    const index = defaultExport.body.statements.length > 0
-        ? defaultExport.body.statements[0].pos
-        : 0;
-    const newContents = (0, devkit_1.applyChangesToString)(tree.read(path, 'utf-8'), [
-        {
-            type: devkit_1.ChangeType.Insert,
-            index,
-            text: statement,
-        },
-    ]);
-    tree.write(path, newContents);
-}

package/dist/src/utils/remix-config.d.ts

@@ -1,6 +0,0 @@
-import { Tree } from '@nx/devkit';
-import type { AppConfig } from '@remix-run/dev';
-export declare function getRemixConfigPathDetails(tree: Tree, projectName: string): string[];
-export declare function getRemixConfigPath(tree: Tree, projectName: string): string;
-export declare function getRemixConfigPathFromProjectRoot(tree: Tree, projectRoot: string): string;
-export declare function getRemixConfigValues(tree: Tree, projectName: string): Promise<AppConfig>;

package/dist/src/utils/remix-config.js

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRemixConfigPathDetails = getRemixConfigPathDetails;
-exports.getRemixConfigPath = getRemixConfigPath;
-exports.getRemixConfigPathFromProjectRoot = getRemixConfigPathFromProjectRoot;
-exports.getRemixConfigValues = getRemixConfigValues;
-const devkit_1 = require("@nx/devkit");
-const executor_utils_1 = require("./executor-utils");
-function getRemixConfigPathDetails(tree, projectName) {
-    const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-    if (!project)
-        throw new Error(`Project does not exist: ${projectName}`);
-    for (const ext of ['.mjs', '.cjs', '.js', '.mts', '.cts', '.ts']) {
-        const configPath = (0, devkit_1.joinPathFragments)(project.root, `vite.config${ext}`);
-        if (tree.exists(configPath)) {
-            return [configPath, 'vite'];
-        }
-    }
-    for (const ext of ['.mjs', '.cjs', '.js']) {
-        const configPath = (0, devkit_1.joinPathFragments)(project.root, `remix.config${ext}`);
-        if (tree.exists(configPath)) {
-            return [configPath, 'classic'];
-        }
-    }
-}
-function getRemixConfigPath(tree, projectName) {
-    const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-    if (!project)
-        throw new Error(`Project does not exist: ${projectName}`);
-    for (const ext of ['.mjs', '.cjs', '.js']) {
-        const configPath = (0, devkit_1.joinPathFragments)(project.root, `remix.config${ext}`);
-        if (tree.exists(configPath)) {
-            return configPath;
-        }
-    }
-}
-function getRemixConfigPathFromProjectRoot(tree, projectRoot) {
-    let pathToRemixConfig;
-    for (const ext of ['.js', '.mjs', '.cjs']) {
-        pathToRemixConfig = (0, devkit_1.joinPathFragments)(projectRoot, `remix.config${ext}`);
-        if (tree.exists(pathToRemixConfig)) {
-            return pathToRemixConfig;
-        }
-    }
-    throw new Error(`Could not find a Remix Config File. Please ensure a "remix.config.js" file exists at the root of your project.`);
-}
-const _remixConfigCache = {};
-async function getRemixConfigValues(tree, projectName) {
-    const [configPath, configType] = getRemixConfigPathDetails(tree, projectName);
-    const remixConfigPath = (0, devkit_1.joinPathFragments)(devkit_1.workspaceRoot, configPath);
-    const cacheKey = `${projectName}/${remixConfigPath}`;
-    let appConfig = _remixConfigCache[cacheKey];
-    let resolvedConfig;
-    if (!appConfig) {
-        if (configType === 'vite') {
-            const { resolveConfig } = await (0, executor_utils_1.loadViteDynamicImport)();
-            const viteBuildConfig = (await resolveConfig({
-                configFile: configPath,
-                mode: 'development',
-            }, 'build'));
-            appConfig = viteBuildConfig.__remixPluginContext?.remixConfig;
-        }
-        else {
-            try {
-                const importedConfig = await Function(`return import("${remixConfigPath}?t=${Date.now()}")`)();
-                appConfig = (importedConfig?.default || importedConfig);
-            }
-            catch {
-                appConfig = require(remixConfigPath);
-            }
-        }
-        _remixConfigCache[cacheKey] = appConfig;
-    }
-    return appConfig;
-}

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

@@ -1,4 +0,0 @@
-import { Tree } from '@nx/devkit';
-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/dist/src/utils/remix-route-utils.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeRoutePath = normalizeRoutePath;
-exports.checkRoutePathForErrors = checkRoutePathForErrors;
-exports.resolveRemixAppDirectory = resolveRemixAppDirectory;
-const devkit_1 = require("@nx/devkit");
-const path_1 = require("path");
-const remix_config_1 = require("./remix-config");
-function normalizeRoutePath(path) {
-    return path.indexOf('/routes/') > -1
-        ? path.substring(path.indexOf('/routes/') + 8)
-        : path;
-}
-function checkRoutePathForErrors(path) {
-    return (path.match(/\w\.\.\w/) || // route.$withParams.tsx => route..tsx
-        path.match(/\w\/\/\w/) || // route/$withParams/index.tsx => route//index.tsx
-        path.match(/\w\/\.\w/) // route/$withParams.tsx => route/.tsx
-    );
-}
-async function resolveRemixAppDirectory(tree, projectName) {
-    const project = (0, devkit_1.readProjectConfiguration)(tree, projectName);
-    const remixConfig = await (0, remix_config_1.getRemixConfigValues)(tree, projectName);
-    return (0, devkit_1.joinPathFragments)(project.root, remixConfig.appDirectory
-        ? (0, path_1.relative)(project.root, remixConfig.appDirectory)
-        : 'app');
-}

package/dist/src/utils/testing-config-utils.d.ts

@@ -1,5 +0,0 @@
-import { type Tree } from '@nx/devkit';
-export declare function updateVitestTestSetup(tree: Tree, pathToVitestConfig: string, pathToTestSetup: string): void;
-export declare function updateJestTestSetup(tree: Tree, pathToJestConfig: string, pathToTestSetup: string): void;
-export declare function updateJestTestMatch(tree: Tree, pathToJestConfig: string, includesString: string): void;
-export declare function updateVitestTestIncludes(tree: Tree, pathToVitestConfig: string, includesString: string): void;

package/dist/src/utils/testing-config-utils.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateVitestTestSetup = updateVitestTestSetup;
-exports.updateJestTestSetup = updateJestTestSetup;
-exports.updateJestTestMatch = updateJestTestMatch;
-exports.updateVitestTestIncludes = updateVitestTestIncludes;
-const devkit_1 = require("@nx/devkit");
-const internal_1 = require("@nx/js/internal");
-let tsModule;
-function updateVitestTestSetup(tree, pathToVitestConfig, pathToTestSetup) {
-    if (!tsModule) {
-        tsModule = (0, internal_1.ensureTypescript)();
-    }
-    const { ast, query } = require('@phenomnomnominal/tsquery');
-    const fileContents = tree.read(pathToVitestConfig, 'utf-8');
-    const sourceFile = ast(fileContents);
-    const TEST_SETUPFILES_SELECTOR = 'PropertyAssignment:has(Identifier[name=test]) PropertyAssignment:has(Identifier[name=setupFiles])';
-    const nodes = query(sourceFile, TEST_SETUPFILES_SELECTOR);
-    let updatedFileContents = fileContents;
-    if (nodes.length === 0) {
-        const TEST_CONFIG_SELECTOR = 'PropertyAssignment:has(Identifier[name=test]) > ObjectLiteralExpression';
-        const testConfigNodes = query(sourceFile, TEST_CONFIG_SELECTOR);
-        updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, testConfigNodes[0].getStart() + 1)}setupFiles: ['${pathToTestSetup}'],${fileContents.slice(testConfigNodes[0].getStart() + 1)}`;
-    }
-    else {
-        const arrayNodes = query(nodes[0], 'ArrayLiteralExpression');
-        if (arrayNodes.length !== 0) {
-            updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, arrayNodes[0].getStart() + 1)}'${pathToTestSetup}',${fileContents.slice(arrayNodes[0].getStart() + 1)}`;
-        }
-    }
-    tree.write(pathToVitestConfig, updatedFileContents);
-}
-function updateJestTestSetup(tree, pathToJestConfig, pathToTestSetup) {
-    if (!tsModule) {
-        tsModule = (0, internal_1.ensureTypescript)();
-    }
-    const { ast, query } = require('@phenomnomnominal/tsquery');
-    const fileContents = tree.read(pathToJestConfig, 'utf-8');
-    const sourceFile = ast(fileContents);
-    const TEST_SETUPFILES_SELECTOR = 'PropertyAssignment:has(Identifier[name=setupFilesAfterEnv])';
-    const nodes = query(sourceFile, TEST_SETUPFILES_SELECTOR);
-    if (nodes.length === 0) {
-        const CONFIG_SELECTOR = 'ObjectLiteralExpression';
-        const nodes = query(sourceFile, CONFIG_SELECTOR);
-        const updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, nodes[0].getStart() + 1)}setupFilesAfterEnv: ['${pathToTestSetup}'],${fileContents.slice(nodes[0].getStart() + 1)}`;
-        tree.write(pathToJestConfig, updatedFileContents);
-    }
-    else {
-        const arrayNodes = query(nodes[0], 'ArrayLiteralExpression');
-        if (arrayNodes.length !== 0) {
-            const updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, arrayNodes[0].getStart() + 1)}'${pathToTestSetup}',${fileContents.slice(arrayNodes[0].getStart() + 1)}`;
-            tree.write(pathToJestConfig, updatedFileContents);
-        }
-    }
-}
-function updateJestTestMatch(tree, pathToJestConfig, includesString) {
-    if (!tsModule) {
-        tsModule = (0, internal_1.ensureTypescript)();
-    }
-    const { ast, query } = require('@phenomnomnominal/tsquery');
-    const fileContents = tree.read(pathToJestConfig, 'utf-8');
-    const sourceFile = ast(fileContents);
-    const TEST_MATCH_SELECTOR = 'PropertyAssignment:has(Identifier[name=testMatch])';
-    const nodes = query(sourceFile, TEST_MATCH_SELECTOR);
-    if (nodes.length !== 0) {
-        const updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, nodes[0].getStart())}testMatch: ["${includesString}"]${fileContents.slice(nodes[0].getEnd())}`;
-        tree.write(pathToJestConfig, updatedFileContents);
-    }
-}
-function updateVitestTestIncludes(tree, pathToVitestConfig, includesString) {
-    if (!tsModule) {
-        tsModule = (0, internal_1.ensureTypescript)();
-    }
-    const { ast, query } = require('@phenomnomnominal/tsquery');
-    const fileContents = tree.read(pathToVitestConfig, 'utf-8');
-    const sourceFile = ast(fileContents);
-    const TEST_INCLUDE_SELECTOR = 'PropertyAssignment:has(Identifier[name=test]) PropertyAssignment:has(Identifier[name=include])';
-    const nodes = query(sourceFile, TEST_INCLUDE_SELECTOR);
-    if (nodes.length !== 0) {
-        const updatedFileContents = (0, devkit_1.stripIndents) `${fileContents.slice(0, nodes[0].getStart())}include: ["${includesString}"]${fileContents.slice(nodes[0].getEnd())}`;
-        tree.write(pathToVitestConfig, updatedFileContents);
-    }
-}

package/executors.json

@@ -1,14 +0,0 @@
-{
-  "executors": {
-    "serve": {
-      "implementation": "./dist/src/executors/serve/serve.impl",
-      "schema": "./dist/src/executors/serve/schema.json",
-      "description": "Serve a Remix application."
-    },
-    "build": {
-      "implementation": "./dist/src/executors/build/build.impl",
-      "schema": "./dist/src/executors/build/schema.json",
-      "description": "Build a Remix application."
-    }
-  }
-}