@remix-run/cli 0.3.3 → 0.4.0

package/README.md

@@ -7,9 +7,11 @@ Command-line interface for creating and managing Remix projects.
 - Create new Remix projects with `npx remix@next new` or installed `remix new`
 - Print shell completion scripts with `remix completion`
 - Check project environment and Remix app conventions with `remix doctor`
-- Create low-risk project and controller files with `remix doctor --fix`
+- Apply available low-risk project fixes with `remix doctor --fix`
+- Manage the current app database with `remix db`
 - Inspect the current app route tree with `remix routes`
 - Run project tests with `remix test`
+- Configure commands with a static, commented `remix.json` file
 - Print the current Remix version with `remix version`
 - Use the same CLI through the `remix` package or the `remix/cli` API
 - Scaffold a starter app that matches the Remix project layout conventions
@@ -47,6 +49,9 @@ remix new my-remix-app
 remix completion bash >> ~/.bashrc
 remix doctor
 remix doctor --fix
+remix db migrate
+remix db status
+remix db reset --force
 remix routes
 remix routes --table
 remix routes --table --no-headers
@@ -64,6 +69,9 @@ await runRemix(['new', 'my-remix-app'])
 await runRemix(['completion', 'bash'])
 await runRemix(['doctor'])
 await runRemix(['doctor', '--fix'])
+await runRemix(['db', 'migrate'])
+await runRemix(['db', 'status'])
+await runRemix(['db', 'reset', '--force'])
 await runRemix(['routes'])
 await runRemix(['routes', '--table'])
 await runRemix(['routes', '--table', '--no-headers'])
@@ -71,8 +79,104 @@ await runRemix(['test'])
 await runRemix(['version'])
 ```
 
+Destructive database commands (`remix db wipe` and `remix db reset`) refuse to run without `--force`.
+
 `runRemix()` returns the CLI exit code as a promise.
 
+## Configuration
+
+The CLI loads an optional `remix.json`. The file is parsed as JSONC, so it may contain comments and
+trailing commas. Every top-level field is optional:
+
+```jsonc
+{
+  "$schema": "https://remix.run/schemas/remix.json",
+
+  "db": {
+    "adapter": {
+      "type": "sqlite",
+      "filename": { "env": "DATABASE_URL", "default": "./db/app.sqlite" },
+      "foreignKeys": true,
+      "busyTimeout": 5000,
+    },
+    "migrations": {
+      "directory": "./db/migrations",
+      "journalTable": "data_table_migrations",
+    },
+    "seed": "./db/seed.sql",
+  },
+
+  "doctor": {
+    "strict": true,
+  },
+
+  "test": {
+    // Test discovery
+    "files": ["**/*.test{,.browser,.e2e}.{ts,tsx}"],
+    "browserFiles": ["**/*.test.browser.{ts,tsx}"],
+    "e2eFiles": ["**/*.test.e2e.{ts,tsx}"],
+    "exclude": ["node_modules/**", "dist/**"],
+    "type": ["server", "browser", "e2e"],
+    "only": ["/checkout/i"],
+
+    // Test execution
+    "concurrency": 4,
+    "pool": "forks",
+    "setup": "./test/setup.ts",
+    "watch": false,
+
+    // Playwright
+    "playwright": {
+      "echo": false,
+      "open": false,
+      "configFile": "./playwright.config.ts",
+      "projects": ["chromium", "firefox"],
+    },
+
+    // Output
+    "reporter": "spec",
+    "quiet": false,
+
+    // Coverage
+    "coverage": {
+      "enabled": true,
+      "dir": ".coverage",
+      "include": ["app/**"],
+      "exclude": ["**/*.test.*"],
+      "branches": 80,
+      "functions": 80,
+      "lines": 80,
+      "statements": 80,
+    },
+  },
+}
+```
+
+Explicit command flags and positional arguments override configured values. Repeated flags replace
+configured arrays, while nested Playwright and coverage settings merge by field. Relative paths and
+globs are resolved from the directory containing the config file. Use `remix doctor --no-strict` to
+disable configured strict mode for one run.
+
+`remix db` requires `db.adapter`. Adapters use `type: "sqlite"`, `type: "postgres"`, or
+`type: "mysql"`; PostgreSQL uses `connectionString` and MySQL uses `uri`. A connection value may be
+a string or an object naming an environment variable with an optional default. `db.seed` names a
+SQL file that `remix db seed` and `remix db reset` run against the database. Database flags such as
+`--migrations`, `--seed`, `--journal-table`, and `--connection-env` override the corresponding
+config for one invocation. When no global `--config` is provided, database commands find the
+nearest `remix.json` by walking up from the working directory.
+
+Use the global `--config` option to select another JSONC file. The option itself is resolved from the
+CLI working directory and may appear before or after the command:
+
+```sh
+remix --config ./config/remix.ci.json test
+remix test --config ./config/remix.ci.json
+```
+
+A missing default `remix.json` is ignored. A missing explicitly selected file, malformed JSONC,
+unknown property, or invalid value is reported as a CLI error. The optional `$schema` field enables
+editor completion and validation; it has no runtime effect.
+
 ## License
 
 See [LICENSE](https://github.com/remix-run/remix/blob/main/LICENSE)

package/dist/index.js

@@ -1 +1 @@
-export { runRemix } from "./lib/cli.js";
+export { runRemix } from './lib/cli.js';

package/dist/lib/app-root.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Walks up from `startDir` looking for the closest directory that contains
+ * `relativeFilePath`.
+ *
+ * @param startDir Directory the walk starts from.
+ * @param relativeFilePath Slash-separated app file path, for example `app/routes.ts`.
+ * @returns The closest ancestor directory that contains the file, or `null`
+ *          when no ancestor contains it.
+ */
+export declare function findAppRoot(startDir: string, relativeFilePath: string): Promise<string | null>;
+//# sourceMappingURL=app-root.d.ts.map

package/dist/lib/app-root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-root.d.ts","sourceRoot":"","sources":["../../src/lib/app-root.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAgBxB"}

package/dist/lib/app-root.js

@@ -0,0 +1,38 @@
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+/**
+ * Walks up from `startDir` looking for the closest directory that contains
+ * `relativeFilePath`.
+ *
+ * @param startDir Directory the walk starts from.
+ * @param relativeFilePath Slash-separated app file path, for example `app/routes.ts`.
+ * @returns The closest ancestor directory that contains the file, or `null`
+ *          when no ancestor contains it.
+ */
+export async function findAppRoot(startDir, relativeFilePath) {
+    let relativeSegments = relativeFilePath.split('/');
+    let currentDir = path.resolve(startDir);
+    while (true) {
+        if (await pathExists(path.join(currentDir, ...relativeSegments))) {
+            return currentDir;
+        }
+        let parentDir = path.dirname(currentDir);
+        if (parentDir === currentDir) {
+            return null;
+        }
+        currentDir = parentDir;
+    }
+}
+async function pathExists(filePath) {
+    try {
+        await fs.access(filePath);
+        return true;
+    }
+    catch (error) {
+        let nodeError = error;
+        if (nodeError.code === 'ENOENT') {
+            return false;
+        }
+        throw error;
+    }
+}

package/dist/lib/bootstrap-project.js

@@ -3,8 +3,8 @@ import * as path from 'node:path';
 import * as process from 'node:process';
 import { fileURLToPath } from 'node:url';
 import semver from 'semver';
-import { appNameUnavailable, invalidPackageName, targetDirectoryNotEmpty, targetPathNotDirectory, } from "./errors.js";
-import { runProgressStep } from "./reporter.js";
+import { appNameUnavailable, invalidPackageName, targetDirectoryNotEmpty, targetPathNotDirectory, } from './errors.js';
+import { runProgressStep } from './reporter.js';
 const MODULE_DIRECTORY = path.dirname(fileURLToPath(import.meta.url));
 const PACKAGE_TEMPLATE_DIRECTORY = path.resolve(MODULE_DIRECTORY, '../../template');
 const IS_RUNNING_FROM_SRC = path.extname(new URL(import.meta.url).pathname) === '.ts';

package/dist/lib/cli-context.d.ts

@@ -1,9 +1,15 @@
+import { type RemixConfig } from './remix-config.ts';
 interface ResolveCliContextOptions {
+    configPath?: string;
     cwd?: string;
     remixVersion?: string;
 }
 export interface CliContext {
+    /** Explicit Remix configuration path selected by the caller. */
+    configPath?: string;
     cwd: string;
+    /** Loads and validates the Remix config file, memoizing the result. */
+    loadConfig(): Promise<RemixConfig>;
     remixVersion?: string;
 }
 export declare function resolveCliContext(options?: ResolveCliContextOptions): Promise<CliContext>;

package/dist/lib/cli-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli-context.d.ts","sourceRoot":"","sources":["../../src/lib/cli-context.ts"],"names":[],"mappings":"AAKA,UAAU,wBAAwB;IAChC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,wBAAsB,iBAAiB,CACrC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,UAAU,CAAC,CAQrB"}
+{"version":3,"file":"cli-context.d.ts","sourceRoot":"","sources":["../../src/lib/cli-context.ts"],"names":[],"mappings":"AAIA,OAAO,EAAmB,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAErE,UAAU,wBAAwB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,uEAAuE;IACvE,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC,CAAA;IAClC,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,wBAAsB,iBAAiB,CACrC,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,UAAU,CAAC,CAmBrB"}

package/dist/lib/cli-context.js

@@ -1,11 +1,22 @@
 import * as path from 'node:path';
 import * as process from 'node:process';
-import { resolveDefaultRemixVersion } from "./remix-version.js";
+import { resolveDefaultRemixVersion } from './remix-version.js';
+import { loadRemixConfig } from './remix-config.js';
 export async function resolveCliContext(options = {}) {
     let cwd = resolveCwd(options.cwd);
     let remixVersion = normalizeRemixVersion(options.remixVersion);
+    let configPromise;
+    let loadConfig = () => (configPromise ??= loadRemixConfig(cwd, options.configPath));
+    // Validate an explicitly selected config file up front so every command
+    // fails fast on a bad --config path. The default remix.json is loaded
+    // lazily by the commands that read it, so an invalid file doesn't break
+    // unrelated commands like help, version, or shell completion.
+    if (options.configPath !== undefined)
+        await loadConfig();
     return {
+        configPath: options.configPath,
         cwd,
+        loadConfig,
         remixVersion: remixVersion ?? (await resolveDefaultRemixVersion(cwd)),
     };
 }

package/dist/lib/cli.d.ts

@@ -15,8 +15,9 @@ export interface RunRemixOptions {
 }
 /**
  * Entry point for the `remix` CLI. Parses `argv`, dispatches to the matching
- * subcommand (`new`, `doctor`, `routes`, `test`, `version`, `completion`,
- * `help`), and resolves with the exit code the process should use.
+ * subcommand (`new`, `db`, `doctor`, `routes`, `test`, `version`,
+ * `completion`, `help`), and resolves with the exit code the process should
+ * use.
  *
  * @param argv Argument vector to parse, excluding the node and script paths
  *             (default `process.argv.slice(2)`).

package/dist/lib/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/lib/cli.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,GAAE,MAAM,EAA0B,EACtC,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,MAAM,CAAC,CA0BjB"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/lib/cli.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,QAAQ,CAC5B,IAAI,GAAE,MAAM,EAA0B,EACtC,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,MAAM,CAAC,CA8BjB"}

package/dist/lib/cli.js

@@ -1,12 +1,13 @@
 import * as process from 'node:process';
-import { getCliHelpText, runHelpCommand } from "./commands/help.js";
-import { resolveCliContext } from "./cli-context.js";
-import { renderCliError, unknownCommand } from "./errors.js";
-import { configureColors, restoreTerminalFormatting } from "./terminal.js";
+import { getCliHelpText, runHelpCommand } from './commands/help.js';
+import { resolveCliContext } from './cli-context.js';
+import { missingOptionValue, renderCliError, toCliError, unknownCommand } from './errors.js';
+import { configureColors, restoreTerminalFormatting } from './terminal.js';
 /**
  * Entry point for the `remix` CLI. Parses `argv`, dispatches to the matching
- * subcommand (`new`, `doctor`, `routes`, `test`, `version`, `completion`,
- * `help`), and resolves with the exit code the process should use.
+ * subcommand (`new`, `db`, `doctor`, `routes`, `test`, `version`,
+ * `completion`, `help`), and resolves with the exit code the process should
+ * use.
  *
  * @param argv Argument vector to parse, excluding the node and script paths
  *             (default `process.argv.slice(2)`).
@@ -22,12 +23,12 @@ import { configureColors, restoreTerminalFormatting } from "./terminal.js";
  * ```
  */
 export async function runRemix(argv = process.argv.slice(2), options = {}) {
-    let context = await resolveCliContext(options);
     try {
         argv = stripLeadingSeparators(argv);
         let globalOptions = extractGlobalOptions(argv);
         argv = stripLeadingSeparators(globalOptions.argv);
         configureColors({ disabled: globalOptions.noColor });
+        let context = await resolveCliContext({ ...options, configPath: globalOptions.configPath });
         if (argv.length === 0) {
             process.stdout.write(getCliHelpText());
             return 0;
@@ -39,6 +40,10 @@ export async function runRemix(argv = process.argv.slice(2), options = {}) {
         }
         return await runCommand(command, rest, context);
     }
+    catch (error) {
+        process.stderr.write(renderCliError(toCliError(error), { helpText: getCliHelpText(process.stderr) }));
+        return 1;
+    }
     finally {
         restoreTerminalFormatting();
     }
@@ -54,31 +59,35 @@ async function runCommand(command, argv, context) {
         return runHelpCommand(argv);
     }
     if (command === '-v' || command === '--version') {
-        let { runVersionCommand } = await import("./commands/version.js");
+        let { runVersionCommand } = await import('./commands/version.js');
         return runVersionCommand([], context);
     }
     if (command === 'new') {
-        let { runNewCommand } = await import("./commands/new.js");
+        let { runNewCommand } = await import('./commands/new.js');
         return runNewCommand(argv, context);
     }
     if (command === 'completion') {
-        let { runCompletionCommand } = await import("./commands/completion.js");
+        let { runCompletionCommand } = await import('./commands/completion.js');
         return runCompletionCommand(argv);
     }
     if (command === 'doctor') {
-        let { runDoctorCommand } = await import("./commands/doctor.js");
+        let { runDoctorCommand } = await import('./commands/doctor.js');
         return runDoctorCommand(argv, context);
     }
+    if (command === 'db') {
+        let { runDbCommand } = await import('./commands/db.js');
+        return runDbCommand(argv, context);
+    }
     if (command === 'routes') {
-        let { runRoutesCommand } = await import("./commands/routes.js");
+        let { runRoutesCommand } = await import('./commands/routes.js');
         return runRoutesCommand(argv, context);
     }
     if (command === 'test') {
-        let { runTestCommand } = await import("./commands/test.js");
+        let { runTestCommand } = await import('./commands/test.js');
         return runTestCommand(argv, context);
     }
     if (command === 'version') {
-        let { runVersionCommand } = await import("./commands/version.js");
+        let { runVersionCommand } = await import('./commands/version.js');
         return runVersionCommand(argv, context);
     }
     process.stderr.write(renderCliError(unknownCommand(command), { helpText: getCliHelpText(process.stderr) }));
@@ -86,6 +95,7 @@ async function runCommand(command, argv, context) {
 }
 function extractGlobalOptions(argv) {
     let filteredArgv = [];
+    let configPath;
     let noColor = false;
     for (let index = 0; index < argv.length; index++) {
         let arg = argv[index];
@@ -97,10 +107,28 @@ function extractGlobalOptions(argv) {
             noColor = true;
             continue;
         }
+        if (arg === '--config') {
+            let value = argv[index + 1];
+            if (value == null || value.length === 0 || value.startsWith('-')) {
+                throw missingOptionValue('--config');
+            }
+            configPath = value;
+            index++;
+            continue;
+        }
+        if (arg.startsWith('--config=')) {
+            let value = arg.slice('--config='.length);
+            if (value.length === 0) {
+                throw missingOptionValue('--config');
+            }
+            configPath = value;
+            continue;
+        }
         filteredArgv.push(arg);
     }
     return {
         argv: filteredArgv,
+        configPath,
         noColor,
     };
 }

package/dist/lib/commands/completion.js

@@ -1,8 +1,8 @@
 import * as process from 'node:process';
-import { getCompletionResult, getCompletionScript, isCompletionShell, renderCompletionResult, } from "../completion.js";
-import { invalidCompletionRequest, renderCliError, toCliError, unknownCompletionShell, } from "../errors.js";
-import { formatHelpText } from "../help-text.js";
-import { parseArgs } from "../parse-args.js";
+import { getCompletionResult, getCompletionScript, isCompletionShell, renderCompletionResult, } from '../completion.js';
+import { invalidCompletionRequest, renderCliError, toCliError, unknownCompletionShell, } from '../errors.js';
+import { formatHelpText } from '../help-text.js';
+import { parseArgs } from '../parse-args.js';
 export async function runCompletionCommand(argv) {
     if (argv.length === 0) {
         process.stdout.write(getCompletionCommandHelpText());

package/dist/lib/commands/db.d.ts

@@ -0,0 +1,4 @@
+import type { CliContext } from '../cli-context.ts';
+export declare function runDbCommand(argv: string[], context: CliContext): Promise<number>;
+export declare function getDbCommandHelpText(target?: NodeJS.WriteStream): string;
+//# sourceMappingURL=db.d.ts.map

package/dist/lib/commands/db.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../src/lib/commands/db.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AA6BnD,wBAAsB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBvF;AAED,wBAAgB,oBAAoB,CAAC,MAAM,GAAE,MAAM,CAAC,WAA4B,GAAG,MAAM,CA0CxF"}