ApiIntegrationConfig

Defined in: packages/core/src/types.ts:470

Properties

clientPackages?

optional clientPackages: string[]

Defined in: packages/core/src/types.ts:477

Package names to scan for API client imports. These should match the import paths used in your code.

Examples

["@/api/generated"]

["@company/backend-client", "@company/auth-client"]

---

extractApiName()?

optional extractApiName: (importName) => string

Defined in: packages/core/src/types.ts:485

Optional transform function to convert import name to dependsOn format. If not provided, the import name is used as-is.

Parameters

importName

string

Returns

string

Examples

(name) => name.replace(/^use/, "")

(name) => `API.${name}`

---

openapi?

optional openapi: OpenApiConfig

Defined in: packages/core/src/types.ts:493

OpenAPI specification configuration for validating dependsOn references. When configured, screenbook lint will validate that dependsOn values match operationIds or HTTP method + path from the OpenAPI spec.

Example

{ sources: ["./openapi.yaml"] }