Class DetectorAbstract

constructor

• new Detector(ctx): Detector

• Parameters

  • ctx: MistiContext

  Returns Detector

Readonlyctx

id

• get id(): string

• Gets the short identifier of the detector, used in analyzer warnings.

  Returns string

  The unique identifier of the detector.

Abstractkind

• get kind(): DetectorKind

• Gets the kind of the detector.

  Returns DetectorKind

shareImportedWarnings

• get shareImportedWarnings(): WarningsBehavior

• Defines the behavior of warnings generated by this detector when working with multiple projects within a single Tact configuration.

  Here are the available options:

  1. "union" Leave this value if you don't care about warnings generated in other projects.
  2. "intersect" If the warning is generated for some source location of the imported file, it should be generated by each of the projects. Example: Constants from an imported file should not be reported iff they are unused in all the projects, so you need "intersect".

  Returns WarningsBehavior

usesSouffle

• get usesSouffle(): boolean

• Checks whether this detector needs the Soufflé binary to be executed.

  Returns boolean

Abstractcheck

• check(cu): Promise<Warning[]>

• Executes the detector's logic to check for issues within the provided compilation unit.

  Parameters

  • cu: CompilationUnit

    The compilation unit to be analyzed.

  Returns Promise<Warning[]>

  List of warnings has highlighted by this detector.

getCategory

• getCategory(): undefined | Category[]

• Returns the category of generated warnings if specified.

  Returns undefined | Category[]

getSeverity

• getSeverity(): {
      max: Severity;
      min: Severity;
  }

• Returns minimum and maximum severities of generated warnings.

  Returns {
      max: Severity;
      min: Severity;
  }

  • max: Severity

  • min: Severity