shiplightai 0.1.84 → 0.1.85

package/dist/index.d.ts

@@ -12,7 +12,12 @@ export { configureSdk } from './config.js';
  */
 
 interface ShiplightOptions {
-    /** Directory to scan for .test.yaml files (defaults to cwd) */
+    /**
+     * Directory to scan for .test.yaml files. Defaults to SHIPLIGHT_PROJECT_ROOT
+     * (set by `shiplight test`, honoring -c/--config), else process.cwd(). When
+     * invoking `playwright test` directly with `-c` pointing at a config outside
+     * the cwd, pass scanDir explicitly to anchor the scan to your config directory.
+     */
     scanDir?: string;
     /** Load .env file automatically (default: true). Set to false if you manage env vars yourself. */
     dotenv?: boolean;
@@ -29,23 +34,6 @@ interface ShiplightUseOptions {
         sensitive?: boolean;
     }>;
 }
-/**
- * Transpile all .test.yaml files and return a partial Playwright config.
- *
- * Generated files use the `.yaml.spec.ts` extension, which is matched by
- * Playwright's default `testMatch` pattern. If you override `testMatch` in
- * your config, make sure it includes `*.yaml.spec.ts` (or `*.spec.ts`).
- *
- * Usage in playwright.config.ts:
- * ```ts
- * import { defineConfig, shiplightConfig } from 'shiplightai';
- *
- * export default defineConfig({
- *   ...shiplightConfig(),
- *   testDir: './tests',
- * });
- * ```
- */
 declare function shiplightConfig(options?: ShiplightOptions): PlaywrightTestConfig<ShiplightUseOptions>;
 /**
  * Typed wrapper around Playwright's `defineConfig` that understands Shiplight's