@nexical/cli 0.11.3 → 0.11.5

package/dist/src/deploy/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/deploy/types.ts"],"sourcesContent":["export interface CIConfig {\n  secrets: string[];\n  variables: string[];\n  installSteps?: string[];\n  buildSteps?: string[];\n  deploySteps?: string[];\n  // Platform specific overrides (e.g. uses: action/...)\n  githubActionStep?: Record<string, unknown>;\n}\n\nexport interface DeploymentContext {\n  cwd: string;\n  config: NexicalConfig;\n  options: Record<string, unknown>;\n}\n\nexport interface DeploymentProvider {\n  name: string;\n  type: 'frontend' | 'backend';\n\n  // Interactive or automatic setup of the provider resources\n  provision(context: DeploymentContext): Promise<void>;\n\n  // Returns the CI configuration for this provider\n  getCIConfig(repoType: 'github' | 'gitlab'): CIConfig;\n\n  // Returns a map of secrets to be set in the repository (e.g. tokens, account IDs)\n  // The provider is responsible for resolving these from config/env and throwing if missing.\n  getSecrets(context: DeploymentContext): Promise<Record<string, string>>;\n\n  // Returns a map of variables to be set in the repository (e.g. project names, service names)\n  getVariables(context: DeploymentContext): Promise<Record<string, string>>;\n}\n\nexport interface RepositoryProvider {\n  name: string;\n\n  // Sets secrets/variables in the repo\n  configureSecrets(context: DeploymentContext, secrets: Record<string, string>): Promise<void>;\n  configureVariables(context: DeploymentContext, variables: Record<string, string>): Promise<void>;\n\n  // Generates and writes the CI workflow files\n  generateWorkflow(context: DeploymentContext, targets: DeploymentProvider[]): Promise<void>;\n}\n\nexport interface NexicalConfig {\n  deploy?: {\n    backend?: {\n      provider: string;\n      projectName?: string;\n      options?: Record<string, unknown>;\n    };\n    frontend?: {\n      provider: string;\n      projectName?: string;\n      options?: Record<string, unknown>;\n    };\n    repository?: {\n      provider: string;\n      options?: Record<string, unknown>;\n    };\n  };\n}\n"],"mappings":";;;;;;AAAA;","names":[]}

package/dist/src/deploy/utils.d.ts

@@ -0,0 +1,6 @@
+import { exec } from 'node:child_process';
+
+declare const execAsync: typeof exec.__promisify__;
+declare function checkCommand(command: string): Promise<boolean>;
+
+export { checkCommand, execAsync };

package/dist/src/deploy/utils.js

@@ -0,0 +1,11 @@
+import { createRequire } from "module"; const require = createRequire(import.meta.url);
+import {
+  checkCommand,
+  execAsync
+} from "../../chunk-2JW5BYZW.js";
+import "../../chunk-OYFWMYPG.js";
+export {
+  checkCommand,
+  execAsync
+};
+//# sourceMappingURL=utils.js.map

package/dist/src/deploy/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexical/cli",
-  "version": "0.11.3",
+  "version": "0.11.5",
   "type": "module",
   "bin": {
     "nexical": "./dist/index.js"
@@ -29,30 +29,32 @@
   },
   "dependencies": {
     "@nexical/cli-core": "^0.1.12",
-    "yaml": "^2.3.4",
-    "fast-glob": "^3.3.3"
+    "dotenv": "^17.3.1",
+    "fast-glob": "^3.3.3",
+    "jiti": "^2.6.1",
+    "yaml": "^2.3.4"
   },
   "devDependencies": {
+    "@eslint/js": "^9.39.2",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^20.10.0",
     "@vitest/coverage-v8": "^4.0.15",
-    "execa": "^9.6.1",
-    "fs-extra": "^11.3.2",
-    "tsup": "^8.0.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5.3.3",
-    "vitest": "^4.0.15",
-    "@eslint/js": "^9.39.2",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-astro": "^1.5.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.0.1",
+    "execa": "^9.6.1",
+    "fs-extra": "^11.3.2",
     "globals": "^17.2.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.2.7",
     "prettier": "^3.8.1",
-    "typescript-eslint": "^8.54.0"
+    "tsup": "^8.0.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.15"
   }
 }

package/src/commands/deploy.ts

@@ -1,186 +1,170 @@
-import { BaseCommand, runCommand } from '@nexical/cli-core';
-import { exec } from 'node:child_process';
-import { promisify } from 'node:util';
+import path from 'node:path';
+import dotenv from 'dotenv';
+import { BaseCommand } from '@nexical/cli-core';
+import { ConfigManager } from '../deploy/config-manager';
+import { ProviderRegistry } from '../deploy/registry';
+import { DeploymentContext } from '../deploy/types';
 
-const execAsync = promisify(exec);
+export default class DeployCommand extends BaseCommand {
+  static description = `Deploy the application based on nexical.yaml configuration.
 
-interface DeployOptions {
-  dryRun: boolean;
-  railwayToken?: string;
-  cloudflareToken?: string;
-  cloudflareAccount?: string;
-}
+This command orchestrates the deployment of your frontend and backend applications 
+by interacting with the providers specified in your configuration file.
 
-export default class DeployCommand extends BaseCommand {
-  static description = 'Deploy the application to Railway and Cloudflare.';
+CONFIGURATION:
+- Requires a 'nexical.yaml' file in the project root.
+- If the file or specific sections are missing, the CLI will prompt you to run an interactive setup 
+  and save the configuration for future uses.
+- Supports loading environment variables from a .env file in the project root.
+
+PROVIDERS:
+- Backend: Railway, etc.
+- Frontend: Cloudflare Pages, etc.
+- Repository: GitHub, GitLab, etc.
+
+PROCESS:
+1. Loads environment variables from '.env'.
+2. Loads configuration from 'nexical.yaml'.
+3. Provisions resources via the selected providers.
+4. Configures the repository (secrets/variables) for CI/CD.
+5. Generates CI/CD workflow files.`;
 
   static args = {
     options: [
       {
-        name: '--dry-run',
-        description: 'Simulate the deployment process without making changes.',
-        default: false,
+        name: '--backend <provider>',
+        description: 'Override backend provider',
       },
       {
-        name: '--railway-token <token>',
-        description: 'Railway Project Token (optional if already logged in).',
+        name: '--frontend <provider>',
+        description: 'Override frontend provider',
       },
       {
-        name: '--cloudflare-token <token>',
-        description: 'Cloudflare API Token.',
+        name: '--repo <provider>',
+        description: 'Override repositroy provider',
       },
       {
-        name: '--cloudflare-account <id>',
-        description: 'Cloudflare Account ID.',
+        name: '--dry-run',
+        description: 'Simulate the deployment process',
+        default: false,
       },
     ],
   };
 
-  async run(options: DeployOptions) {
-    this.info('Starting Nexical Deployment Automation...');
+  async run(options: Record<string, unknown>) {
+    this.info('Starting Nexical Deployment...');
 
-    if (options.dryRun) {
-      this.notice('DRY RUN MODE ENABLED');
-    }
+    // Load environment variables from .env
+    dotenv.config({ path: path.join(process.cwd(), '.env') });
 
-    try {
-      // 1. Railway Setup
-      await this.setupRailway(options);
-
-      // 2. Cloudflare Setup
-      await this.setupCloudflare(options);
-
-      // 3. GitHub Secrets Setup
-      await this.setupGitHubSecrets(options);
-
-      this.success('Deployment setup complete! Your application is being deployed.');
-    } catch (error: unknown) {
-      if (error instanceof Error) {
-        this.error(`Deployment failed: ${error.message}`);
-      } else {
-        this.error(`Deployment failed: ${String(error)}`);
-      }
-      process.exit(1);
-    }
-  }
+    const configManager = new ConfigManager(process.cwd());
+    const config = await configManager.load();
+    const registry = new ProviderRegistry();
 
-  private async setupRailway(options: DeployOptions) {
-    this.info('Configuring Railway...');
+    // Register core and local providers
+    await registry.loadCoreProviders();
+    await registry.loadLocalProviders(process.cwd());
 
-    if (options.dryRun) {
-      this.info('[Dry Run] Would run: railway init');
-      this.info('[Dry Run] Would run: railway add --database postgres');
-      return;
+    // Resolve providers (CLI flags > Config > Error)
+    const backendProviderName =
+      (options.backend as string | undefined) || config.deploy?.backend?.provider;
+    if (!backendProviderName) {
+      this.error(
+        "Backend provider not specified. Use --backend flag or configure 'deploy.backend.provider' in nexical.yaml.",
+      );
     }
 
-    try {
-      // Check if railway project exists or init
-      // Note: railway init might be interactive, so we might need to handle that or assume user has linked.
-      // For now, let's assume we use 'railway link' if they passed a token or have it set.
-
-      this.info('Ensuring Railway project is linked...');
-      // If they provided a token, we should probably set it in the environment for subsequent calls
-      if (options.railwayToken) {
-        process.env.RAILWAY_TOKEN = options.railwayToken;
-      }
-
-      // Check if we are in a railway project
-      try {
-        await runCommand('railway status');
-      } catch {
-        this.info('No Railway project detected. Initializing...');
-        await runCommand('railway init');
-      }
-
-      this.info('Adding PostgreSQL service if missing...');
-      // railway add --database postgres is usually safe to run twice but we should check status
-      const { stdout: status } = await execAsync('railway status');
-      if (!status.includes('postgres')) {
-        await runCommand('railway add --database postgres');
-      }
-    } catch (e: unknown) {
-      this.warn(
-        'Railway setup encountered an issue. Ensure you are logged in with `railway login`.',
+    const frontendProviderName =
+      (options.frontend as string | undefined) || config.deploy?.frontend?.provider;
+    if (!frontendProviderName) {
+      this.error(
+        "Frontend provider not specified. Use --frontend flag or configure 'deploy.frontend.provider' in nexical.yaml.",
       );
-      throw e;
     }
-  }
-
-  private async setupCloudflare(options: DeployOptions) {
-    this.info('Configuring Cloudflare Pages...');
 
-    if (options.dryRun) {
-      this.info('[Dry Run] Would run: wrangler pages project create nexical-frontend');
-      return;
+    const repoProviderName =
+      (options.repo as string | undefined) || config.deploy?.repository?.provider;
+    if (!repoProviderName) {
+      this.error(
+        "Repository provider not specified. Use --repo flag or configure 'deploy.repository.provider' in nexical.yaml.",
+      );
     }
 
-    if (!options.cloudflareToken || !options.cloudflareAccount) {
-      this.warn('Cloudflare credentials missing. Skipping automated Cloudflare setup.');
-      this.info('You can manually set up Cloudflare Pages and add the secrets to GitHub.');
-      return;
+    const backendProvider = registry.getDeploymentProvider(backendProviderName!);
+    const frontendProvider = registry.getDeploymentProvider(frontendProviderName!);
+    const repoProvider = registry.getRepositoryProvider(repoProviderName!);
+
+    if (!backendProvider) throw new Error(`Backend provider '${backendProviderName}' not found.`);
+    if (!frontendProvider)
+      throw new Error(`Frontend provider '${frontendProviderName}' not found.`);
+    if (!repoProvider) throw new Error(`Repository provider '${repoProviderName}' not found.`);
+
+    const context: DeploymentContext = {
+      cwd: process.cwd(),
+      config,
+      options,
+    };
+
+    // Provision
+    this.info(`Provisioning Backend with ${backendProvider.name}...`);
+    await backendProvider.provision(context);
+
+    this.info(`Provisioning Frontend with ${frontendProvider.name}...`);
+    await frontendProvider.provision(context);
+
+    // Configure Repo
+    this.info(`Configuring Repository with ${repoProvider.name}...`);
+
+    const secrets: Record<string, string> = {};
+
+    // Collect secrets from Backend Provider
+    this.info(`Resolving secrets from ${backendProvider.name}...`);
+    try {
+      const backendSecrets = await backendProvider.getSecrets(context);
+      Object.assign(secrets, backendSecrets);
+    } catch (e: unknown) {
+      const message = e instanceof Error ? e.message : String(e);
+      this.error(`Failed to resolve secrets for ${backendProvider.name}: ${message}`);
     }
 
+    // Collect secrets from Frontend Provider
+    this.info(`Resolving secrets from ${frontendProvider.name}...`);
     try {
-      // Use wrangler to create project if it doesn't exist
-      // We assume project name 'nexical-frontend' for now, should be configurable.
-      const projectName = 'nexical-frontend';
-      this.info(`Ensuring Cloudflare Pages project "${projectName}" exists...`);
-
-      try {
-        await execAsync(`wrangler pages project create ${projectName} --production-branch main`, {
-          env: {
-            ...process.env,
-            CLOUDFLARE_API_TOKEN: options.cloudflareToken,
-            CLOUDFLARE_ACCOUNT_ID: options.cloudflareAccount,
-          },
-        });
-      } catch {
-        this.info('Cloudflare project might already exist.');
-      }
+      const frontendSecrets = await frontendProvider.getSecrets(context);
+      Object.assign(secrets, frontendSecrets);
     } catch (e: unknown) {
-      this.warn('Cloudflare setup failed.');
-      throw e;
+      const message = e instanceof Error ? e.message : String(e);
+      this.error(`Failed to resolve secrets for ${frontendProvider.name}: ${message}`);
     }
-  }
 
-  private async setupGitHubSecrets(options: DeployOptions) {
-    this.info('Configuring GitHub Secrets...');
+    await repoProvider.configureSecrets(context, secrets);
+
+    const variables: Record<string, string> = {};
 
-    if (options.dryRun) {
-      this.info('[Dry Run] Would run: gh secret set RAILWAY_TOKEN');
-      this.info('[Dry Run] Would run: gh secret set CLOUDFLARE_API_TOKEN');
-      this.info('[Dry Run] Would run: gh secret set CLOUDFLARE_ACCOUNT_ID');
-      return;
+    // Collect variables from Backend Provider
+    try {
+      const backendVars = await backendProvider.getVariables(context);
+      Object.assign(variables, backendVars);
+    } catch (e: unknown) {
+      const message = e instanceof Error ? e.message : String(e);
+      this.error(`Failed to resolve variables for ${backendProvider.name}: ${message}`);
     }
 
+    // Collect variables from Frontend Provider
     try {
-      // We need the Railway Project Token.
-      // User might have provided it, or we try to get it from railway tokens?
-      // Railway CLI doesn't easily expose the project token via CLI easily without a lot of parsing.
-      // Usually users generate it in the UI.
-      // If they provided it via --railway-token, we use it.
-
-      if (options.railwayToken) {
-        this.info('Setting RAILWAY_TOKEN in GitHub...');
-        await runCommand(`gh secret set RAILWAY_TOKEN --body "${options.railwayToken}"`);
-      }
-
-      if (options.cloudflareToken) {
-        this.info('Setting CLOUDFLARE_API_TOKEN in GitHub...');
-        await runCommand(`gh secret set CLOUDFLARE_API_TOKEN --body "${options.cloudflareToken}"`);
-      }
-
-      if (options.cloudflareAccount) {
-        this.info('Setting CLOUDFLARE_ACCOUNT_ID in GitHub...');
-        await runCommand(
-          `gh secret set CLOUDFLARE_ACCOUNT_ID --body "${options.cloudflareAccount}"`,
-        );
-      }
+      const frontendVars = await frontendProvider.getVariables(context);
+      Object.assign(variables, frontendVars);
     } catch (e: unknown) {
-      this.warn(
-        'GitHub Secrets setup failed. Ensure you have the GitHub CLI (gh) installed and are logged in.',
-      );
-      throw e;
+      const message = e instanceof Error ? e.message : String(e);
+      this.error(`Failed to resolve variables for ${frontendProvider.name}: ${message}`);
     }
+
+    await repoProvider.configureVariables(context, variables);
+
+    // Generate Workflows
+    this.info('Generating CI/CD Workflows...');
+    await repoProvider.generateWorkflow(context, [backendProvider, frontendProvider]);
+
+    this.success('Deployment configuration complete!');
   }
 }

package/src/deploy/config-manager.ts

@@ -0,0 +1,41 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import YAML from 'yaml';
+import { NexicalConfig } from './types';
+
+export class ConfigManager {
+  private configPath: string;
+
+  constructor(cwd: string) {
+    this.configPath = path.join(cwd, 'nexical.yaml');
+  }
+
+  async load(): Promise<NexicalConfig> {
+    try {
+      const content = await fs.readFile(this.configPath, 'utf-8');
+      return YAML.parse(content) as NexicalConfig;
+    } catch (error: unknown) {
+      if (
+        error &&
+        typeof error === 'object' &&
+        'code' in error &&
+        (error as { code: unknown }).code === 'ENOENT'
+      ) {
+        return {};
+      }
+      throw error;
+    }
+  }
+
+  async save(config: NexicalConfig): Promise<void> {
+    const content = YAML.stringify(config);
+    await fs.writeFile(this.configPath, content, 'utf-8');
+  }
+
+  exists(): Promise<boolean> {
+    return fs
+      .access(this.configPath)
+      .then(() => true)
+      .catch(() => false);
+  }
+}

package/src/deploy/providers/cloudflare.ts

@@ -0,0 +1,143 @@
+import { logger } from '@nexical/cli-core';
+import { DeploymentProvider, DeploymentContext, CIConfig } from '../types';
+import { execAsync } from '../utils';
+
+export class CloudflareProvider implements DeploymentProvider {
+  name = 'cloudflare';
+  type = 'frontend' as const;
+
+  async provision(context: DeploymentContext): Promise<void> {
+    const projectName = context.config.deploy?.frontend?.projectName;
+
+    if (!projectName) {
+      throw new Error(
+        "Cloudflare project name not found in nexical.yaml. Please configure 'deploy.frontend.projectName'.",
+      );
+    }
+
+    const options = context.config.deploy?.frontend?.options || {};
+
+    // Resolve credentials:
+    // 1. CLI flag (options)
+    // 2. Env var defined in config (options.apiTokenEnvVar)
+    // 3. Default env var (CLOUDFLARE_API_TOKEN)
+    const apiTokenEnvVar =
+      typeof options.apiTokenEnvVar === 'string' ? options.apiTokenEnvVar : undefined;
+    const apiToken =
+      (typeof context.options.cloudflareToken === 'string'
+        ? context.options.cloudflareToken
+        : undefined) ||
+      (apiTokenEnvVar ? process.env[apiTokenEnvVar] : undefined) ||
+      process.env.CLOUDFLARE_API_TOKEN;
+
+    const accountIdEnvVar =
+      typeof options.accountIdEnvVar === 'string' ? options.accountIdEnvVar : undefined;
+    const accountId =
+      (typeof context.options.cloudflareAccount === 'string'
+        ? context.options.cloudflareAccount
+        : undefined) ||
+      (accountIdEnvVar ? process.env[accountIdEnvVar] : undefined) ||
+      process.env.CLOUDFLARE_ACCOUNT_ID;
+
+    logger.info('Configuring Cloudflare Pages...');
+
+    if (context.options.dryRun) {
+      logger.info('[Dry Run] Would check Cloudflare Pages project and create if missing.');
+      return;
+    }
+
+    if (!apiToken || !accountId) {
+      logger.warn('Cloudflare credentials missing. Skipping automated Cloudflare setup.');
+      logger.info('You can manually set up Cloudflare Pages and add the secrets to GitHub.');
+      return;
+    }
+
+    try {
+      logger.info(`Ensuring Cloudflare Pages project "${projectName}" exists...`);
+      try {
+        await execAsync(`wrangler pages project create ${projectName} --production-branch main`, {
+          env: {
+            ...process.env,
+            CLOUDFLARE_API_TOKEN: apiToken,
+            CLOUDFLARE_ACCOUNT_ID: accountId,
+          },
+        });
+      } catch {
+        logger.info('Cloudflare project might already exist.');
+      }
+    } catch (e: unknown) {
+      logger.warn('Cloudflare setup failed.');
+      throw e;
+    }
+  }
+
+  async getSecrets(context: DeploymentContext): Promise<Record<string, string>> {
+    const options = context.config.deploy?.frontend?.options || {};
+    const secrets: Record<string, string> = {};
+
+    // Resolve API Token
+    const apiTokenEnvVar =
+      typeof options.apiTokenEnvVar === 'string' ? options.apiTokenEnvVar : undefined;
+    const apiToken =
+      (apiTokenEnvVar ? process.env[apiTokenEnvVar] : undefined) ||
+      process.env.CLOUDFLARE_API_TOKEN;
+
+    if (!apiToken) {
+      throw new Error(
+        `Cloudflare API Token not found. Please provide it via:\n` +
+          `1. Configuring 'deploy.frontend.options.apiTokenEnvVar' in nexical.yaml and setting that env var in .env\n` +
+          `2. Setting CLOUDFLARE_API_TOKEN in .env`,
+      );
+    }
+    secrets['CLOUDFLARE_API_TOKEN'] = apiToken;
+
+    // Resolve Account ID
+    const accountIdEnvVar =
+      typeof options.accountIdEnvVar === 'string' ? options.accountIdEnvVar : undefined;
+    const accountId =
+      (accountIdEnvVar ? process.env[accountIdEnvVar] : undefined) ||
+      process.env.CLOUDFLARE_ACCOUNT_ID;
+
+    if (!accountId) {
+      throw new Error(
+        `Cloudflare Account ID not found. Please provide it via:\n` +
+          `1. Configuring 'deploy.frontend.options.accountIdEnvVar' in nexical.yaml and setting that env var in .env\n` +
+          `2. Setting CLOUDFLARE_ACCOUNT_ID in .env`,
+      );
+    }
+    secrets['CLOUDFLARE_ACCOUNT_ID'] = accountId;
+
+    return secrets;
+  }
+
+  async getVariables(context: DeploymentContext): Promise<Record<string, string>> {
+    const projectName = context.config.deploy?.frontend?.projectName;
+
+    if (!projectName) {
+      throw new Error(
+        "Cloudflare project name not found in nexical.yaml. Please configure 'deploy.frontend.projectName'.",
+      );
+    }
+    return {
+      CLOUDFLARE_PROJECT_NAME: projectName,
+    };
+  }
+
+  getCIConfig(): CIConfig {
+    return {
+      secrets: ['CLOUDFLARE_API_TOKEN', 'CLOUDFLARE_ACCOUNT_ID'],
+      variables: ['CLOUDFLARE_PROJECT_NAME'],
+      deploySteps: [], // Handled by action
+      githubActionStep: {
+        name: 'Deploy to Cloudflare Pages',
+        uses: 'cloudflare/wrangler-action@v3',
+        with: {
+          apiToken: '${{ secrets.CLOUDFLARE_API_TOKEN }}',
+          accountId: '${{ secrets.CLOUDFLARE_ACCOUNT_ID }}',
+          command: 'pages deploy dist --project-name=${{ vars.CLOUDFLARE_PROJECT_NAME }}',
+          workingDirectory: 'apps/frontend',
+        },
+      },
+    };
+  }
+}