FindOverExposureParams
Parameters for findOverExposure.
Import:
import type { FindOverExposureParams } from 'obsidian-dev-utils/script-utils/linters/over-exposure';Signature:
export interface FindOverExposureParamsProperties
| Property | Type | Description |
|---|---|---|
| projectFolder | string | Absolute path to the project root (the folder containing tsconfig.json and src). |
| shouldFix? | boolean | undefined | When true, fixable findings are tightened in place on disk (the export keyword is dropped, or a private / protected modifier is inserted/replaced). When false or omitted, the project is only analyzed. |
| shouldForce? | boolean | undefined | When true (only meaningful together with shouldFix), declarations held wide purely by test references are tightened too, instead of being skipped. Decorated members and exports shared with a still-exported sibling stay skipped regardless. Forwarded to analyzeOverExposure. |
Methods
| Method | Returns | Description |
|---|---|---|
| onProgress(this, progress) | void | Optional callback invoked once per analyzed source file, for live progress reporting. Forwarded to analyzeOverExposure. |
Links to this page: