feat: warning for non-composable projects

elasticpath · Sep 29, 2023 · 3d913b6 · 3d913b6
1 parent c7dcbce
commit 3d913b6
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/packages/composable-cli/src/commands/integration/integration-command.tsx b/packages/composable-cli/src/commands/integration/integration-command.tsx
@@ -5,33 +5,38 @@ import {
   RootCommandArguments,
 } from "../../types/command"
 import { handleErrors } from "../../util/error-handler"
-import {IntegrationCommandArguments, IntegrationCommandData, IntegrationCommandError
+import {
+  IntegrationCommandArguments,
+  IntegrationCommandData,
+  IntegrationCommandError,
 } from "./integration.types"
 import { trackCommandHandler } from "../../util/track-command-handler"
 import { createAlgoliaIntegrationCommand } from "./algolia/algolia-integration-command"
+import { createComposableProjectMiddleware } from "../../lib/composable-project-middleware"
 
 export function createIntegrationCommand(
-  ctx: CommandContext
+  ctx: CommandContext,
 ): yargs.CommandModule<RootCommandArguments, IntegrationCommandArguments> {
   return {
     command: "integration",
     aliases: ["int"],
     describe: "setup Elastic Path integrations for your storefront",
     builder: (yargs) => {
       return yargs
+        .middleware(createComposableProjectMiddleware(ctx))
         .command(createAlgoliaIntegrationCommand(ctx))
         .help()
         .demandCommand(1)
         .strict()
     },
     handler: handleErrors(
-      trackCommandHandler(ctx, createIntegrationCommandHandler)
+      trackCommandHandler(ctx, createIntegrationCommandHandler),
     ),
   }
 }
 
 export function createIntegrationCommandHandler(
-  _ctx: CommandContext
+  _ctx: CommandContext,
 ): CommandHandlerFunction<
   IntegrationCommandData,
   IntegrationCommandError,

diff --git a/packages/composable-cli/src/commands/payments/payments-command.tsx b/packages/composable-cli/src/commands/payments/payments-command.tsx
@@ -14,6 +14,7 @@ import {
   PaymentsCommandError,
 } from "./payments.types"
 import { createActiveStoreMiddleware } from "../generate/generate-command"
+import { createComposableProjectMiddleware } from "../../lib/composable-project-middleware"
 
 export function createPaymentsCommand(
   ctx: CommandContext,
@@ -24,6 +25,7 @@ export function createPaymentsCommand(
     describe: "setup Elastic Path payment gateways for your storefront",
     builder: (yargs) => {
       return yargs
+        .middleware(createComposableProjectMiddleware(ctx))
         .middleware(createActiveStoreMiddleware(ctx))
         .command(createEPPaymentsCommand(ctx))
         .help()

diff --git a/packages/composable-cli/src/lib/composable-project-middleware.ts b/packages/composable-cli/src/lib/composable-project-middleware.ts
@@ -0,0 +1,21 @@
+import yargs, { MiddlewareFunction } from "yargs"
+import { CommandContext } from "../types/command"
+import boxen from "boxen"
+
+export function createComposableProjectMiddleware(
+  ctx: CommandContext,
+): MiddlewareFunction {
+  return async function composableProjectMiddleware(
+    _args: yargs.ArgumentsCamelCase<{}>,
+  ) {
+    if (!ctx.composableRc) {
+      ctx.logger.info(
+        boxen(
+          "Failed to find .composablerc, is this a Composable Frontend workspace?\nThis command expects to be run in a composable frontend workspace and may not work as expected. It could be you're not inside your project folder.",
+          { padding: 1, margin: 1, borderColor: "yellow" },
+        ),
+      )
+    }
+    return
+  }
+}