Class IssuesFinder

Namespace

CodeStage.Maintainer.Issues

Assembly

Build.dll

Allows to find issues in your Unity project. See readme for details.

public static class IssuesFinder

Inheritance

object

IssuesFinder

Methods

SearchAndReport()

Starts issues search and generates report. Maintainer window is not shown. Useful when you wish to integrate Maintainer in your build pipeline.

public static string SearchAndReport()

Returns

string

Issues report, similar to the exported report from the Maintainer window.

StartFix(IssueRecord[], bool, bool)

Starts fix of the issues found with StartSearch() method.

public static IssueRecord[] StartFix(IssueRecord[] recordsToFix = null, bool showResults = true, bool showConfirmation = true)

Parameters

recordsToFix IssueRecord[]

Pass records you wish to fix here or leave null to let it load last search results.

showResults bool

Shows results in the Maintainer window if true.

showConfirmation bool

Shows confirmation dialog before performing fix if true.

Returns

IssueRecord[]

Array of IssueRecords which were fixed up.

StartSearch(bool)

Starts search with current settings.

public static IssueRecord[] StartSearch(bool showResults)

Parameters

showResults bool

Shows results in the Maintainer window if true.

Returns

IssueRecord[]

Array of IssueRecords in case you wish to manually iterate over them and make custom report.

StartSearchInOpenedScenes(bool)

Starts issues search in opened scenes excluding file assets and project settings.

public static IssueRecord[] StartSearchInOpenedScenes(bool showResults)

Parameters

showResults bool

Shows results in the Maintainer window if true.

Returns

IssueRecord[]

Array of IssueRecords in case you wish to manually iterate over them and make custom report.

StartSearchInPath(string, bool, bool)

Starts issues search in the specified path only (file or folder).

public static IssueRecord[] StartSearchInPath(string path, bool showResults, bool includeSubfolders = true)

Parameters

path string

The path to scan (e.g., "Assets/MyFolder", "Assets/MyScript.cs", or "Packages/com.test.package")

showResults bool

Shows results in the Maintainer window if true.

includeSubfolders bool

If true, scans subfolders; if false, only scans direct children (default: true). Only applies to folder paths.

Returns

IssueRecord[]

Array of IssueRecords in case you wish to manually iterate over them and make custom report.

Remarks

Changes issues search settings to scan only the specified path and calls StartSearch() after that. Automatically detects whether the path is a file or folder and applies appropriate filtering. For folders, includes scenes in the specified path but excludes build scenes. All original settings are restored after the scan completes.

StartSearchInPaths(string[], bool, bool)

Starts issues search in the specified paths only (files or folders).

public static IssueRecord[] StartSearchInPaths(string[] paths, bool showResults, bool includeSubfolders = true)

Parameters

paths string[]

The paths to scan (e.g., ["Assets/MyFolder", "Assets/MyScript.cs", "Packages/com.test.package"])

showResults bool

Shows results in the Maintainer window if true.

includeSubfolders bool

If true, scans subfolders; if false, only scans direct children (default: true). Only applies to folder paths.

Returns

IssueRecord[]

Array of IssueRecords in case you wish to manually iterate over them and make custom report.

Remarks

Changes issues search settings to scan only the specified paths and calls StartSearch() after that. Automatically detects whether each path is a file or folder and applies appropriate filtering. For folders, includes scenes in the specified paths but excludes build scenes. All original settings are restored after the scan completes. More efficient than calling StartSearchInPath multiple times as it performs a single scan operation.