feat(ai): introduce vercel ai sdk support (#316)

Resolves #291

* Integrate [Vercel AI SDK](https://sdk.vercel.ai/docs/introduction)
* Improved logging
* New config structure

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Razvan Marescu <[email protected]>

Author: 3 people

README.md

@@ -33,6 +33,7 @@ npx @antiwork/shortest init
 ```
 
 This will:
+
 - Automatically install the `@antiwork/shortest` package as a dev dependency if it is not already installed
 - Create a default `shortest.config.ts` file with boilerplate configuration
 - Generate a `.env.local` file (unless present) with placeholders for required environment variables, such as `ANTHROPIC_API_KEY`
@@ -49,9 +50,12 @@ export default {
   headless: false,
   baseUrl: "http://localhost:3000",
   testPattern: "**/*.test.ts",
-  anthropicKey: process.env.ANTHROPIC_API_KEY,
+  ai: {
+    provider: "anthropic",
+  },
 } satisfies ShortestConfig;
 ```
+Anthropic API key will default to `SHORTEST_ANTHROPIC_API_KEY` / `ANTHROPIC_API_KEY` environment variables. Can be overwritten via `ai.config.apiKey`.
 
 2. Create test files using the pattern specified in the config: `app/login.test.ts`
 
@@ -245,12 +249,14 @@ This guide will help you set up the Shortest web app for local development.
 ### Getting started
 
 1. Clone the repository:
+
 ```bash
 git clone https://github.com/anti-work/shortest.git
 cd shortest
 ```
 
 2. Install dependencies:
+
 ```bash
 npm install -g pnpm
 pnpm install
@@ -335,6 +341,7 @@ You'll need to set up the following services for local development. If you're no
 <summary>GitHub OAuth</summary>
 
 1. Create a GitHub OAuth App:
+
    - Go to your GitHub account settings.
    - Navigate to `Developer settings` > `OAuth Apps` > `New OAuth App`.
    - Fill in the application details:
@@ -349,7 +356,7 @@ You'll need to set up the following services for local development. If you're no
    - Select `Use custom credentials`
    - Enter your `Client ID` and `Client Secret` from the GitHub OAuth app you just created.
    - Add `repo` to the `Scopes`
-   ![Clerk Custom Credentials](https://github.com/user-attachments/assets/31d414e1-4e1e-4725-8649-ec1826c6e53e)
+     ![Clerk Custom Credentials](https://github.com/user-attachments/assets/31d414e1-4e1e-4725-8649-ec1826c6e53e)
 
 </details>
 

lib/config/index.ts

@@ -11,6 +11,13 @@ const CONFIG_FILE_PATH = "shortest.yml";
 
 let config: Readonly<Config> = Object.freeze({});
 
+/**
+ * Loads configuration file.
+ *
+ * @throws {Error} When configuration file cannot be parsed
+ *
+ * @private
+ */
 async function loadConfig(): Promise<void> {
   try {
     const fileContents = await fs.readFile(CONFIG_FILE_PATH, "utf8");
@@ -37,14 +44,32 @@ async function loadConfig(): Promise<void> {
   }
 }
 
-async function getConfig(): Promise<Readonly<Config>> {
+/**
+ * Returns the current configuration, loading it if necessary.
+ *
+ * @returns {Promise<Readonly<Config>>} Frozen configuration object
+ * @throws {Error} When configuration cannot be loaded
+ *
+ * @private
+ */
+export async function getConfig(): Promise<Readonly<Config>> {
   if (Object.keys(config).length === 0) {
     await loadConfig();
   }
   return config;
 }
 
-async function getRepoConfig({
+/**
+ * Gets repository-specific configuration.
+ *
+ * @param {Object} params - Repository parameters
+ * @param {string} params.owner - Repository owner
+ * @param {string} params.repo - Repository name
+ * @returns {Promise<RepositoryConfig>} Repository configuration
+ *
+ * @private
+ */
+export async function getRepoConfig({
   owner,
   repo,
 }: {
@@ -58,7 +83,17 @@ async function getRepoConfig({
   );
 }
 
-async function getTestPatternsConfig({
+/**
+ * Gets test patterns configuration for a repository.
+ *
+ * @param {Object} params - Repository parameters
+ * @param {string} params.owner - Repository owner
+ * @param {string} params.repo - Repository name
+ * @returns {Promise<RepositoryConfig["test_patterns"]>} Test patterns configuration
+ *
+ * @private
+ */
+export async function getTestPatternsConfig({
   owner,
   repo,
 }: {
@@ -68,10 +103,3 @@ async function getTestPatternsConfig({
   const repoConfig = await getRepoConfig({ owner, repo });
   return repoConfig.test_patterns;
 }
-
-export { getConfig, getRepoConfig, getTestPatternsConfig };
-
-// Add this export for testing
-export function _resetConfigForTesting(): void {
-  config = Object.freeze({});
-}

packages/shortest/README.md

@@ -3,6 +3,7 @@
 AI-powered natural language end-to-end testing framework.
 
 ## Features
+
 - Natural language test writing
 - AI-powered test execution using Claude computer use API
 - Built on Playwright
@@ -19,9 +20,11 @@ npx @antiwork/shortest init
 ```
 
 This will:
+
 - Automatically install the `@antiwork/shortest` package as a dev dependency if it is not already installed
 - Create a default `shortest.config.ts` file with boilerplate configuration
-- Generate a `.env.local` file (unless present) with placeholders for required environment variables, such as `ANTHROPIC_API_KEY`
+- Generate a `.env.local` file (unless present) with placeholders for required environment variables, such as
+  `SHORTEST_ANTHROPIC_API_KEY` or `ANTHROPIC_API_KEY`
 - Add `.env.local` and `.shortest/` to `.gitignore`
 
 ### Quick start
@@ -35,9 +38,13 @@ export default {
   headless: false,
   baseUrl: "http://localhost:3000",
   testPattern: "**/*.test.ts",
-  anthropicKey: process.env.ANTHROPIC_API_KEY,
+  ai: {
+    provider: "anthropic",
+  },
 } satisfies ShortestConfig;
 ```
+Anthropic API key will default to `SHORTEST_ANTHROPIC_API_KEY` / `ANTHROPIC_API_KEY` environment variables. Can be overwritten via `ai.config.apiKey`.
+
 
 2. Create test files using the pattern specified in the config: `app/login.test.ts`
 
@@ -217,11 +224,13 @@ GITHUB_TOTP_SECRET=your_secret  # Only for GitHub auth tests
 You can run Shortest in your CI/CD pipeline by running tests in headless mode. Make sure to add your Anthropic API key to your CI/CD pipeline secrets.
 
 ## Resources
-* Visit [GitHub](https://github.com/anti-work/shortest) for detailed docs
-* [Contributing guide](./CONTRIBUTING.md)
-* [Changelog](https://github.com/anti-work/shortest/releases)
+
+- Visit [GitHub](https://github.com/anti-work/shortest) for detailed docs
+- [Contributing guide](./CONTRIBUTING.md)
+- [Changelog](https://github.com/anti-work/shortest/releases)
 
 ### Prerequisites
+
 - React >=19.0.0 (if using with Next.js 14+ or Server Actions)
 - Next.js >=14.0.0 (if using Server Components/Actions)
 

packages/shortest/package.json

@@ -27,10 +27,10 @@
     "prepare": "pnpm build",
     "prepublishOnly": "pnpm build",
     "postinstall": "node -e \"if (process.platform !== 'win32') { try { require('child_process').execSync('chmod +x dist/cli/bin.js') } catch (_) {} }\"",
-    "build:types": "tsup src/index.ts  --dts-only --format esm --outDir dist",
-    "build:js": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --external:esbuild --external:punycode --external:playwright --external:@anthropic-ai/sdk --external:expect --external:dotenv",
-    "build:cjs": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/index.cjs --external:esbuild --external:punycode --external:playwright --external:@anthropic-ai/sdk --external:expect --external:dotenv",
-    "build:cli": "esbuild src/cli/bin.ts --bundle --platform=node --format=esm --outdir=dist/cli --metafile=dist/meta-cli.json --external:fsevents --external:chokidar --external:glob --external:esbuild --external:events --external:path --external:fs --external:util --external:stream --external:os --external:assert --external:url --external:playwright --external:@anthropic-ai/sdk --external:expect --external:dotenv --external:otplib --external:picocolors --external:punycode --external:https --external:http --external:net --external:tls --external:crypto --external:mailosaur",
+    "build:types": "tsup src/index.ts --dts-only --format esm --outDir dist",
+    "build:js": "esbuild src/index.ts --bundle --platform=node --format=esm --outfile=dist/index.js --external:esbuild --external:punycode --external:playwright --external:expect --external:dotenv --external:ai --external:@ai-sdk/*",
+    "build:cjs": "esbuild src/index.ts --bundle --platform=node --format=cjs --outfile=dist/index.cjs --external:esbuild --external:punycode --external:playwright --external:expect --external:dotenv --external:ai --external:@ai-sdk/*",
+    "build:cli": "esbuild src/cli/bin.ts --bundle --platform=node --format=esm --outdir=dist/cli --metafile=dist/meta-cli.json --external:fsevents --external:chokidar --external:glob --external:esbuild --external:events --external:path --external:fs --external:util --external:stream --external:os --external:assert --external:url --external:playwright --external:expect --external:dotenv --external:otplib --external:picocolors --external:punycode --external:https --external:http --external:net --external:tls --external:crypto --external:mailosaur --external:ai --external:@ai-sdk/*",
     "dev": "pnpm build --watch",
     "test:unit": "npx vitest run",
     "test:unit:watch": "npx vitest --watch",
@@ -57,7 +57,9 @@
     "node": ">=18"
   },
   "peerDependencies": {
-    "@anthropic-ai/sdk": "^0.32.0",
+    "@ai-sdk/anthropic": "^1.1.8",
+    "@ai-sdk/provider": "^1.0.7",
+    "ai": "^3.4.0",
     "dotenv": "^16.4.5",
     "esbuild": "^0.20.1",
     "expect": "^29.7.0",