Skip to content

OverExposureFinding

A single over-exposed declaration.

Import:

import type { OverExposureFinding } from 'obsidian-dev-utils/script-utils/linters/over-exposure';

Signature:

export interface OverExposureFinding

Properties

PropertyTypeDescription
columnnumber1-based column of the declaration's name.
currentExposureCurrentExposureThe current exposure level.
filePathstringAbsolute path of the file declaring the symbol.
hasNoReferencesbooleantrue when the declaration has no references at all (besides itself).
isForcedByTestOnlybooleantrue when the declaration would qualify for a tighter exposure if not for references coming exclusively from test files — i.e. it is exposed purely for testability.
isMemberbooleantrue for a class member, false for a top-level export.
linenumber1-based line of the declaration's name.
namestringThe declared name.
skipReasonnull | OverExposureSkipReasonIn a fix run, why this finding was left untouched instead of tightened; null when it was fixed or when the analysis only reported (shouldFix off).
suggestedExposureSuggestedExposureThe exposure the declaration could be tightened to.
wasFixedbooleantrue when a fix run tightened this declaration in place. Always false in a report run.

Links to this page: