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

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

@@ -0,0 +1,5 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+import { NxRemixGeneratorSchema } from './schema';
+export declare function remixApplicationGenerator(tree: Tree, options: NxRemixGeneratorSchema): Promise<GeneratorCallback>;
+export declare function remixApplicationGeneratorInternal(tree: Tree, _options: NxRemixGeneratorSchema): Promise<GeneratorCallback>;
+export default remixApplicationGenerator;

package/src/generators/application/application.impl.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.remixApplicationGeneratorInternal = exports.remixApplicationGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const create_ts_config_1 = require("@nx/js/src/utils/typescript/create-ts-config");
+const versions_1 = require("../../utils/versions");
+const lib_1 = require("./lib");
+const update_dependencies_1 = require("../utils/update-dependencies");
+const init_1 = require("../init/init");
+const js_1 = require("@nx/js");
+const add_build_target_defaults_1 = require("@nx/devkit/src/generators/add-build-target-defaults");
+const log_show_project_command_1 = require("@nx/devkit/src/utils/log-show-project-command");
+function remixApplicationGenerator(tree, options) {
+    return remixApplicationGeneratorInternal(tree, {
+        addPlugin: false,
+        ...options,
+    });
+}
+exports.remixApplicationGenerator = remixApplicationGenerator;
+async function remixApplicationGeneratorInternal(tree, _options) {
+    const options = await (0, lib_1.normalizeOptions)(tree, _options);
+    const tasks = [
+        await (0, init_1.default)(tree, {
+            skipFormat: true,
+            addPlugin: options.addPlugin,
+        }),
+        await (0, js_1.initGenerator)(tree, { skipFormat: true }),
+    ];
+    (0, add_build_target_defaults_1.addBuildTargetDefaults)(tree, '@nx/remix:build');
+    (0, devkit_1.addProjectConfiguration)(tree, options.projectName, {
+        root: options.projectRoot,
+        sourceRoot: `${options.projectRoot}`,
+        projectType: 'application',
+        tags: options.parsedTags,
+        targets: !options.addPlugin
+            ? {
+                build: {
+                    executor: '@nx/remix:build',
+                    outputs: ['{options.outputPath}'],
+                    options: {
+                        outputPath: (0, devkit_1.joinPathFragments)('dist', options.projectRoot),
+                    },
+                },
+                serve: {
+                    executor: `@nx/remix:serve`,
+                    options: {
+                        command: `${(0, devkit_1.getPackageManagerCommand)().exec} remix-serve build/index.js`,
+                        manual: true,
+                        port: 4200,
+                    },
+                },
+                start: {
+                    dependsOn: ['build'],
+                    command: `remix-serve build/index.js`,
+                    options: {
+                        cwd: options.projectRoot,
+                    },
+                },
+                typecheck: {
+                    command: `tsc --project tsconfig.app.json`,
+                    options: {
+                        cwd: options.projectRoot,
+                    },
+                },
+            }
+            : {},
+    });
+    const installTask = (0, update_dependencies_1.updateDependencies)(tree);
+    tasks.push(installTask);
+    const vars = {
+        ...options,
+        tmpl: '',
+        offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.projectRoot),
+        remixVersion: versions_1.remixVersion,
+        isbotVersion: versions_1.isbotVersion,
+        reactVersion: versions_1.reactVersion,
+        reactDomVersion: versions_1.reactDomVersion,
+        typesReactVersion: versions_1.typesReactVersion,
+        typesReactDomVersion: versions_1.typesReactDomVersion,
+        eslintVersion: versions_1.eslintVersion,
+        typescriptVersion: versions_1.typescriptVersion,
+    };
+    (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files/common'), options.projectRoot, vars);
+    if (options.rootProject) {
+        const gitignore = tree.read('.gitignore', 'utf-8');
+        tree.write('.gitignore', `${gitignore}\n.cache\nbuild\npublic/build\n.env\n`);
+    }
+    else {
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files/integrated'), options.projectRoot, vars);
+    }
+    if (options.unitTestRunner !== 'none') {
+        if (options.unitTestRunner === 'vitest') {
+            const { vitestGenerator, createOrEditViteConfig } = (0, devkit_1.ensurePackage)('@nx/vite', (0, versions_1.getPackageVersion)(tree, 'nx'));
+            const vitestTask = await vitestGenerator(tree, {
+                uiFramework: 'react',
+                project: options.projectName,
+                coverageProvider: 'v8',
+                inSourceTests: false,
+                skipFormat: true,
+                testEnvironment: 'jsdom',
+                skipViteConfig: true,
+                addPlugin: options.addPlugin,
+            });
+            createOrEditViteConfig(tree, {
+                project: options.projectName,
+                includeLib: false,
+                includeVitest: true,
+                testEnvironment: 'jsdom',
+                imports: [`import react from '@vitejs/plugin-react';`],
+                plugins: [`react()`],
+            }, true, undefined, true);
+            tasks.push(vitestTask);
+        }
+        else {
+            const { configurationGenerator: jestConfigurationGenerator } = (0, devkit_1.ensurePackage)('@nx/jest', (0, versions_1.getPackageVersion)(tree, 'nx'));
+            const jestTask = await jestConfigurationGenerator(tree, {
+                project: options.projectName,
+                setupFile: 'none',
+                supportTsx: true,
+                skipSerializers: false,
+                skipPackageJson: false,
+                skipFormat: true,
+                addPlugin: options.addPlugin,
+            });
+            const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.projectName);
+            if (projectConfig.targets['test']?.options) {
+                projectConfig.targets['test'].options.passWithNoTests = true;
+                (0, devkit_1.updateProjectConfiguration)(tree, options.projectName, projectConfig);
+            }
+            tasks.push(jestTask);
+        }
+        const pkgInstallTask = (0, lib_1.updateUnitTestConfig)(tree, options.projectRoot, options.unitTestRunner, options.rootProject);
+        tasks.push(pkgInstallTask);
+    }
+    else {
+        tree.delete((0, devkit_1.joinPathFragments)(options.projectRoot, `tests/routes/_index.spec.tsx`));
+    }
+    if (options.linter !== 'none') {
+        const { lintProjectGenerator } = (0, devkit_1.ensurePackage)('@nx/eslint', (0, versions_1.getPackageVersion)(tree, 'nx'));
+        const eslintTask = await lintProjectGenerator(tree, {
+            linter: options.linter,
+            project: options.projectName,
+            tsConfigPaths: [
+                (0, devkit_1.joinPathFragments)(options.projectRoot, 'tsconfig.app.json'),
+            ],
+            unitTestRunner: options.unitTestRunner,
+            skipFormat: true,
+            rootProject: options.rootProject,
+            addPlugin: options.addPlugin,
+        });
+        tasks.push(eslintTask);
+        tree.write((0, devkit_1.joinPathFragments)(options.projectRoot, '.eslintignore'), (0, devkit_1.stripIndents) `build
+    public/build`);
+    }
+    if (options.js) {
+        (0, devkit_1.toJS)(tree);
+    }
+    if (options.rootProject && tree.exists('tsconfig.base.json')) {
+        // If this is a standalone project, merge tsconfig.json and tsconfig.base.json.
+        const tsConfigBaseJson = (0, devkit_1.readJson)(tree, 'tsconfig.base.json');
+        (0, devkit_1.updateJson)(tree, 'tsconfig.json', (json) => {
+            delete json.extends;
+            json.compilerOptions = {
+                ...tsConfigBaseJson.compilerOptions,
+                ...json.compilerOptions,
+                // Taken from remix default setup
+                // https://github.com/remix-run/remix/blob/68c8982/templates/remix/tsconfig.json#L15-L17
+                paths: {
+                    '~/*': ['./app/*'],
+                },
+            };
+            json.include = [
+                ...(tsConfigBaseJson.include ?? []),
+                ...(json.include ?? []),
+            ];
+            json.exclude = [
+                ...(tsConfigBaseJson.exclude ?? []),
+                ...(json.exclude ?? []),
+            ];
+            return json;
+        });
+        tree.delete('tsconfig.base.json');
+    }
+    else {
+        // Otherwise, extract the tsconfig.base.json from tsconfig.json so we can share settings.
+        (0, create_ts_config_1.extractTsConfigBase)(tree);
+    }
+    tasks.push(await (0, lib_1.addE2E)(tree, options));
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+    tasks.push(() => {
+        (0, log_show_project_command_1.logShowProjectCommand)(options.projectName);
+    });
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.remixApplicationGeneratorInternal = remixApplicationGeneratorInternal;
+exports.default = remixApplicationGenerator;

package/src/generators/application/files/common/README.md__tmpl__

@@ -0,0 +1,54 @@
+# Welcome to Nx + Remix!
+
+- [Remix Docs](https://remix.run/docs)
+- [Nx Docs](https://nx.dev)
+
+## Development
+
+From your terminal:
+
+```sh
+npx nx dev <%= projectName %>
+```
+
+This starts your app in development mode, rebuilding assets on file changes.
+
+## Deployment
+
+First, build your app for production:
+
+```sh
+npx nx build <%= projectName %>
+```
+
+Then run the app in production mode:
+
+```sh
+npx nx start <%= projectName %>
+```
+
+Now you'll need to pick a host to deploy it to.
+
+### DIY
+
+If you're familiar with deploying node applications, the built-in Remix app server is production-ready.
+
+Make sure to deploy the output of `remix build`
+
+- `packages/<%= projectName %>/build/`
+- `packages/<%= projectName %>/public/build/`
+
+### Using a Template
+
+When you ran `npx create-remix@latest` there were a few choices for hosting. You can run that again to create a new project, then copy over your `app/` folder to the new project that's pre-configured for your target server.
+
+```sh
+cd ..
+# create a new project, and pick a pre-configured host
+npx create-remix@latest
+cd my-new-remix-app
+# remove the new project's app (not the old one!)
+rm -rf app
+# copy your app over
+cp -R ../my-old-remix-app/app app
+```