---
title: "Modules"
search:
  tags:
    - api
    - reference
---


## Classes

### Codemap

Handle for SQL queries and index runs after [createCodemap](#createcodemap).

Each [query](#query) opens the database for that call; [index](#index) manages its own open/close lifecycle.

#### Constructors

##### Constructor

```ts
new Codemap(): Codemap;
```

###### Returns

[`Codemap`](#codemap)

#### Accessors

##### root

###### Get Signature

```ts
get root(): string;
```

Absolute project root (from resolved config).

###### Returns

`string`

##### databasePath

###### Get Signature

```ts
get databasePath(): string;
```

Absolute path to the SQLite index file (e.g. `.codemap/index.db`).

###### Returns

`string`

#### Methods

##### query()

```ts
query(sql): unknown[];
```

Run a read-only SQL statement against the index (same semantics as the CLI `query` subcommand).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `sql` | `string` | Valid SQLite for the Codemap schema. |

###### Returns

`unknown`[]

Result rows from `better-sqlite3`-style `.all()`.

###### Throws

On invalid SQL or database errors (same as `better-sqlite3`).

##### index()

```ts
index(options?): Promise<IndexResult>;
```

Refresh the index: incremental (git-based), full, or targeted file list.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options?` | [`IndexOptions`](#indexoptions) | See [RunIndexOptions](#indexoptions). |

###### Returns

`Promise`\<[`IndexResult`](#indexresult)\>

## Interfaces

### ParseContext

Input for a [LanguageAdapter](#languageadapter). Paths are absolute / project-relative as noted.

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-abspath"></a> `absPath` | `string` | Absolute path on disk (for parsers that need a real `filename`). |
| <a id="property-relpath"></a> `relPath` | `string` | Path relative to project root (stored in DB rows). |
| <a id="property-source"></a> `source` | `string` | - |

***

### LanguageAdapter

Pluggable extractor for a set of file extensions.

#### Remarks

Built-ins: [BUILTIN\_ADAPTERS](#builtin_adapters). Future optional packages can register
additional adapters (or replace built-ins) once a public registration API exists.

#### Properties

| Property | Modifier | Type | Description |
| ------ | ------ | ------ | ------ |
| <a id="property-id"></a> `id` | `readonly` | `string` | - |
| <a id="property-extensions"></a> `extensions` | `readonly` | readonly `string`[] | Extensions with leading dot, e.g. `.ts`, `.tsx`. |

#### Methods

##### parse()

```ts
parse(ctx): ParsedFilePayload;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`ParseContext`](#parsecontext) |

###### Returns

[`ParsedFilePayload`](#parsedfilepayload)

***

### CodemapInitOptions

Options for [createCodemap](#createcodemap).

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-root"></a> `root?` | `string` | Project root. When omitted: `CODEMAP_ROOT` or `CODEMAP_TEST_BENCH`, then `process.cwd()`. |
| <a id="property-configfile"></a> `configFile?` | `string` | Explicit path to `.codemap/config.{ts,js,json}` (same as CLI `--config`). |
| <a id="property-config"></a> `config?` | `object` | Inline overrides merged on top of the file-based config from the project root. |
| `config.root?` | `string` | - |
| `config.databasePath?` | `string` | - |
| `config.include?` | `string`[] | - |
| `config.excludeDirNames?` | `string`[] | - |
| `config.tsconfigPath?` | `string` \| `null` | - |
| `config.fts5?` | `boolean` | - |
| `config.recipeRecency?` | `boolean` | - |
| `config.churn?` | `object` | - |
| `config.churn.halfLifeDays?` | `number` | - |
| `config.churn.since?` | `string` | - |
| `config.churn.file?` | `string` | - |
| `config.synthesis?` | `object` | - |
| `config.synthesis.heuristicCalls?` | `boolean` | - |
| `config.apply?` | `object` | - |
| `config.apply.autoApplyRecipes?` | `string`[] | - |
| `config.boundaries?` | `object`[] | - |

***

### IndexOptions

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-mode"></a> `mode?` | `IndexMode` | Defaults to `incremental`. |
| <a id="property-files"></a> `files?` | `string`[] | Paths relative to the project root; used only when `mode === "files"`. All paths are forwarded as-is; non-standard extensions are indexed as text. |
| <a id="property-quiet"></a> `quiet?` | `boolean` | Suppresses progress logs; parse failures may still be printed. Defaults to `false`. |
| <a id="property-performance"></a> `performance?` | `boolean` | Emits a per-phase timing breakdown and the top-10 slowest files (full rebuild only). Off by default — wired by the CLI's `--performance` flag. |
| <a id="property-commit"></a> `commit?` | `string` | Explicit sha for `meta.last_indexed_commit` — skips `git rev-parse HEAD`. Audit-cache reindex uses this: the cache dir has no `.git` so the shell-out would emit `fatal: not a git repository` and stamp an empty string. |

***

### IndexTableStats

Row counts per table after an index run (mirrors CLI summary output). Keys
use the **SQLite table names** (snake_case: `type_members`, `css_vars`,
`css_classes`, `css_keyframes`) so the same identifiers work directly in
`SELECT … FROM <key>` queries.

#### Extends

- `Record`\<`string`, `number`\>

#### Indexable

```ts
[key: string]: number
```

#### Properties

| Property | Type |
| ------ | ------ |
| <a id="property-files-1"></a> `files` | `number` |
| <a id="property-symbols"></a> `symbols` | `number` |
| <a id="property-imports"></a> `imports` | `number` |
| <a id="property-exports"></a> `exports` | `number` |
| <a id="property-components"></a> `components` | `number` |
| <a id="property-dependencies"></a> `dependencies` | `number` |
| <a id="property-markers"></a> `markers` | `number` |
| <a id="property-type_members"></a> `type_members` | `number` |
| <a id="property-type_heritage"></a> `type_heritage` | `number` |
| <a id="property-calls"></a> `calls` | `number` |
| <a id="property-css_vars"></a> `css_vars` | `number` |
| <a id="property-css_classes"></a> `css_classes` | `number` |
| <a id="property-css_keyframes"></a> `css_keyframes` | `number` |
| <a id="property-scopes"></a> `scopes` | `number` |
| <a id="property-references"></a> `references` | `number` |
| <a id="property-bindings"></a> `bindings` | `number` |
| <a id="property-import_specifiers"></a> `import_specifiers` | `number` |
| <a id="property-function_params"></a> `function_params` | `number` |
| <a id="property-runtime_markers"></a> `runtime_markers` | `number` |
| <a id="property-test_suites"></a> `test_suites` | `number` |
| <a id="property-re_export_chains"></a> `re_export_chains` | `number` |
| <a id="property-module_cycles"></a> `module_cycles` | `number` |
| <a id="property-dynamic_imports"></a> `dynamic_imports` | `number` |
| <a id="property-file_metrics"></a> `file_metrics` | `number` |
| <a id="property-file_churn"></a> `file_churn` | `number` |

***

### IndexRunStats

Per-run counters; see [IndexResult](#indexresult) for the public shape returned from indexing APIs.

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-indexed"></a> `indexed` | `number` | Number of files written or re-indexed in this run. |
| <a id="property-skipped"></a> `skipped` | `number` | Files whose `content_hash` matched the index (no work done). |
| <a id="property-elapsedms"></a> `elapsedMs` | `number` | Wall-clock time for the indexing pipeline, in milliseconds. |
| <a id="property-fullrebuild"></a> `fullRebuild` | `boolean` | `true` if this run dropped and rebuilt all tables; `false` for incremental / targeted. |
| <a id="property-stats"></a> `stats` | [`IndexTableStats`](#indextablestats) | Row counts per table after the run completed. |
| <a id="property-performance-1"></a> `performance?` | `IndexPerformanceReport` | Set only when `--performance` (or `RunIndexOptions.performance`) is on. |

***

### IndexResult

Outcome of `Codemap#index` or `runCodemapIndex` (CLI and programmatic index runs).

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-mode-1"></a> `mode` | `"files"` \| `"full"` \| `"incremental"` | How the index was updated. |
| <a id="property-indexed-1"></a> `indexed` | `number` | Files written or re-indexed in this run. |
| <a id="property-skipped-1"></a> `skipped` | `number` | Files skipped (unchanged hash). |
| <a id="property-elapsedms-1"></a> `elapsedMs` | `number` | Wall-clock time for the indexing pipeline, in milliseconds. |
| <a id="property-stats-1"></a> `stats` | [`IndexTableStats`](#indextablestats) | Row counts per table after the run completed. |
| <a id="property-idle"></a> `idle?` | `boolean` | Set when no file bodies were indexed (already fresh, empty `files` list, or deletions-only pass). |

***

### ResolvedCodemapConfig

Fully resolved config (defaults filled, paths absolute) — stored in the
process-global runtime after init and read for indexing / query / serve.

#### Properties

| Property | Modifier | Type | Description |
| ------ | ------ | ------ | ------ |
| <a id="property-root-1"></a> `root` | `readonly` | `string` | Absolute project root (from CLI `--root`, env, or `process.cwd()`). |
| <a id="property-statedir"></a> `stateDir` | `readonly` | `string` | Absolute path to the codemap state directory (`<root>/.codemap` by default). Overridable via `--state-dir <path>` or `CODEMAP_STATE_DIR`. Holds every codemap-managed file: `index.db` (+ WAL/SHM), `audit-cache/`, `recipes/`, `config.{ts,js,json}`, `.gitignore` (self-managed). |
| <a id="property-databasepath"></a> `databasePath` | `readonly` | `string` | Absolute path to the SQLite database file (default `<stateDir>/index.db`). |
| <a id="property-include"></a> `include` | `readonly` | readonly `string`[] | Glob patterns relative to `root`; either user-supplied or `DEFAULT_INCLUDE_PATTERNS`. |
| <a id="property-excludedirnames"></a> `excludeDirNames` | `readonly` | `ReadonlySet`\<`string`\> | Directory **names** (any segment) to skip — either user-supplied or `DEFAULT_EXCLUDE_DIR_NAMES`. |
| <a id="property-tsconfigpath"></a> `tsconfigPath` | `readonly` | `string` \| `null` | Absolute path to `tsconfig.json` for alias resolution, or `null` to disable. |
| <a id="property-fts5"></a> `fts5` | `readonly` | `boolean` | FTS5 full-text indexing toggle. `true` populates the `source_fts` virtual table at index time; `false` (default) leaves it empty. Resolved from `.codemap/config.ts` `fts5` plus the `--with-fts` CLI flag; CLI wins. |
| <a id="property-reciperecency"></a> `recipeRecency` | `readonly` | `boolean` | Recipe-recency tracking toggle. `true` (default) populates the `recipe_recency` table on every successful recipe run and inlines `last_run_at` / `run_count` on `--recipes-json` reads. `false` short-circuits every write — no rows ever land. Local-only — no upload primitive. |
| <a id="property-boundaries"></a> `boundaries` | `readonly` | readonly `object`[] | Reconciled into the `boundary_rules` table on every index pass. The bundled `boundary-violations` recipe joins this against `dependencies` via SQLite GLOB. |
| <a id="property-churn"></a> `churn` | `readonly` | `object` | Git churn ingest tuning for `file_churn`. |
| `churn.halfLifeDays` | `readonly` | `number` | - |
| `churn.since` | `readonly` | `string` \| `null` | When set, only commits after this git ref are counted. |
| `churn.file` | `readonly` | `string` \| `null` | Optional JSON churn import when git is unavailable. |
| <a id="property-synthesis"></a> `synthesis` | `readonly` | `object` | When `heuristicCalls` is true, runs callback-synthesis after `resolveCalls`. |
| `synthesis.heuristicCalls` | `readonly` | `boolean` | - |
| <a id="property-applyautoapplyrecipes"></a> `applyAutoApplyRecipes` | `readonly` | readonly `string`[] \| `undefined` | When non-empty, `codemap apply --yes <recipe>` requires the recipe id to appear here unless `--force` is passed. |

***

### ParsedFile

One indexed file's extracted data; workers return arrays of these and
`LanguageAdapter`s populate a [ParsedFilePayload](#parsedfilepayload) subset.

#### Properties

| Property | Type | Description |
| ------ | ------ | ------ |
| <a id="property-relpath-1"></a> `relPath` | `string` | Path relative to project root. |
| <a id="property-error"></a> `error?` | `boolean` | `true` when the file couldn't be read from disk (distinct from `parseError`). |
| <a id="property-parseerror"></a> `parseError?` | `string` | Parser threw but the file was read; the `files` row is still inserted. |
| <a id="property-filerow"></a> `fileRow` | `FileRow` | - |
| <a id="property-category"></a> `category` | `"ts"` \| `"css"` \| `"text"` | Extraction path: `ts` (oxc), `css` (lightningcss), or `text` (markers-only). |
| <a id="property-parsems"></a> `parseMs?` | `number` | Worker-side parse wall-clock; surfaced by `--performance`. |
| <a id="property-symbols-1"></a> `symbols?` | `SymbolRow`[] | - |
| <a id="property-imports-1"></a> `imports?` | `ImportRow`[] | - |
| <a id="property-importspecifiers"></a> `importSpecifiers?` | `ImportSpecifierRow`[] | - |
| <a id="property-exports-1"></a> `exports?` | `ExportRow`[] | - |
| <a id="property-components-1"></a> `components?` | `ComponentRow`[] | - |
| <a id="property-markers-1"></a> `markers?` | `MarkerRow`[] | - |
| <a id="property-suppressions"></a> `suppressions?` | `SuppressionRow`[] | - |
| <a id="property-typemembers"></a> `typeMembers?` | `TypeMemberRow`[] | - |
| <a id="property-typeheritage"></a> `typeHeritage?` | `TypeHeritageRow`[] | - |
| <a id="property-calls-1"></a> `calls?` | `CallRow`[] | - |
| <a id="property-scopes-1"></a> `scopes?` | `ScopeRow`[] | - |
| <a id="property-references-1"></a> `references?` | `ReferenceRow`[] | - |
| <a id="property-filemetrics"></a> `fileMetrics?` | `FileMetricsRow` | - |
| <a id="property-functionparams"></a> `functionParams?` | `FunctionParamRow`[] | - |
| <a id="property-runtimemarkers"></a> `runtimeMarkers?` | `RuntimeMarkerRow`[] | - |
| <a id="property-testsuites"></a> `testSuites?` | `TestSuiteRow`[] | - |
| <a id="property-dynamicimports"></a> `dynamicImports?` | `DynamicImportRow`[] | - |
| <a id="property-jsxelements"></a> `jsxElements?` | `ParsedJsxElement`[] | - |
| <a id="property-jsxattributes"></a> `jsxAttributes?` | `ParsedJsxAttribute`[] | - |
| <a id="property-asynccalls"></a> `asyncCalls?` | `ParsedAsyncCall`[] | - |
| <a id="property-trycatchrows"></a> `tryCatchRows?` | `ParsedTryCatch`[] | - |
| <a id="property-decorators"></a> `decorators?` | `ParsedDecorator`[] | - |
| <a id="property-jsdoctags"></a> `jsdocTags?` | `ParsedJsdocTag`[] | - |
| <a id="property-hassideeffects"></a> `hasSideEffects?` | `number` | - |
| <a id="property-cssvariables"></a> `cssVariables?` | `CssVariableRow`[] | CSS-only fields (populated when `category === "css"`). |
| <a id="property-cssclasses"></a> `cssClasses?` | `CssClassRow`[] | - |
| <a id="property-csskeyframes"></a> `cssKeyframes?` | `CssKeyframeRow`[] | - |
| <a id="property-cssimportsources"></a> `cssImportSources?` | `string`[] | Raw `@import` strings; main thread converts these to `imports` rows. |
| <a id="property-content"></a> `content?` | `string` | Verbatim file source — populated by the worker only when `WorkerInput.fts5Enabled`; indexer writes to `source_fts`. Default-OFF keeps worker→main serialization cost zero. |

***

### CodemapDatabase

Minimal SQLite surface used by Codemap — implemented for `bun:sqlite` and
`better-sqlite3` (sync APIs, transactions, PRAGMAs).

#### Methods

##### run()

```ts
run(sql, params?): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `sql` | `string` |
| `params?` | `BindValues` |

###### Returns

`void`

##### query()

```ts
query<T>(sql): object;
```

###### Type Parameters

| Type Parameter |
| ------ |
| <a id="type-parameter-t"></a> `T` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `sql` | `string` |

###### Returns

`object`

| Name | Type |
| ------ | ------ |
| `get()` | (...`params`) => `T` \| `undefined` |
| `all()` | (...`params`) => `T`[] |

##### transaction()

```ts
transaction<T>(fn): () => T;
```

Returns a function that runs the transaction when invoked (Bun / better-sqlite3 semantics).

###### Type Parameters

| Type Parameter |
| ------ |
| <a id="type-parameter-t-1"></a> `T` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn` | () => `T` |

###### Returns

() => `T`

##### close()

```ts
close(): void;
```

###### Returns

`void`

## Type Aliases

### ParsedFilePayload

```ts
type ParsedFilePayload = Pick<ParsedFile, 
  | "category"
  | "symbols"
  | "imports"
  | "exports"
  | "components"
  | "markers"
  | "suppressions"
  | "typeMembers"
  | "typeHeritage"
  | "calls"
  | "importSpecifiers"
  | "scopes"
  | "references"
  | "fileMetrics"
  | "functionParams"
  | "runtimeMarkers"
  | "testSuites"
  | "dynamicImports"
  | "hasSideEffects"
  | "jsxElements"
  | "jsxAttributes"
  | "asyncCalls"
  | "tryCatchRows"
  | "decorators"
  | "jsdocTags"
  | "cssVariables"
  | "cssClasses"
  | "cssKeyframes"
  | "cssImportSources"
| "parseError">;
```

Partial parse result merged into [ParsedFile](#parsedfile) after `fileRow` is built.
Set `parseError` when extraction fails but the file should still be indexed.

***

### CodemapUserConfig

```ts
type CodemapUserConfig = z.infer<typeof codemapUserConfigSchema>;
```

Inferred from [codemapUserConfigSchema](#codemapuserconfigschema).

## Variables

### BUILTIN\_ADAPTERS

```ts
const BUILTIN_ADAPTERS: readonly LanguageAdapter[];
```

Built-in adapters (oxc TS/JS, Lightning CSS, text/markers). Order matters for the first match.

***

### codemapUserConfigSchema

```ts
const codemapUserConfigSchema: ZodObject<{
  root: ZodOptional<ZodString>;
  databasePath: ZodOptional<ZodString>;
  include: ZodOptional<ZodArray<ZodString>>;
  excludeDirNames: ZodOptional<ZodArray<ZodString>>;
  tsconfigPath: ZodOptional<ZodUnion<readonly [ZodString, ZodNull]>>;
  fts5: ZodOptional<ZodBoolean>;
  recipeRecency: ZodOptional<ZodBoolean>;
  churn: ZodOptional<ZodObject<{
     halfLifeDays: ZodOptional<ZodNumber>;
     since: ZodOptional<ZodString>;
     file: ZodOptional<ZodString>;
  }, $strict>>;
  synthesis: ZodOptional<ZodObject<{
     heuristicCalls: ZodOptional<ZodBoolean>;
  }, $strict>>;
  apply: ZodOptional<ZodObject<{
     autoApplyRecipes: ZodOptional<ZodArray<ZodString>>;
  }, $strict>>;
  boundaries: ZodOptional<ZodArray<ZodObject<{
     name: ZodString;
     from_glob: ZodString;
     to_glob: ZodString;
     action: ZodOptional<ZodEnum<{
        allow: "allow";
        deny: "deny";
     }>>;
  }, $strict>>>;
}, $strict>;
```

Zod schema for user config (`<state-dir>/config.{ts,js,json}`, `defineConfig`, API).
Unknown keys are rejected (`.strict()`).

***

### CODEMAP\_VERSION

```ts
const CODEMAP_VERSION: string = packageJson.version;
```

Package version from `package.json` (inlined at build time).

## Functions

### getAdapterForExtension()

```ts
function getAdapterForExtension(ext, adapters?): 
  | LanguageAdapter
  | undefined;
```

First-match adapter lookup by file extension. `ext` must include the
leading dot (`.tsx`); returns `undefined` when nothing matches (the
indexer then falls back to markers-only text).

#### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `ext` | `string` | `undefined` |
| `adapters?` | readonly [`LanguageAdapter`](#languageadapter)[] | `BUILTIN_ADAPTERS` |

#### Returns

  \| [`LanguageAdapter`](#languageadapter)
  \| `undefined`

***

### createCodemap()

```ts
function createCodemap(options?): Promise<Codemap>;
```

Programmatic entry point: loads config, initializes the process runtime, configures the import resolver,
and returns a [Codemap](#codemap) handle.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | [`CodemapInitOptions`](#codemapinitoptions) |

#### Returns

`Promise`\<[`Codemap`](#codemap)\>

#### Remarks

One project root per process: a second `createCodemap()` with a different `root` throws.
Re-initializing the same root is allowed. Audit `--base` worktree reindex is the only
production path that may temporarily switch roots.

Invalid project config (unknown keys, wrong types) throws at load time via the same
schema as [parseCodemapUserConfig](#parsecodemapuserconfig).

***

### runCodemapIndex()

```ts
function runCodemapIndex(db, options?): Promise<IndexResult>;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `db` | [`CodemapDatabase`](#codemapdatabase) |
| `options?` | [`IndexOptions`](#indexoptions) |

#### Returns

`Promise`\<[`IndexResult`](#indexresult)\>

***

### parseCodemapUserConfig()

```ts
function parseCodemapUserConfig(config): object;
```

Runtime validation for [CodemapUserConfig](#codemapuserconfig) (from JSON, `defineConfig`, or API).

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | `unknown` |

#### Returns

`object`

| Name | Type |
| ------ | ------ |
| `root?` | `string` |
| `databasePath?` | `string` |
| `include?` | `string`[] |
| `excludeDirNames?` | `string`[] |
| `tsconfigPath?` | `string` \| `null` |
| `fts5?` | `boolean` |
| `recipeRecency?` | `boolean` |
| `churn?` | `object` |
| `churn.halfLifeDays?` | `number` |
| `churn.since?` | `string` |
| `churn.file?` | `string` |
| `synthesis?` | `object` |
| `synthesis.heuristicCalls?` | `boolean` |
| `apply?` | `object` |
| `apply.autoApplyRecipes?` | `string`[] |
| `boundaries?` | `object`[] |

#### Throws

TypeError when the shape is invalid or unknown keys are present.

***

### defineConfig()

```ts
function defineConfig(config): object;
```

Helper for `export default defineConfig({ ... })` in `.codemap/config.ts`.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | \{ `root?`: `string`; `databasePath?`: `string`; `include?`: `string`[]; `excludeDirNames?`: `string`[]; `tsconfigPath?`: `string` \| `null`; `fts5?`: `boolean`; `recipeRecency?`: `boolean`; `churn?`: \{ `halfLifeDays?`: `number`; `since?`: `string`; `file?`: `string`; \}; `synthesis?`: \{ `heuristicCalls?`: `boolean`; \}; `apply?`: \{ `autoApplyRecipes?`: `string`[]; \}; `boundaries?`: `object`[]; \} |
| `config.root?` | `string` |
| `config.databasePath?` | `string` |
| `config.include?` | `string`[] |
| `config.excludeDirNames?` | `string`[] |
| `config.tsconfigPath?` | `string` \| `null` |
| `config.fts5?` | `boolean` |
| `config.recipeRecency?` | `boolean` |
| `config.churn?` | \{ `halfLifeDays?`: `number`; `since?`: `string`; `file?`: `string`; \} |
| `config.churn.halfLifeDays?` | `number` |
| `config.churn.since?` | `string` |
| `config.churn.file?` | `string` |
| `config.synthesis?` | \{ `heuristicCalls?`: `boolean`; \} |
| `config.synthesis.heuristicCalls?` | `boolean` |
| `config.apply?` | \{ `autoApplyRecipes?`: `string`[]; \} |
| `config.apply.autoApplyRecipes?` | `string`[] |
| `config.boundaries?` | `object`[] |

#### Returns

`object`

| Name | Type |
| ------ | ------ |
| `root?` | `string` |
| `databasePath?` | `string` |
| `include?` | `string`[] |
| `excludeDirNames?` | `string`[] |
| `tsconfigPath?` | `string` \| `null` |
| `fts5?` | `boolean` |
| `recipeRecency?` | `boolean` |
| `churn?` | `object` |
| `churn.halfLifeDays?` | `number` |
| `churn.since?` | `string` |
| `churn.file?` | `string` |
| `synthesis?` | `object` |
| `synthesis.heuristicCalls?` | `boolean` |
| `apply?` | `object` |
| `apply.autoApplyRecipes?` | `string`[] |
| `boundaries?` | `object`[] |
