// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

namespace Microsoft.CodeAnalysis.SolutionCrawler;

internal enum BackgroundAnalysisScope
{
    // NOTE: Do not change existing field ordering/values as this scope is saved as a user option,
    //       and that would break users who have saved a non-default scope for the option.

    /// <summary>
    /// Analyzers are computed for visible documents
    /// and open documents which had errors/warnings in the prior solution snapshot.
    /// We want to analyze such non-visible, open documents to ensure that these
    /// prior reported errors/warnings get cleared out from the error list if they are
    /// no longer valid in the latest solution snapshot, hence ensuring error list has
    /// no stale entries.
    /// </summary>
    VisibleFilesAndOpenFilesWithPreviouslyReportedDiagnostics = 0,

    /// <summary>
    /// Analyzers are executed for all open documents.
    /// </summary>
    OpenFiles = 1,

    /// <summary>
    /// Analyzers are executed for all documents in the current solution.
    /// </summary>
    FullSolution = 2,

    /// <summary>
    /// Analyzers are disabled for all documents.
    /// </summary>
    None = 3,

    Minimal = None,
    Default = VisibleFilesAndOpenFilesWithPreviouslyReportedDiagnostics,
}