@clue-ai/cli 0.0.5 → 0.0.7

package/src/init-tool.mjs

@@ -2,115 +2,132 @@ import { mkdir, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import { buildInitReport, validateInitRequest } from "./contracts.mjs";
 import {
-	applyLifecyclePlan,
-	planLifecycleInsertions,
+  applyLifecyclePlan,
+  planLifecycleInsertions,
 } from "./lifecycle-init.mjs";
 
 const DEFAULT_SEMANTIC_WORKFLOW_PATH =
-	".github/workflows/clue-semantic-snapshot.yml";
+  ".github/workflows/clue-semantic-snapshot.yml";
 
 const nonEmpty = (value, field) => {
-	if (typeof value !== "string" || value.trim() === "") {
-		throw new Error(`${field} is required`);
-	}
-	return value.trim();
+  if (typeof value !== "string" || value.trim() === "") {
+    throw new Error(`${field} is required`);
+  }
+  return value.trim();
 };
 
 const normalizeStringArray = (value, field, { min = 0 } = {}) => {
-	if (!Array.isArray(value)) {
-		throw new Error(`${field} must be an array`);
-	}
-	const result = value
-		.filter((entry) => typeof entry === "string" && entry.trim())
-		.map((entry) => entry.trim());
-	if (result.length < min) {
-		throw new Error(`${field} must include at least ${min} item(s)`);
-	}
-	return [...new Set(result)];
+  if (!Array.isArray(value)) {
+    throw new Error(`${field} must be an array`);
+  }
+  const result = value
+    .filter((entry) => typeof entry === "string" && entry.trim())
+    .map((entry) => entry.trim());
+  if (result.length < min) {
+    throw new Error(`${field} must include at least ${min} item(s)`);
+  }
+  return [...new Set(result)];
 };
 
 const splitCsv = (value) =>
-	typeof value === "string"
-		? value
-				.split(",")
-				.map((entry) => entry.trim())
-				.filter(Boolean)
-		: [];
+  typeof value === "string"
+    ? value
+        .split(",")
+        .map((entry) => entry.trim())
+        .filter(Boolean)
+    : [];
 
 const deriveServiceKeyFromPath = (backendRootPath) => {
-	const segment = backendRootPath
-		.split("/")
-		.map((part) => part.trim())
-		.filter(Boolean)
-		.at(-1);
-	const normalized = segment
-		?.toLowerCase()
-		.replace(/[^a-z0-9_-]+/g, "-")
-		.replace(/^-+|-+$/g, "");
-	if (!normalized) {
-		throw new Error("service-key cannot be derived from backend-root-path");
-	}
-	return normalized;
+  const segment = backendRootPath
+    .split("/")
+    .map((part) => part.trim())
+    .filter(Boolean)
+    .at(-1);
+  const normalized = segment
+    ?.toLowerCase()
+    .replace(/[^a-z0-9_-]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+  if (!normalized) {
+    throw new Error("service-key cannot be derived from backend-root-path");
+  }
+  return normalized;
 };
 
 export const buildSemanticWorkflowRequestFromFlags = (flags) => {
-	const backendRootPath = nonEmpty(flags.backendRootPath, "backend-root-path");
-	const allowedSourcePaths = splitCsv(flags.allowedSourcePaths);
-	return {
-		ci_workflow_path:
-			typeof flags.workflowPath === "string" && flags.workflowPath.trim()
-				? flags.workflowPath.trim()
-				: DEFAULT_SEMANTIC_WORKFLOW_PATH,
-		service_key:
-			typeof flags.serviceKey === "string" && flags.serviceKey.trim()
-				? flags.serviceKey.trim()
-				: deriveServiceKeyFromPath(backendRootPath),
-		framework: nonEmpty(flags.framework, "framework"),
-		allowed_source_paths: normalizeStringArray(
-			allowedSourcePaths.length ? allowedSourcePaths : [backendRootPath],
-			"allowed-source-paths",
-			{ min: 1 },
-		),
-		excluded_source_paths: normalizeStringArray(
-			splitCsv(flags.excludedSourcePaths),
-			"excluded-source-paths",
-		),
-	};
+  const backendRootPath = nonEmpty(flags.backendRootPath, "backend-root-path");
+  const allowedSourcePaths = splitCsv(flags.allowedSourcePaths);
+  const projectKey =
+    typeof flags.projectKey === "string" && flags.projectKey.trim()
+      ? flags.projectKey.trim()
+      : "${{ vars.CLUE_PROJECT_KEY }}";
+  const environment =
+    typeof flags.environment === "string" && flags.environment.trim()
+      ? flags.environment.trim()
+      : "${{ vars.CLUE_ENVIRONMENT }}";
+  const clueApiBaseUrl =
+    typeof flags.clueApiBaseUrl === "string" && flags.clueApiBaseUrl.trim()
+      ? flags.clueApiBaseUrl.trim()
+      : "${{ vars.CLUE_API_BASE_URL }}";
+  return {
+    project_key: projectKey,
+    environment,
+    clue_api_base_url: clueApiBaseUrl,
+    ci_workflow_path:
+      typeof flags.workflowPath === "string" && flags.workflowPath.trim()
+        ? flags.workflowPath.trim()
+        : DEFAULT_SEMANTIC_WORKFLOW_PATH,
+    service_key:
+      typeof flags.serviceKey === "string" && flags.serviceKey.trim()
+        ? flags.serviceKey.trim()
+        : deriveServiceKeyFromPath(backendRootPath),
+    framework: nonEmpty(flags.framework, "framework"),
+    allowed_source_paths: normalizeStringArray(
+      allowedSourcePaths.length ? allowedSourcePaths : [backendRootPath],
+      "allowed-source-paths",
+      { min: 1 },
+    ),
+    excluded_source_paths: normalizeStringArray(
+      splitCsv(flags.excludedSourcePaths),
+      "excluded-source-paths",
+    ),
+  };
 };
 
+const usesGithubVariable = (value) =>
+  typeof value === "string" && value.includes("${{ vars.");
+
 const workflowRequestPayload = (request) =>
-	JSON.stringify(
-		{
-			project_key: "${{ vars.CLUE_PROJECT_KEY }}",
-			environment: "${{ vars.CLUE_ENVIRONMENT }}",
-			service_key: request.service_key,
-			repository: {
-				provider: "github",
-				repository_id: "${{ github.repository_id }}",
-				merge_commit: "${{ github.sha }}",
-				workflow_run_id: "${{ github.run_id }}",
-			},
-			service: {
-				service_key: request.service_key,
-				root_path: request.allowed_source_paths[0],
-				framework: request.framework,
-				language: "python",
-			},
-			allowed_source_paths: request.allowed_source_paths,
-			excluded_source_paths: request.excluded_source_paths,
-			clue_api_base_url: "${{ vars.CLUE_API_BASE_URL }}",
-			ai_model: "${{ vars.CLUE_AI_MODEL }}",
-		},
-		null,
-		10,
-	).trim();
+  JSON.stringify(
+    {
+      project_key: request.project_key ?? "${{ vars.CLUE_PROJECT_KEY }}",
+      environment: request.environment ?? "${{ vars.CLUE_ENVIRONMENT }}",
+      service_key: request.service_key,
+      repository: {
+        provider: "github",
+        repository_id: "${{ github.repository_id }}",
+        merge_commit: "${{ github.sha }}",
+        workflow_run_id: "${{ github.run_id }}",
+      },
+      service: {
+        service_key: request.service_key,
+        framework: request.framework,
+        language: "python",
+      },
+      allowed_source_paths: request.allowed_source_paths,
+      excluded_source_paths: request.excluded_source_paths,
+      clue_api_base_url:
+        request.clue_api_base_url ?? "${{ vars.CLUE_API_BASE_URL }}",
+    },
+    null,
+    10,
+  ).trim();
 
 const indentMultiline = (value, spaces) => {
-	const prefix = " ".repeat(spaces);
-	return value
-		.split("\n")
-		.map((line) => `${prefix}${line}`)
-		.join("\n");
+  const prefix = " ".repeat(spaces);
+  return value
+    .split("\n")
+    .map((line) => `${prefix}${line}`)
+    .join("\n");
 };
 
 const workflowTemplate = (request) => `name: Clue Semantic Snapshot
@@ -135,51 +152,67 @@ jobs:
       - name: Run Clue semantic generation
         env:
           CLUE_API_KEY: \${{ secrets.CLUE_API_KEY }}
-          AI_PROVIDER_API_KEY: \${{ secrets.AI_PROVIDER_API_KEY }}
+          CLUE_AI_PROVIDER_API_KEY: \${{ secrets.CLUE_AI_PROVIDER_API_KEY }}
+          CLUE_AI_PROVIDER: \${{ vars.CLUE_AI_PROVIDER }}
+          CLUE_AI_MODEL: \${{ vars.CLUE_AI_MODEL }}
           CLUE_SEMANTIC_REQUEST_JSON: |
 ${indentMultiline(workflowRequestPayload(request), 12)}
         run: |
-          npx @clue-ai/cli semantic-ci --request-env CLUE_SEMANTIC_REQUEST_JSON --repo .
+          npx @clue-ai/cli semantic-gen --request-env CLUE_SEMANTIC_REQUEST_JSON --repo .
 `;
 
 export const writeSemanticWorkflow = async ({ repoRoot, request }) => {
-	const workflowPath = join(repoRoot, request.ci_workflow_path);
-	await mkdir(dirname(workflowPath), { recursive: true });
-	await writeFile(workflowPath, workflowTemplate(request), "utf8");
-	return {
-		ci_workflow_path: request.ci_workflow_path,
-		ci_workflow_added: true,
-		required_secrets: ["CLUE_API_KEY", "AI_PROVIDER_API_KEY"],
-		required_variables: [
-			"CLUE_PROJECT_KEY",
-			"CLUE_ENVIRONMENT",
-			"CLUE_API_BASE_URL",
-			"CLUE_AI_MODEL",
-		],
-		runtime_request_committed: false,
-		semantic_generation_timing: "after_merge_ci",
-		allowed_source_paths: request.allowed_source_paths,
-		excluded_source_paths: request.excluded_source_paths,
-	};
+  const workflowPath = join(repoRoot, request.ci_workflow_path);
+  await mkdir(dirname(workflowPath), { recursive: true });
+  await writeFile(workflowPath, workflowTemplate(request), "utf8");
+  return {
+    ci_workflow_path: request.ci_workflow_path,
+    ci_workflow_added: true,
+    required_secrets: ["CLUE_API_KEY", "CLUE_AI_PROVIDER_API_KEY"],
+    required_variables: [
+      "CLUE_AI_PROVIDER",
+      "CLUE_AI_MODEL",
+      ...(usesGithubVariable(
+        request.project_key ?? "${{ vars.CLUE_PROJECT_KEY }}",
+      )
+        ? ["CLUE_PROJECT_KEY"]
+        : []),
+      ...(usesGithubVariable(
+        request.environment ?? "${{ vars.CLUE_ENVIRONMENT }}",
+      )
+        ? ["CLUE_ENVIRONMENT"]
+        : []),
+      ...(usesGithubVariable(
+        request.clue_api_base_url ?? "${{ vars.CLUE_API_BASE_URL }}",
+      )
+        ? ["CLUE_API_BASE_URL"]
+        : []),
+    ],
+    runtime_request_committed: false,
+    semantic_generation_timing: "after_merge_ci",
+    allowed_source_paths: request.allowed_source_paths,
+    excluded_source_paths: request.excluded_source_paths,
+  };
 };
 
 export const runInitTool = async ({
-	repoRoot,
-	request: rawRequest,
-	env = process.env,
-	lifecyclePlanner = planLifecycleInsertions,
+  repoRoot,
+  request: rawRequest,
+  env = process.env,
+  lifecyclePlanner = planLifecycleInsertions,
 }) => {
-	const request = validateInitRequest(rawRequest);
-	await writeSemanticWorkflow({ repoRoot, request });
-	const lifecyclePlan = await lifecyclePlanner({ repoRoot, request, env });
-	const lifecycleResult = await applyLifecyclePlan({
-		repoRoot,
-		plan: lifecyclePlan,
-	});
-
-	return buildInitReport({
-		request,
-		lifecycleInsertions: lifecycleResult.lifecycleInsertions,
-		warnings: [...lifecycleResult.warnings],
-	});
+  const request = validateInitRequest(rawRequest);
+  const workflowResult = await writeSemanticWorkflow({ repoRoot, request });
+  const lifecyclePlan = await lifecyclePlanner({ repoRoot, request, env });
+  const lifecycleResult = await applyLifecyclePlan({
+    repoRoot,
+    plan: lifecyclePlan,
+  });
+
+  return buildInitReport({
+    request,
+    lifecycleInsertions: lifecycleResult.lifecycleInsertions,
+    requiredVariables: workflowResult.required_variables,
+    warnings: [...lifecycleResult.warnings],
+  });
 };