@eagleoutice/flowr - v2.13.14
    Preparing search index...

    Interface ReadOnlyFlowrAnalyzerContext

    This is a read-only interface to the FlowrAnalyzerContext. It prevents you from modifying the context, but allows you to inspect it (which is probably what you want when using the FlowrAnalyzer). If you are a FlowrAnalyzerPlugin and want to modify the context, you can use the FlowrAnalyzerContext directly.

    interface ReadOnlyFlowrAnalyzerContext {
        activatedPlugins: ReadonlySet<string>;
        config: FlowrConfig;
        configSpecialization(): | {
            kind: ProjectKind;
            overwrite: {
                abstractInterpretation?: { dataFrame?: ...; wideningThreshold?: ... };
                defaultEngine?: "r-shell" | "tree-sitter";
                defaultPlugins?: (...)[];
                engines?: (...)[];
                gas?: {
                    features?: ...;
                    heapProvider?: ...;
                    thresholds?: ...;
                    [key: ...]: ...;
                };
                ignoreLoadCalls?: boolean;
                ignoreSourceCalls?: boolean;
                incremental?: { alwaysIncremental?: ...; parsing?: ... };
                inputSources?: {
                    cmdline?: ...;
                    const?: ...;
                    dconst?: ...;
                    ffi?: ...;
                    file?: ...;
                    glob?: ...;
                    lang?: ...;
                    linkedEntryPoints?: ...;
                    linkedObjects?: ...;
                    narrowing?: ...;
                    net?: ...;
                    options?: ...;
                    param?: ...;
                    pure?: ...;
                    rand?: ...;
                    scope?: ...;
                    system?: ...;
                    tempfile?: ...;
                    unknown?: ...;
                    user?: ...;
                };
                linter?: { disabledRules?: ... };
                logLevel?:
                    | "debug"
                    | "silly"
                    | "trace"
                    | "info"
                    | "warn"
                    | "error"
                    | "fatal";
                project?: {
                    basePackages?: ...;
                    classification?: ...;
                    discovery?: ...;
                    failOnInaccessiblePath?: ...;
                    implicitSources?: ...;
                    resolveUnknownPathsOnDisk?: ...;
                    useProjectType?: ...;
                };
                repl?: {
                    autoUseFileProtocol?: ...;
                    dfProcessorHeat?: ...;
                    hints?: ...;
                    plugins?: ...;
                    queryStats?: ...;
                    quickStats?: ...;
                    showPlugins?: ...;
                };
                semantics?: { environment?: ... };
                solver?: {
                    evalStrings?: ...;
                    instrument?: ...;
                    resolveSource?: ...;
                    sigdb?: ...;
                    slicer?: ...;
                    trackEnvironments?: ...;
                    variables?: ...;
                    versionManagement?: ...;
                };
                specializeConfig?: {
                    notebook?: ...;
                    package?: ...;
                    project?: ...;
                    script?: ...;
                    "shiny-app"?: ...;
                    unknown?: ...;
                };
                [key: string]: unknown;
            };
        }
        | undefined;
        deps: ReadOnlyFlowrAnalyzerDependenciesContext;
        env: ReadOnlyFlowrAnalyzerEnvironmentContext;
        files: ReadOnlyFlowrAnalyzerFilesContext;
        gas: ReadOnlyFlowrAnalyzerGasContext;
        inc: ReadOnlyFlowrAnalyzerIncrementalAnalysisContext;
        inferredRange(name: string): Range | undefined;
        meta: ReadOnlyFlowrAnalyzerMetaContext;
        projectKind(): ProjectKind;
        resolvedRVersion: string;
        rVersionKnown: boolean;
        rVersionOrigin: RVersionOrigin;
    }

    Implemented by

    Index
    activatedPlugins config deps env files gas inc meta resolvedRVersion rVersionKnown rVersionOrigin
    configSpecialization inferredRange projectKind
    activatedPlugins: ReadonlySet<string>

    class names of plugins that activated (produced a result) since the last reset; only filled when config.repl.showPlugins is set

    config: FlowrConfig

    The configuration options used by the analyzer.

    deps: ReadOnlyFlowrAnalyzerDependenciesContext

    Identified dependencies and their versions.

    env: ReadOnlyFlowrAnalyzerEnvironmentContext

    Environment information used during analysis.

    files: ReadOnlyFlowrAnalyzerFilesContext

    Files to be analyzed and their loading order.

    gas: ReadOnlyFlowrAnalyzerGasContext

    Resource-usage guard (gas). Call ctx.gas.checkGas(key) at expensive analysis sites to obtain the current pressure level. Returns GasLevel.Normal with zero overhead when gas is disabled for key.

    ReadOnlyFlowrAnalyzerGasContext

    inc: ReadOnlyFlowrAnalyzerIncrementalAnalysisContext

    The incremental context provides potential information for the next incremental analysis run

    meta: ReadOnlyFlowrAnalyzerMetaContext

    Project metadata such as name, version, and namespace.

    resolvedRVersion: string

    The R version analysis assumes when resolving versioned (base-R) exports (see solver.sigdb.assumedRVersion).

    rVersionKnown: boolean

    Whether resolvedRVersion is a genuine signal (a config pin, project metadata, or an engine-detected version) rather than the fallback default.

    rVersionOrigin: RVersionOrigin

    Where resolvedRVersion comes from, as only RVersionOrigin.Config and RVersionOrigin.Metadata say anything about the analyzed code.

    • The project kind the effective config is specialized for and the overrides it applies, or undefined when no specialization is in effect.

      Returns
          | {
              kind: ProjectKind;
              overwrite: {
                  abstractInterpretation?: { dataFrame?: ...; wideningThreshold?: ... };
                  defaultEngine?: "r-shell" | "tree-sitter";
                  defaultPlugins?: (...)[];
                  engines?: (...)[];
                  gas?: {
                      features?: ...;
                      heapProvider?: ...;
                      thresholds?: ...;
                      [key: ...]: ...;
                  };
                  ignoreLoadCalls?: boolean;
                  ignoreSourceCalls?: boolean;
                  incremental?: { alwaysIncremental?: ...; parsing?: ... };
                  inputSources?: {
                      cmdline?: ...;
                      const?: ...;
                      dconst?: ...;
                      ffi?: ...;
                      file?: ...;
                      glob?: ...;
                      lang?: ...;
                      linkedEntryPoints?: ...;
                      linkedObjects?: ...;
                      narrowing?: ...;
                      net?: ...;
                      options?: ...;
                      param?: ...;
                      pure?: ...;
                      rand?: ...;
                      scope?: ...;
                      system?: ...;
                      tempfile?: ...;
                      unknown?: ...;
                      user?: ...;
                  };
                  linter?: { disabledRules?: ... };
                  logLevel?:
                      | "debug"
                      | "silly"
                      | "trace"
                      | "info"
                      | "warn"
                      | "error"
                      | "fatal";
                  project?: {
                      basePackages?: ...;
                      classification?: ...;
                      discovery?: ...;
                      failOnInaccessiblePath?: ...;
                      implicitSources?: ...;
                      resolveUnknownPathsOnDisk?: ...;
                      useProjectType?: ...;
                  };
                  repl?: {
                      autoUseFileProtocol?: ...;
                      dfProcessorHeat?: ...;
                      hints?: ...;
                      plugins?: ...;
                      queryStats?: ...;
                      quickStats?: ...;
                      showPlugins?: ...;
                  };
                  semantics?: { environment?: ... };
                  solver?: {
                      evalStrings?: ...;
                      instrument?: ...;
                      resolveSource?: ...;
                      sigdb?: ...;
                      slicer?: ...;
                      trackEnvironments?: ...;
                      variables?: ...;
                      versionManagement?: ...;
                  };
                  specializeConfig?: {
                      notebook?: ...;
                      package?: ...;
                      project?: ...;
                      script?: ...;
                      "shiny-app"?: ...;
                      unknown?: ...;
                  };
                  [key: string]: unknown;
              };
          }
          | undefined

    Settings
    Member Visibility

    On This Page
    Properties
    Methods