Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix(cli): say how to confirm in confirmation errors

Andrej085fa34fd837
diff --git a/packages/cli/src/admin/confirm-slug.ts b/packages/cli/src/admin/confirm-slug.ts
index e8b0fcf3f..a1841db05 100644
--- a/packages/cli/src/admin/confirm-slug.ts
+++ b/packages/cli/src/admin/confirm-slug.ts
@@ -3,6 +3,7 @@ import { Prompt } from "effect/cli";
import { Cancelled, InvalidArgument } from "../errors/errors.js";
import { note } from "../output/emit.js";
import { Output } from "../output/output.js";
+import { needsConfirmation } from "../prompts/needs-confirmation.js";
import { promptTheme } from "../prompts/prompt-theme.js";
export const confirmBySlug = Effect.fnUntraced(function* (options: {
@@ -13,12 +14,7 @@ export const confirmBySlug = Effect.fnUntraced(function* (options: {
}) {
if (options.yes) return;
const output = yield* Output;
- if (!output.interactive) {
- return yield* new InvalidArgument({
- message: `${options.action} needs confirmation.`,
- hint: "Pass --yes to skip the prompt.",
- });
- }
+ if (!output.interactive) return yield* needsConfirmation(options.action);
yield* note((ui) => [
"",
` ${ui.theme.danger(ui.glyphs.warning)} ${options.warning}`,
diff --git a/packages/cli/src/projects-write/confirm-by-key.ts b/packages/cli/src/projects-write/confirm-by-key.ts
index 37f3fa943..37d9917f3 100644
--- a/packages/cli/src/projects-write/confirm-by-key.ts
+++ b/packages/cli/src/projects-write/confirm-by-key.ts
@@ -1,8 +1,9 @@
import { Effect } from "effect";
import { Prompt } from "effect/cli";
-import { Cancelled, InvalidArgument } from "../errors/errors.js";
+import { Cancelled } from "../errors/errors.js";
import { note } from "../output/emit.js";
import { Output } from "../output/output.js";
+import { needsConfirmation } from "../prompts/needs-confirmation.js";
import { promptTheme } from "../prompts/prompt-theme.js";
function same(a: string, b: string): boolean {
@@ -20,12 +21,7 @@ export const confirmByKey = Effect.fnUntraced(function* (options: {
}) {
if (options.yes) return;
const output = yield* Output;
- if (!output.interactive) {
- return yield* new InvalidArgument({
- message: `${options.action} needs confirmation.`,
- hint: "Pass --yes to skip the prompt.",
- });
- }
+ if (!output.interactive) return yield* needsConfirmation(options.action);
yield* note((ui) => [
"",
` ${ui.theme.warning(ui.glyphs.warning)} ${options.warning}`,
diff --git a/packages/cli/src/prompts/confirm-destructive.test.ts b/packages/cli/src/prompts/confirm-destructive.test.ts
new file mode 100644
index 000000000..2e9b92edf
--- /dev/null
+++ b/packages/cli/src/prompts/confirm-destructive.test.ts
@@ -0,0 +1,37 @@
+import * as NodeServices from "@effect/platform-node/NodeServices";
+import { Effect, Layer, Result } from "effect";
+import { describe, expect, it } from "vite-plus/test";
+import { captureOutput } from "../testing/test-layers.js";
+import { confirmDestructive } from "./confirm-destructive.js";
+
+const run = (yes: boolean) =>
+ Effect.runPromise(
+ confirmDestructive({
+ yes,
+ action: "Deleting KAN-12",
+ question: "Delete KAN-12?",
+ }).pipe(
+ Effect.result,
+ Effect.provide(
+ Layer.merge(captureOutput("json").layer, NodeServices.layer),
+ ),
+ ),
+ );
+
+describe("confirmDestructive", () => {
+ it("tells scripts to pass --yes in the error message itself", async () => {
+ const result = await run(false);
+ expect(Result.isFailure(result)).toBe(true);
+ if (Result.isFailure(result)) {
+ expect(result.failure).toMatchObject({
+ _tag: "InvalidArgument",
+ message: "Deleting KAN-12 needs confirmation. Pass --yes to confirm.",
+ });
+ expect(result.failure).not.toHaveProperty("hint");
+ }
+ });
+
+ it("goes ahead without asking when --yes is passed", async () => {
+ expect(Result.isSuccess(await run(true))).toBe(true);
+ });
+});
diff --git a/packages/cli/src/prompts/confirm-destructive.ts b/packages/cli/src/prompts/confirm-destructive.ts
index 85eedb934..2e5873e23 100644
--- a/packages/cli/src/prompts/confirm-destructive.ts
+++ b/packages/cli/src/prompts/confirm-destructive.ts
@@ -1,7 +1,8 @@
import { Effect } from "effect";
-import { Cancelled, InvalidArgument } from "../errors/errors.js";
+import { Cancelled } from "../errors/errors.js";
import { Output } from "../output/output.js";
import { confirm } from "./confirm.js";
+import { needsConfirmation } from "./needs-confirmation.js";
export const confirmDestructive = Effect.fnUntraced(function* (options: {
readonly yes: boolean;
@@ -10,12 +11,7 @@ export const confirmDestructive = Effect.fnUntraced(function* (options: {
}) {
if (options.yes) return;
const output = yield* Output;
- if (!output.interactive) {
- return yield* new InvalidArgument({
- message: `${options.action} needs confirmation.`,
- hint: "Pass --yes to skip the prompt.",
- });
- }
+ if (!output.interactive) return yield* needsConfirmation(options.action);
const confirmed = yield* confirm(options.question);
if (!confirmed) return yield* new Cancelled();
});
diff --git a/packages/cli/src/prompts/needs-confirmation.ts b/packages/cli/src/prompts/needs-confirmation.ts
new file mode 100644
index 000000000..8883a1b93
--- /dev/null
+++ b/packages/cli/src/prompts/needs-confirmation.ts
@@ -0,0 +1,7 @@
+import { InvalidArgument } from "../errors/errors.js";
+
+export function needsConfirmation(action: string): InvalidArgument {
+ return new InvalidArgument({
+ message: `${action} needs confirmation. Pass --yes to confirm.`,
+ });
+}