@remix-run/cli 0.3.3 → 0.4.0

package/dist/lib/doctor/controller-findings.js

@@ -1,52 +1,36 @@
-import { ROOT_ROUTE_NAME, } from "../controller-ownership.js";
-export function getControllerFindings(ownership, fixPlans) {
+import { ROOT_ROUTE_NAME, } from '../controller-ownership.js';
+export function getControllerFindings(ownership) {
+    let missingRouteNames = new Set(ownership.routeDirectories
+        .filter((directory) => !directory.exists)
+        .map((directory) => directory.routeName));
     return [
-        ...getSubtreeFindings(ownership.subtrees, fixPlans),
-        ...ownership.orphanControllerPaths.map((actualPath) => ({
-            actualPath,
-            code: 'orphan-controller',
-            message: `Action controller ${actualPath} does not match any route map.`,
-            severity: 'warn',
-            suite: 'actions',
-        })),
-        ...ownership.orphanRouteDirectoryPaths.map((actualPath) => ({
-            actualPath,
-            code: 'orphan-route-directory',
-            message: `Directory ${actualPath} does not match any route-map key path.`,
-            severity: 'warn',
-            suite: 'actions',
-        })),
+        ...getSubtreeFindings(ownership.subtrees, missingRouteNames),
+        ...getRouteDirectoryFindings(ownership.routeDirectories),
     ];
 }
-function getSubtreeFindings(subtrees, fixPlans) {
+function getRouteDirectoryFindings(directories) {
+    return directories
+        .filter((directory) => !directory.exists)
+        .map((directory) => ({
+        code: 'missing-route-directory',
+        expectedPath: directory.directoryPath,
+        message: `Route map "${directory.routeName}" is missing action directory ${directory.directoryPath}.`,
+        routeName: directory.routeName,
+        severity: 'warn',
+        suite: 'actions',
+    }));
+}
+function getSubtreeFindings(subtrees, missingRouteNames) {
     let findings = [];
-    let fixableFindingKeys = new Set(fixPlans.map((fixPlan) => `${fixPlan.code}:${fixPlan.routeName ?? ''}`));
     for (let subtree of subtrees) {
-        let routeMapName = formatRouteMapName(subtree.routeName);
-        if (subtree.actualEntryPaths.length > 1) {
-            findings.push({
-                actualPath: subtree.actualEntryPaths[0],
-                code: 'duplicate-owner-file',
-                expectedPath: subtree.entryDisplayPath,
-                message: `${routeMapName} has multiple action controller files: ${subtree.actualEntryPaths.join(', ')}. Keep only one controller owner file.`,
-                routeName: subtree.routeName,
-                severity: 'warn',
-                suite: 'actions',
-            });
+        if (missingRouteNames.has(subtree.routeName)) {
             continue;
         }
         if (subtree.actualEntryPath == null) {
-            let code = subtree.claimedFilePaths.length > 0
-                ? 'incomplete-controller'
-                : 'missing-owner';
             findings.push({
-                actualPath: subtree.claimedFilePaths.length > 0 ? subtree.subtreePath : undefined,
-                code,
+                code: 'missing-owner',
                 expectedPath: subtree.entryDisplayPath,
-                fixable: fixableFindingKeys.has(`${code}:${subtree.routeName}`),
-                message: subtree.claimedFilePaths.length > 0
-                    ? `${routeMapName} has files under ${subtree.subtreePath}, but is missing action controller ${subtree.entryDisplayPath}.`
-                    : `${routeMapName} is missing action controller ${subtree.entryDisplayPath}.`,
+                message: `${formatRouteMapName(subtree.routeName)} is missing action controller ${subtree.entryDisplayPath}.`,
                 routeName: subtree.routeName,
                 severity: 'warn',
                 suite: 'actions',

package/dist/lib/doctor/controllers.d.ts

@@ -1,7 +1,6 @@
 import { type OwnershipRouteNode } from '../controller-ownership.ts';
-import { type DoctorFixPlan, type DoctorSuiteResult } from './types.ts';
+import { type DoctorSuiteResult } from './types.ts';
 export interface ControllerDoctorResult {
-    fixPlans: DoctorFixPlan[];
     suite: DoctorSuiteResult;
 }
 export declare function checkControllerConventions(appRoot: string, tree: OwnershipRouteNode[]): Promise<ControllerDoctorResult>;

package/dist/lib/doctor/controllers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controllers.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/controllers.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAGhG,OAAO,EAAqB,KAAK,aAAa,EAAE,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE1F,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,aAAa,EAAE,CAAA;IACzB,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,sBAAsB,CAAC,CASjC"}
+{"version":3,"file":"controllers.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/controllers.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAEhG,OAAO,EAAqB,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEtE,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,kBAAkB,EAAE,GACzB,OAAO,CAAC,sBAAsB,CAAC,CAOjC"}

package/dist/lib/doctor/controllers.js

@@ -1,13 +1,10 @@
-import { inspectControllerOwnership } from "../controller-ownership.js";
-import { getControllerFindings } from "./controller-findings.js";
-import { getControllerFixPlans } from "./controller-fix-plans.js";
-import { createDoctorSuite } from "./types.js";
+import { inspectControllerOwnership } from '../controller-ownership.js';
+import { getControllerFindings } from './controller-findings.js';
+import { createDoctorSuite } from './types.js';
 export async function checkControllerConventions(appRoot, tree) {
     let ownership = await inspectControllerOwnership(appRoot, tree);
-    let fixPlans = await getControllerFixPlans(appRoot, tree, ownership);
-    let findings = getControllerFindings(ownership, fixPlans);
+    let findings = getControllerFindings(ownership);
     return {
-        fixPlans,
         suite: createDoctorSuite('actions', findings),
     };
 }

package/dist/lib/doctor/environment.js

@@ -3,8 +3,8 @@ import * as path from 'node:path';
 import * as process from 'node:process';
 import { createRequire } from 'node:module';
 import * as semver from 'semver';
-import { MINIMUM_SUPPORTED_NODE_VERSION } from "../bootstrap-project.js";
-import { createDoctorSuite, } from "./types.js";
+import { MINIMUM_SUPPORTED_NODE_VERSION } from '../bootstrap-project.js';
+import { createDoctorSuite, } from './types.js';
 export async function checkEnvironment(cwd = process.cwd()) {
     let projectRoot = await findNearestPackageRoot(cwd);
     if (projectRoot == null) {

package/dist/lib/doctor/fixes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fixes.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/fixes.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAEjE,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,EAAE,GACxB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAmC7B"}
+{"version":3,"file":"fixes.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/fixes.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAEjE,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,aAAa,EAAE,GACxB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAkC7B"}

package/dist/lib/doctor/fixes.js

@@ -1,10 +1,10 @@
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
-import { resolveContainedPath } from "../contained-path.js";
+import { resolveContainedPath } from '../contained-path.js';
 export async function applyDoctorFixPlans(appRoot, fixPlans) {
     let appliedFixes = [];
     for (let fixPlan of dedupeDoctorFixPlans(fixPlans)) {
-        let absolutePath = resolveDoctorFixPath(appRoot, fixPlan.path);
+        let absolutePath = await resolveDoctorFixPath(appRoot, fixPlan.path);
         if (fixPlan.kind === 'create-directory') {
             await fs.mkdir(absolutePath, { recursive: true });
             appliedFixes.push(toAppliedDoctorFix(fixPlan));
@@ -20,8 +20,7 @@ export async function applyDoctorFixPlans(appRoot, fixPlans) {
             await fs.writeFile(absolutePath, fixPlan.contents ?? '', { encoding: 'utf8', flag: 'wx' });
         }
         catch (error) {
-            let nodeError = error;
-            if (nodeError.code !== 'EEXIST') {
+            if (!isErrorWithCode(error, 'EEXIST')) {
                 throw error;
             }
             continue;
@@ -52,14 +51,54 @@ function toAppliedDoctorFix(fixPlan) {
         suite: fixPlan.suite,
     };
 }
-function resolveDoctorFixPath(appRoot, fixPath) {
+async function resolveDoctorFixPath(appRoot, fixPath) {
+    let absolutePath;
     try {
-        return resolveContainedPath(appRoot, fixPath);
+        absolutePath = resolveContainedPath(appRoot, fixPath);
     }
     catch (error) {
         if (error instanceof Error && error.message.includes('escapes the allowed root')) {
-            throw new Error(`Doctor fix path resolves outside the app root: ${fixPath}`);
+            throwDoctorFixPathOutsideRoot(fixPath);
         }
         throw error;
     }
+    let rootPath = path.resolve(appRoot);
+    let rootRealPath = await fs.realpath(rootPath);
+    let relativePath = path.relative(rootPath, absolutePath);
+    let pathParts = relativePath === '' ? [] : relativePath.split(path.sep);
+    let currentPath = rootPath;
+    let currentRealPath = rootRealPath;
+    for (let [index, pathPart] of pathParts.entries()) {
+        currentPath = path.join(currentPath, pathPart);
+        let stats = await lstatIfExists(currentPath);
+        if (stats == null) {
+            return path.join(currentRealPath, ...pathParts.slice(index));
+        }
+        currentRealPath = await fs.realpath(currentPath);
+        if (!isPathInsideRoot(rootRealPath, currentRealPath)) {
+            throwDoctorFixPathOutsideRoot(fixPath);
+        }
+    }
+    return currentRealPath;
+}
+async function lstatIfExists(filePath) {
+    try {
+        return await fs.lstat(filePath);
+    }
+    catch (error) {
+        if (isErrorWithCode(error, 'ENOENT')) {
+            return null;
+        }
+        throw error;
+    }
+}
+function isPathInsideRoot(rootPath, filePath) {
+    let relativePath = path.relative(rootPath, filePath);
+    return relativePath === '' || (!relativePath.startsWith('..') && !path.isAbsolute(relativePath));
+}
+function isErrorWithCode(error, code) {
+    return typeof error === 'object' && error !== null && 'code' in error && error.code === code;
+}
+function throwDoctorFixPathOutsideRoot(fixPath) {
+    throw new Error(`Doctor fix path resolves outside the app root: ${fixPath}`);
 }

package/dist/lib/doctor/project.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/project.ts"],"names":[],"mappings":"AAUA,OAAO,EAAgC,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACxF,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAmCpF;AAED,wBAAsB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAoDtF"}
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/project.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgC,KAAK,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACxF,OAAO,EAGL,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,mBAAmB,CAAA;IACnC,KAAK,EAAE,iBAAiB,CAAA;CACzB;AAED,wBAAsB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAmCpF;AAED,wBAAsB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CA6BtF"}

package/dist/lib/doctor/project.js

@@ -1,9 +1,8 @@
 import * as fs from 'node:fs/promises';
 import * as path from 'node:path';
-import { getOwnerFileExtension, isActionFileName, isControllerEntryFileName, } from "../controller-files.js";
-import { CliError } from "../errors.js";
-import { loadRouteManifestFromAppRoot } from "../route-map.js";
-import { createDoctorSuite, } from "./types.js";
+import { CliError } from '../errors.js';
+import { loadRouteManifestFromAppRoot } from '../route-map.js';
+import { createDoctorSuite, } from './types.js';
 export async function checkProject(projectRoot) {
     let routesFile = path.join(projectRoot, 'app', 'routes.ts');
     if (!(await pathExists(routesFile))) {
@@ -39,7 +38,6 @@ export async function checkProject(projectRoot) {
 }
 export async function getProjectFixPlans(projectRoot) {
     let routesFile = path.join(projectRoot, 'app', 'routes.ts');
-    let homeActionPath = normalizeRelativePath(path.join('app', 'actions', `controller${await inferHomeOwnerExtension(projectRoot)}`));
     if (await pathExists(routesFile)) {
         let routesSource = await fs.readFile(routesFile, 'utf8');
         if (!hasOnlyWhitespaceAndComments(routesSource)) {
@@ -53,18 +51,6 @@ export async function getProjectFixPlans(projectRoot) {
                 path: 'app/routes.ts',
                 suite: 'project',
             },
-            ...((await pathExists(path.join(projectRoot, homeActionPath)))
-                ? []
-                : [
-                    {
-                        code: 'missing-owner',
-                        contents: renderDefaultHomeAction(homeActionPath),
-                        kind: 'create-file',
-                        path: homeActionPath,
-                        routeName: 'home',
-                        suite: 'project',
-                    },
-                ]),
         ];
     }
     return [
@@ -75,14 +61,6 @@ export async function getProjectFixPlans(projectRoot) {
             path: 'app/routes.ts',
             suite: 'project',
         },
-        {
-            code: 'missing-owner',
-            contents: renderDefaultHomeAction(homeActionPath),
-            kind: 'create-file',
-            path: homeActionPath,
-            routeName: 'home',
-            suite: 'project',
-        },
     ];
 }
 function toProjectFinding(error) {
@@ -180,63 +158,6 @@ function hasOnlyWhitespaceAndComments(source) {
     }
     return true;
 }
-async function inferHomeOwnerExtension(projectRoot) {
-    let actionsDir = path.join(projectRoot, 'app', 'actions');
-    let extensions = await collectOwnerExtensions(actionsDir);
-    if (extensions.length > 0) {
-        return getMostCommonExtension(extensions);
-    }
-    if (await pathExists(path.join(projectRoot, 'tsconfig.json'))) {
-        return '.tsx';
-    }
-    return '.js';
-}
-async function collectOwnerExtensions(directory) {
-    try {
-        let entries = await fs.readdir(directory, { withFileTypes: true });
-        let extensions = [];
-        for (let entry of entries) {
-            let absolutePath = path.join(directory, entry.name);
-            if (entry.isDirectory()) {
-                extensions.push(...(await collectOwnerExtensions(absolutePath)));
-                continue;
-            }
-            let fileName = path.basename(absolutePath);
-            if (!isActionFileName(fileName) && !isControllerEntryFileName(fileName)) {
-                continue;
-            }
-            let extension = getOwnerFileExtension(fileName);
-            if (extension != null) {
-                extensions.push(extension);
-            }
-        }
-        return extensions;
-    }
-    catch (error) {
-        let nodeError = error;
-        if (nodeError.code === 'ENOENT') {
-            return [];
-        }
-        throw error;
-    }
-}
-function getMostCommonExtension(extensions) {
-    let priority = ['.tsx', '.ts', '.jsx', '.js'];
-    let counts = new Map();
-    for (let extension of extensions) {
-        counts.set(extension, (counts.get(extension) ?? 0) + 1);
-    }
-    let bestExtension = priority[0];
-    let bestCount = -1;
-    for (let extension of priority) {
-        let count = counts.get(extension) ?? 0;
-        if (count > bestCount) {
-            bestCount = count;
-            bestExtension = extension;
-        }
-    }
-    return bestExtension;
-}
 function renderDefaultRoutesFile() {
     return [
         `import { route } from 'remix/routes'`,
@@ -247,133 +168,3 @@ function renderDefaultRoutesFile() {
         '',
     ].join('\n');
 }
-function normalizeRelativePath(filePath) {
-    return filePath.split(path.sep).join('/');
-}
-function renderDefaultHomeAction(entryPath) {
-    let extension = getOwnerFileExtension(entryPath);
-    if (extension === '.js') {
-        return [
-            `import { html } from 'remix/html-template'`,
-            `import { createHtmlResponse } from 'remix/response/html'`,
-            '',
-            'export default {',
-            '  actions: {',
-            '    home() {',
-            '      let page = html`',
-            '        <html lang="en">',
-            '          <head>',
-            '            <meta charset="utf-8" />',
-            '            <meta name="viewport" content="width=device-width, initial-scale=1" />',
-            '            <title>Home</title>',
-            '          </head>',
-            '          <body>',
-            '            <h1>Home</h1>',
-            '            <p>Update app/routes.ts and app/actions/controller to keep building your app.</p>',
-            '          </body>',
-            '        </html>',
-            '      `',
-            '      return createHtmlResponse(page)',
-            '    },',
-            '  },',
-            '}',
-            '',
-        ].join('\n');
-    }
-    if (extension === '.ts') {
-        return [
-            `import { createController } from 'remix/router'`,
-            `import { html } from 'remix/html-template'`,
-            `import { createHtmlResponse } from 'remix/response/html'`,
-            '',
-            `import { routes } from '../routes.ts'`,
-            '',
-            `export default createController(routes, {`,
-            '  actions: {',
-            '    home() {',
-            '      let page = html`',
-            '        <html lang="en">',
-            '          <head>',
-            '            <meta charset="utf-8" />',
-            '            <meta name="viewport" content="width=device-width, initial-scale=1" />',
-            '            <title>Home</title>',
-            '          </head>',
-            '          <body>',
-            '            <h1>Home</h1>',
-            '            <p>Update app/routes.ts and app/actions/controller to keep building your app.</p>',
-            '          </body>',
-            '        </html>',
-            '      `',
-            '      return createHtmlResponse(page)',
-            '    },',
-            '  },',
-            `})`,
-            '',
-        ].join('\n');
-    }
-    if (extension === '.jsx') {
-        return [
-            `import { renderToStream } from 'remix/ui/server'`,
-            `import { createHtmlResponse } from 'remix/response/html'`,
-            '',
-            'export default {',
-            '  actions: {',
-            '    home() {',
-            '      let page = <HomePage />',
-            '      return createHtmlResponse(renderToStream(page))',
-            '    },',
-            '  },',
-            '}',
-            '',
-            'function HomePage() {',
-            '  return () => (',
-            '    <html lang="en">',
-            '      <head>',
-            '        <meta charSet="utf-8" />',
-            '        <meta name="viewport" content="width=device-width, initial-scale=1" />',
-            '        <title>Home</title>',
-            '      </head>',
-            '      <body>',
-            '        <h1>Home</h1>',
-            '        <p>Update app/routes.ts and app/actions/controller to keep building your app.</p>',
-            '      </body>',
-            '    </html>',
-            '  )',
-            '}',
-            '',
-        ].join('\n');
-    }
-    return [
-        `import { createController } from 'remix/router'`,
-        `import { renderToStream } from 'remix/ui/server'`,
-        `import { createHtmlResponse } from 'remix/response/html'`,
-        '',
-        `import { routes } from '../routes.ts'`,
-        '',
-        `export default createController(routes, {`,
-        '  actions: {',
-        '    home() {',
-        '      let page = <HomePage />',
-        '      return createHtmlResponse(renderToStream(page))',
-        '    },',
-        '  },',
-        `})`,
-        '',
-        'function HomePage() {',
-        '  return () => (',
-        '    <html lang="en">',
-        '      <head>',
-        '        <meta charSet="utf-8" />',
-        '        <meta name="viewport" content="width=device-width, initial-scale=1" />',
-        '        <title>Home</title>',
-        '      </head>',
-        '      <body>',
-        '        <h1>Home</h1>',
-        '        <p>Update app/routes.ts and app/actions/controller to keep building your app.</p>',
-        '      </body>',
-        '    </html>',
-        '  )',
-        '}',
-        '',
-    ].join('\n');
-}

package/dist/lib/doctor/run.d.ts

@@ -0,0 +1,9 @@
+export interface RunRemixDoctorOptions {
+    cwd: string;
+    fix: boolean;
+    json: boolean;
+    remixVersion?: string;
+    strict: boolean;
+}
+export declare function runRemixDoctor(options: RunRemixDoctorOptions): Promise<number>;
+//# sourceMappingURL=run.d.ts.map

package/dist/lib/doctor/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/lib/doctor/run.ts"],"names":[],"mappings":"AAsCA,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,OAAO,CAAA;IACZ,IAAI,EAAE,OAAO,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;CAChB;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAoCpF"}