ensure directory is required for multiple directories

Author: stevensJourney

cli/src/commands/deploy/index.ts

@@ -63,11 +63,12 @@ export default class DeployAll extends CloudInstanceCommand {
       default: DEFAULT_DEPLOY_TIMEOUT_MS / 1000,
       description:
         'Seconds to wait after scheduling a deploy before timing out while polling status (default 300 seconds).',
-      parse: async (input) => {
+      async parse(input) {
         const value = Number(input);
         if (!Number.isFinite(value) || value <= 0) {
           throw new Error('deploy-timeout must be a positive number of seconds');
         }
+
         return value;
       }
     }),
@@ -255,11 +256,13 @@ export default class DeployAll extends CloudInstanceCommand {
 
   protected async withDeploy(timeoutMs: number, fn: () => Promise<routes.DeployInstanceResponse>): Promise<void> {
     const { client, project } = this;
+
     const spinner = ora({
       prefixText: '\nDeploying instance.\n',
       spinner: 'moon',
       suffixText: '\nThis may take a few minutes.\n'
     });
+
     spinner.start();
 
     try {

cli/src/commands/deploy/sync-config.ts

@@ -18,8 +18,11 @@ export class DeploySyncConfig extends DeployAll {
    * Deploys only the sync config.
    * Uses existing cloud config state for other fields.
    */
-  protected async deploySyncConfig(params: { cloudConfigState: routes.InstanceConfigResponse }): Promise<void> {
-    const { cloudConfigState } = params;
+  protected async deploySyncConfig(params: {
+    cloudConfigState: routes.InstanceConfigResponse;
+    timeout: number;
+  }): Promise<void> {
+    const { cloudConfigState, timeout } = params;
     const { project } = this;
     const { linked } = project;
 
@@ -37,7 +40,7 @@ export class DeploySyncConfig extends DeployAll {
       });
     }
 
-    return this.withDeploy(async () =>
+    return this.withDeploy(timeout, async () =>
       this.client.deployInstance(
         routes.DeployInstanceRequest.encode({
           ...cloudConfigState,
@@ -71,6 +74,6 @@ export class DeploySyncConfig extends DeployAll {
 
     this.log('Validations completed successfully.\n');
 
-    await this.deploySyncConfig({ cloudConfigState });
+    await this.deploySyncConfig({ cloudConfigState, timeout: flags.timeout });
   }
 }

cli/src/commands/init/cloud.ts

@@ -2,7 +2,6 @@ import { Flags, ux } from '@oclif/core';
 import {
   CLI_FILENAME,
   InstanceCommand,
-  PowerSyncCommand,
   SERVICE_FILENAME,
   SYNC_FILENAME,
   YAML_CLI_SCHEMA,
@@ -18,7 +17,7 @@ import { writeVscodeSettingsForYamlEnv } from '../../api/write-vscode-settings-f
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const TEMPLATES_DIR = join(__dirname, '..', '..', '..', 'templates');
 
-export default class InitCloud extends PowerSyncCommand {
+export default class InitCloud extends InstanceCommand {
   static description =
     'Copy a Cloud template into a config directory (default powersync/). Edit service.yaml then run link cloud and deploy.';
   static examples = [

cli/src/commands/init/self-hosted.ts

@@ -2,7 +2,6 @@ import { Flags, ux } from '@oclif/core';
 import {
   CLI_FILENAME,
   InstanceCommand,
-  PowerSyncCommand,
   SERVICE_FILENAME,
   SYNC_FILENAME,
   YAML_CLI_SCHEMA,
@@ -18,7 +17,7 @@ import { writeVscodeSettingsForYamlEnv } from '../../api/write-vscode-settings-f
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const TEMPLATES_DIR = join(__dirname, '..', '..', '..', 'templates');
 
-export default class InitSelfHosted extends PowerSyncCommand {
+export default class InitSelfHosted extends InstanceCommand {
   static description =
     'Copy a self-hosted template into a config directory (default powersync/). Configure service.yaml with your self-hosted instance details.';
   static examples = [

cli/src/commands/link/cloud.ts

@@ -78,7 +78,7 @@ export default class LinkCloud extends CloudInstanceCommand {
         this.styledError({ error, message: 'Failed to create Cloud instance' });
       }
 
-      const projectDir = this.ensureProjectDirExists({ directory });
+      const projectDir = this.ensureProjectDirectory({ directory });
       ensureServiceTypeMatches({
         command: this,
         configRequired: false,

cli/src/commands/link/self-hosted.ts

@@ -31,7 +31,7 @@ export default class LinkSelfHosted extends SelfHostedInstanceCommand {
     const { flags } = await this.parse(LinkSelfHosted);
     const { 'api-url': apiUrl, directory } = flags;
 
-    const projectDir = this.ensureProjectDirExists(flags);
+    const projectDir = this.ensureProjectDirectory(flags);
     ensureServiceTypeMatches({
       command: this,
       configRequired: false,

cli/src/commands/migrate/sync-rules.ts

@@ -23,7 +23,7 @@ export default class MigrateSyncRules extends InstanceCommand {
   async run(): Promise<void> {
     const { flags } = await this.parse(MigrateSyncRules);
 
-    const syncInputPath = flags['input-file'] ?? join(this.ensureProjectDirExists(flags), SYNC_FILENAME);
+    const syncInputPath = flags['input-file'] ?? join(this.ensureProjectDirectory(flags), SYNC_FILENAME);
     const syncOutputPath = flags['output-file'] ?? syncInputPath;
 
     if (

packages/cli-core/src/command-types/CloudInstanceCommand.ts

@@ -103,7 +103,7 @@ export abstract class CloudInstanceCommand extends InstanceCommand {
       ...options,
       ...DEFAULT_ENSURE_CONFIG_OPTIONS
     };
-    const projectDir = this.ensureProjectDirExists(flags);
+    const projectDir = this.ensureProjectDirectory(flags);
 
     // Check if the service.yaml file is present and has _type: cloud
     ensureServiceTypeMatches({

packages/cli-core/src/command-types/InstanceCommand.ts

@@ -1,5 +1,6 @@
 import { Flags, ux } from '@oclif/core';
-import { existsSync } from 'node:fs';
+import fs from 'node:fs';
+import { CLI_FILENAME } from '../utils/project-config.js';
 import { HelpGroup } from './HelpGroup.js';
 import { PowerSyncCommand } from './PowerSyncCommand.js';
 
@@ -14,23 +15,40 @@ export const DEFAULT_ENSURE_CONFIG_OPTIONS: Required<EnsureConfigOptions> = {
   configFileRequired: false
 };
 
+export const DEFAULT_INSTANCE_DIRECTORY = 'powersync';
+
 /** Base command for operations that target a PowerSync project directory (e.g. link, init). */
 export abstract class InstanceCommand extends PowerSyncCommand {
   static flags = {
     ...PowerSyncCommand.flags,
     directory: Flags.string({
-      default: 'powersync',
-      description: 'Directory containing PowerSync config.',
-      helpGroup: HelpGroup.PROJECT
+      description:
+        'Directory containing PowerSync config. Defaults to "powersync". This is required if multiple powersync config files are present in subdirectories of the current working directory.',
+      helpGroup: HelpGroup.PROJECT,
+      default: async () => {
+        // Before we default, we need to ensure only 1 linked project is present.
+        const directories = fs.readdirSync(process.cwd()).filter((dir) => fs.existsSync(`${dir}/${CLI_FILENAME}`));
+        if (directories.length > 1) {
+          throw new Error(
+            [
+              `Multiple directories containing ${CLI_FILENAME} found. Please specify the target directory with --directory.`,
+              ...directories.map(
+                (dir) => `Use ${ux.colorize('blue', `--directory=${dir}`)} to target the ${dir} config.`
+              )
+            ].join('\n')
+          );
+        }
+
+        return DEFAULT_INSTANCE_DIRECTORY;
+      }
     })
   };
 
-  ensureProjectDirExists(flags: { directory: string }): string {
-    const { directory } = flags;
+  ensureProjectDirectory(flags: { directory: string }): string {
     const projectDir = this.resolveProjectDir(flags);
-    if (!existsSync(projectDir)) {
+    if (!fs.existsSync(projectDir)) {
       this.styledError({
-        message: `Directory "${directory}" not found. Run ${ux.colorize('blue', 'powersync init cloud')} or ${ux.colorize('blue', 'powersync init self-hosted')} first to create the project.`
+        message: `Directory "${flags.directory}" not found. Run ${ux.colorize('blue', 'powersync init cloud')} or ${ux.colorize('blue', 'powersync init self-hosted')} first to create the project.`
       });
     }
     return projectDir;

packages/cli-core/src/command-types/SelfHostedInstanceCommand.ts

@@ -58,7 +58,7 @@ export abstract class SelfHostedInstanceCommand extends InstanceCommand {
       ...options
     };
 
-    const projectDir = this.ensureProjectDirExists(flags);
+    const projectDir = this.ensureProjectDirectory(flags);
 
     ensureServiceTypeMatches({
       command: this,