@alint-js/agent-codex-cli 0.0.22

package/README.md

@@ -0,0 +1,40 @@
+# `@alint-js/agent-codex-cli`
+
+> [!IMPORTANT]
+> This package is a WIP. APIs may be subject to major changes.
+
+A Codex CLI-backed `AgentAdapter` for alint. It delegates execution to the official
+`@openai/codex-sdk`, which wraps the local `codex` CLI and owns the JSONL event
+protocol.
+
+## What it does
+
+`createCodexCliAdapter()` returns an `AgentAdapter` that starts a Codex thread,
+sends the rule prompt, and maps the SDK run result back to alint's `{ answer,
+usage }` shape. Codex uses its own local configuration, AGENTS instructions,
+sandboxing, MCP servers, and tool runtime.
+
+## How to use
+
+```ts
+import { createCodexCliAdapter } from '@alint-js/agent-codex-cli'
+
+const adapter = createCodexCliAdapter({
+  sandbox: 'read-only',
+})
+```
+
+Pass `{ useRequestModel: true }` only when alint's resolved model should override
+the local Codex model configuration.
+
+## When to use
+
+- You want alint rules to delegate a check to the local Codex CLI environment.
+- You want Codex to decide which of its own tools to use.
+
+## When not to use
+
+- Your rule needs alint `AgentTool` callbacks. This adapter rejects them because
+  Codex CLI does not execute in-process JavaScript tool callbacks.
+- You need direct OpenAI-compatible chat completion calls. Use a structured-output
+  rule or another agent adapter instead.

package/dist/index.d.mts

@@ -0,0 +1,27 @@
+import { CodexOptions, RunResult, SandboxMode, ThreadOptions, TurnOptions } from "@openai/codex-sdk";
+import { AgentAdapter, AgentRequest } from "@alint-js/core/agent";
+
+//#region src/index.d.ts
+interface CodexCliAdapterOptions {
+  additionalDirectories: string[];
+  approvalPolicy: ThreadOptions['approvalPolicy'];
+  codexPath: string;
+  config: NonNullable<CodexOptions['config']>;
+  cwd: string;
+  env: Record<string, string>;
+  outputSchema: NonNullable<TurnOptions['outputSchema']>;
+  run: (request: CodexCliRunRequest) => Promise<RunResult>;
+  sandbox: SandboxMode;
+  skipGitRepoCheck: boolean;
+  useRequestModel: boolean;
+}
+interface CodexCliRunRequest {
+  codexOptions: CodexOptions;
+  input: string;
+  threadOptions: ThreadOptions;
+  turnOptions: TurnOptions;
+}
+declare function createCodexCliAdapter(options?: Partial<CodexCliAdapterOptions>): AgentAdapter;
+declare function createRunRequest(request: AgentRequest, options: Partial<CodexCliAdapterOptions>): CodexCliRunRequest;
+//#endregion
+export { CodexCliAdapterOptions, CodexCliRunRequest, createCodexCliAdapter, createRunRequest };

package/dist/index.mjs

@@ -0,0 +1,53 @@
+import process from "node:process";
+import { Codex } from "@openai/codex-sdk";
+//#region src/index.ts
+function createCodexCliAdapter(options = {}) {
+	const run = options.run ?? runCodexSdk;
+	return async (request) => {
+		if (request.tools.length > 0) throw new TypeError("Codex CLI adapter does not support alint AgentTool callbacks. Codex uses its own local tool runtime.");
+		const result = await run(createRunRequest(request, options));
+		return {
+			answer: result.finalResponse,
+			usage: mapUsage(result.usage)
+		};
+	};
+}
+function createRunRequest(request, options) {
+	const cwd = options.cwd ?? process.cwd();
+	return {
+		codexOptions: {
+			...options.codexPath ? { codexPathOverride: options.codexPath } : {},
+			...options.config ? { config: options.config } : {},
+			...options.env ? { env: options.env } : {}
+		},
+		input: formatPrompt(request),
+		threadOptions: {
+			...options.additionalDirectories ? { additionalDirectories: options.additionalDirectories } : {},
+			...options.approvalPolicy ? { approvalPolicy: options.approvalPolicy } : {},
+			...options.sandbox ? { sandboxMode: options.sandbox } : {},
+			...options.skipGitRepoCheck !== void 0 ? { skipGitRepoCheck: options.skipGitRepoCheck } : {},
+			...options.useRequestModel ? { model: request.model.id } : {},
+			workingDirectory: cwd
+		},
+		turnOptions: {
+			...options.outputSchema ? { outputSchema: options.outputSchema } : {},
+			...request.signal ? { signal: request.signal } : {}
+		}
+	};
+}
+function formatPrompt(request) {
+	return [request.instructions, request.prompt].filter(Boolean).join("\n\n");
+}
+function mapUsage(usage) {
+	if (!usage) return;
+	return {
+		inputTokens: usage.input_tokens,
+		outputTokens: usage.output_tokens,
+		totalTokens: usage.input_tokens + usage.output_tokens
+	};
+}
+async function runCodexSdk(request) {
+	return await new Codex(request.codexOptions).startThread(request.threadOptions).run(request.input, request.turnOptions);
+}
+//#endregion
+export { createCodexCliAdapter, createRunRequest };

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@alint-js/agent-codex-cli",
+  "type": "module",
+  "version": "0.0.22",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@alint-js/core": "0.0.22"
+  },
+  "dependencies": {
+    "@openai/codex-sdk": "^0.144.3"
+  },
+  "devDependencies": {
+    "@alint-js/core": "0.0.22"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run --config vitest.config.ts"
+  }
+}