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

    Class FlowrAnalyzer<Parser>

    Central class for conducting analyses with FlowR. Use the FlowrAnalyzerBuilder to create a new instance.

    If you want the original pattern of creating a pipeline and running all steps, you can still do this with FlowrAnalyzer#runFull.

    To inspect the context of the analyzer, use FlowrAnalyzer#inspectContext (if you are a plugin and need to modify it, use FlowrAnalyzer#context instead).

    Type Parameters

    Implements

    Index
    • Free the cached analyses (including any WASM-backed parse trees) and close the parser. Closing is only required for an RShell/remote engine, but this also frees the cached parse trees.

      Returns boolean | void

    • Get the control flow graph (CFG) for the request.

      Parameters

      • Optionalsimplifications: readonly (
            | "unique-cf-sets"
            | "analyze-dead-code"
            | "remove-dead-code"
            | "to-basic-blocks"
        )[]

        Simplification passes to be applied to the CFG.

      • Optionalkind: CfgKind

        The kind of CFG that is requested. By default, the CFG without dataflow information is returned.

      • Optionalforce: boolean

        Do not use the cache, instead force new analyses.

      Returns Promise<ControlFlowInformation<CfgVertex>>

      ReadonlyFlowrAnalysisProvider#peekControlflow - to get the CFG if already available without triggering a new computation.

    • Access the query API for the request.

      Type Parameters

      • Types extends
            | "search"
            | "project"
            | "linter"
            | "dependencies"
            | "dataflow"
            | "files"
            | "config"
            | "call-context"
            | "does-call"
            | "call-graph"
            | "control-flow"
            | "dataflow-lens"
            | "absint"
            | "normalized-ast"
            | "id-map"
            | "dataflow-cluster"
            | "static-slice"
            | "location-map"
            | "happens-before"
            | "inspect-exception"
            | "inspect-higher-order"
            | "inspect-recursion"
            | "resolve-value"
            | "signature"
            | "origin"
            | "provenance"
            | "input-sources"
            | "dice"
            | "guess-dep-versions" =
            | "search"
            | "project"
            | "linter"
            | "dependencies"
            | "dataflow"
            | "files"
            | "config"
            | "call-context"
            | "does-call"
            | "call-graph"
            | "control-flow"
            | "dataflow-lens"
            | "absint"
            | "normalized-ast"
            | "id-map"
            | "dataflow-cluster"
            | "static-slice"
            | "location-map"
            | "happens-before"
            | "inspect-exception"
            | "inspect-higher-order"
            | "inspect-recursion"
            | "resolve-value"
            | "signature"
            | "origin"
            | "provenance"
            | "input-sources"
            | "dice"
            | "guess-dep-versions"

      Parameters

      Returns Promise<QueryResults<Types>>

    • Merge a runtime update into the base config and invalidate the derived config and cached analysis, so it takes effect.

      Parameters

      • update: {
            abstractInterpretation?: {
                dataFrame?: { maxColNames?: ...; readLoadedData?: ... };
                wideningThreshold?: number;
            };
            defaultEngine?: "r-shell"
            | "tree-sitter";
            defaultPlugins?: (string | [(...)?, (...)?] | undefined)[];
            engines?: (
                | {
                    lax?: ...;
                    treeSitterWasmPath?: ...;
                    type?: ...;
                    wasmPath?: ...;
                    [key: ...]: ...;
                }
                | { rPath?: ...; type?: ...; [key: ...]: ... }
                | undefined
            )[];
            gas?: {
                features?: { [key: ...]: ... };
                heapProvider?: () => ...;
                thresholds?: { memory?: ...; timeMs?: ...; [key: ...]: ... };
                [key: string]: unknown;
            };
            ignoreLoadCalls?: boolean;
            ignoreSourceCalls?: boolean;
            incremental?: {
                alwaysIncremental?: boolean;
                parsing?: { activated?: ...; heuristics?: ... };
            };
            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?: {
                    notebookExtensions?: ...;
                    shinyDescriptionTypes?: ...;
                    shinyEntryFiles?: ...;
                    shinyUsagePattern?: ...;
                };
                discovery?: { full?: ...; ignore?: ...; perKind?: ... };
                failOnInaccessiblePath?: boolean;
                implicitSources?: (...)[];
                resolveUnknownPathsOnDisk?: boolean;
                useProjectType?: ProjectKind;
            };
            repl?: {
                autoUseFileProtocol?: boolean;
                dfProcessorHeat?: boolean;
                hints?: boolean;
                plugins?: (...)[];
                queryStats?: boolean;
                quickStats?: boolean;
                showPlugins?: boolean;
            };
            semantics?: { environment?: { overwriteBuiltIns?: ... } };
            solver?: {
                evalStrings?: boolean;
                instrument?: { dataflowExtractors?: ... };
                resolveSource?: {
                    applyReplacements?: ...;
                    assumeFilesExist?: ...;
                    dropPaths?: ...;
                    ignoreCapitalization?: ...;
                    inferWorkingDirectory?: ...;
                    repeatedSourceLimit?: ...;
                    searchPath?: ...;
                    [key: ...]: ...;
                };
                sigdb?: {
                    additionalPaths?: ...;
                    assumedRVersion?: ...;
                    autoSync?: ...;
                    downloadRepo?: ...;
                    eagerlyLoad?: ...;
                    eagerlyLoadExports?: ...;
                    enabled?: ...;
                    installedLibrary?: ...;
                    linkBaseR?: ...;
                    linkBaseRCalls?: ...;
                    linkDescriptionDependencies?: ...;
                    linkPackageCalls?: ...;
                    loadProjectDependencies?: ...;
                    versionOverrides?: ...;
                    versionSelection?: ...;
                    warmInBackground?: ...;
                };
                slicer?: { autoExtend?: ...; threshold?: ... };
                trackEnvironments?: boolean;
                variables?: VariableResolve;
                versionManagement?: { linkedVersionGroups?: ... };
            };
            specializeConfig?: {
                notebook?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
                package?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
                project?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
                script?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
                "shiny-app"?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
                unknown?: {
                    abstractInterpretation?: ...;
                    defaultEngine?: ...;
                    defaultPlugins?: ...;
                    engines?: ...;
                    gas?: ...;
                    ignoreLoadCalls?: ...;
                    ignoreSourceCalls?: ...;
                    incremental?: ...;
                    inherit?: ...;
                    inputSources?: ...;
                    linter?: ...;
                    logLevel?: ...;
                    project?: ...;
                    repl?: ...;
                    semantics?: ...;
                    solver?: ...;
                    specializeConfig?: ...;
                    [key: ...]: ...;
                };
            };
            [key: string]: unknown;
        }
        • [key: string]: unknown
        • Optional ReadonlyabstractInterpretation?: {
              dataFrame?: { maxColNames?: ...; readLoadedData?: ... };
              wideningThreshold?: number;
          }

          Configuration options for abstract interpretation

          • Optional ReadonlydataFrame?: { maxColNames?: ...; readLoadedData?: ... }

            The configuration of the shape inference for data frames

            • Optional ReadonlymaxColNames?: ...

              The maximum number of columns names to infer for data frames before over-approximating the column names to top

            • Optional ReadonlyreadLoadedData?: ...

              Configuration options for reading data frame shapes from loaded external data files, such as CSV files

          • Optional ReadonlywideningThreshold?: number

            The threshold for the number of visitations of a node at which widening should be performed to ensure the termination of the fixpoint iteration

        • Optional ReadonlydefaultEngine?: "r-shell" | "tree-sitter"

          The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

        • Optional ReadonlydefaultPlugins?: (string | [(...)?, (...)?] | undefined)[]

          Plugins to load by default when creating a new FlowrAnalyzer

        • Optional Readonlyengines?: (
              | {
                  lax?: ...;
                  treeSitterWasmPath?: ...;
                  type?: ...;
                  wasmPath?: ...;
                  [key: ...]: ...;
              }
              | { rPath?: ...; type?: ...; [key: ...]: ... }
              | undefined
          )[]

          The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

        • Optional Readonlygas?: {
              features?: { [key: ...]: ... };
              heapProvider?: () => ...;
              thresholds?: { memory?: ...; timeMs?: ...; [key: ...]: ... };
              [key: string]: unknown;
          }

          Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

          • Optional Readonlyfeatures?: { [key: ...]: ... }

            Per-feature sensitivity factors. Missing or 0 disables checking with zero overhead.

          • Optional ReadonlyheapProvider?: () => ...

            Custom heap statistics source (programmatic configs only), overriding the built-in detection (v8 module, then Chromium's performance.memory). Return undefined to skip the memory check.

          • Optional Readonlythresholds?: { memory?: ...; timeMs?: ...; [key: ...]: ... }

            Thresholds scaled by each feature factor before comparison, optionally bounded per feature (see GasThresholdSpec).

            • Optional Readonlymemory?: ...

              Heap-usage fraction thresholds (0-1, before factor scaling).

            • Optional ReadonlytimeMs?: ...

              Elapsed analysis time thresholds in milliseconds (before factor scaling).

        • Optional ReadonlyignoreLoadCalls?: boolean

          Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

        • Optional ReadonlyignoreSourceCalls?: boolean

          Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

        • Optional Readonlyincremental?: { alwaysIncremental?: boolean; parsing?: { activated?: ...; heuristics?: ... } }
          • Optional ReadonlyalwaysIncremental?: boolean

            Always take the incremental path, regardless of heuristics

          • Optional Readonlyparsing?: { activated?: ...; heuristics?: ... }
        • Optional ReadonlyinputSources?: {
              cmdline?: (...)[];
              const?: (...)[];
              dconst?: (...)[];
              ffi?: (...)[];
              file?: (...)[];
              glob?: (...)[];
              lang?: (...)[];
              linkedEntryPoints?: (...)[];
              linkedObjects?: (...)[];
              narrowing?: (...)[];
              net?: (...)[];
              options?: (...)[];
              param?: (...)[];
              pure?: (...)[];
              rand?: (...)[];
              scope?: (...)[];
              system?: (...)[];
              tempfile?: (...)[];
              unknown?: (...)[];
              user?: (...)[];
          }

          Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

          InputClassifierConfig - for what the entries mean

          • Optionalcmdline?: (...)[]
          • Optionalconst?: (...)[]
          • Optionaldconst?: (...)[]
          • Optionalffi?: (...)[]
          • Optionalfile?: (...)[]
          • Optionalglob?: (...)[]
          • Optionallang?: (...)[]
          • OptionallinkedEntryPoints?: (...)[]

            Calls that hand a function to a framework, which then binds linkedObjects to its parameters by position.

          • OptionallinkedObjects?: (...)[]

            Objects provided by a framework rather than by the code itself, like shiny's input.

          • Optionalnarrowing?: (...)[]

            Functions whose result is bounded by one of their arguments (classified by that argument alone).

          • Optionalnet?: (...)[]
          • Optionaloptions?: (...)[]
          • Optionalparam?: (...)[]
          • Optionalpure?: (...)[]

            Functions which are considered to be pure (i.e., deterministic, trusted, safe, idempotent on the lub of the input types)

          • Optionalrand?: (...)[]
          • Optionalscope?: (...)[]
          • Optionalsystem?: (...)[]
          • Optionaltempfile?: (...)[]
          • Optionalunknown?: (...)[]
          • Optionaluser?: (...)[]
        • Optional Readonlylinter?: { disabledRules?: (...)[] }

          Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

          • Optional ReadonlydisabledRules?: (...)[]

            Rule names excluded from the default rule set (a rule requested explicitly still runs).

        • Optional ReadonlylogLevel?: "debug" | "silly" | "trace" | "info" | "warn" | "error" | "fatal"
        • Optional Readonlyproject?: {
              basePackages?: (...)[];
              classification?: {
                  notebookExtensions?: ...;
                  shinyDescriptionTypes?: ...;
                  shinyEntryFiles?: ...;
                  shinyUsagePattern?: ...;
              };
              discovery?: { full?: ...; ignore?: ...; perKind?: ... };
              failOnInaccessiblePath?: boolean;
              implicitSources?: (...)[];
              resolveUnknownPathsOnDisk?: boolean;
              useProjectType?: ProjectKind;
          }
          • OptionalbasePackages?: (...)[]

            The packages considered part of R itself, used e.g. by the project query to classify dependencies. If unset, flowR derives them (for the assumed R version) from the signature database via baseRPackages.

          • Optionalclassification?: {
                notebookExtensions?: ...;
                shinyDescriptionTypes?: ...;
                shinyEntryFiles?: ...;
                shinyUsagePattern?: ...;
            }

            Overrides for the signals flowR uses to classify the ProjectKind; unset fields keep the built-in defaults.

            • OptionalnotebookExtensions?: ...

              File extensions marking a notebook (default ipynb, rmd, rmarkdown, qmd, rnw).

            • OptionalshinyDescriptionTypes?: ...

              DESCRIPTION Type: values that mark a shiny app (default shiny, shiny-app, shinyapp).

            • OptionalshinyEntryFiles?: ...

              File names a shiny app is assembled from (default app.R, ui.R, server.R, global.R).

            • OptionalshinyUsagePattern?: ...

              Regex source evidencing shiny usage in an entry file.

          • Optionaldiscovery?: { full?: ...; ignore?: ...; perKind?: ... }

            Scoping options for the default project discovery.

            • Optionalfull?: ...

              Collect every file below the project root (greedy) instead of only the files the detected ProjectKind needs (default false).

            • Optionalignore?: ...

              Case-insensitive globs that drop matching files from the intelligent discovery, regardless of kind (e.g. .Renviron to ignore environment files).

            • OptionalperKind?: ...

              Per-ProjectKind include/exclude glob overrides layered on the default scoping.

          • OptionalfailOnInaccessiblePath?: boolean

            Whether a directory that cannot be traversed during file discovery (e.g. due to permissions) aborts the analysis; when false (the default) such paths are logged and skipped.

          • OptionalimplicitSources?: (...)[]

            Files a framework loads on its own, without any source() call (e.g. global.R in a shiny app), in load order. Entries are case-insensitive globs (R/*.R) matched against the path, a plain name matches any file with that name; entries matching nothing are warned about. Usually set per ProjectKind via FlowrConfig.specializeConfig.

          • OptionalresolveUnknownPathsOnDisk?: boolean

            Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files

          • OptionaluseProjectType?: ProjectKind

            Overwrite the ProjectKind flowR would otherwise infer from the analyzed files, e.g. when auto-detection guesses wrong.

        • Optional Readonlyrepl?: {
              autoUseFileProtocol?: boolean;
              dfProcessorHeat?: boolean;
              hints?: boolean;
              plugins?: (...)[];
              queryStats?: boolean;
              quickStats?: boolean;
              showPlugins?: boolean;
          }

          Configuration options for the REPL

          • OptionalautoUseFileProtocol?: boolean

            Automatically use the file protocol for inputs that look like paths (default true)

          • OptionaldfProcessorHeat?: boolean

            This instruments the dataflow processors to count how often each processor is called

          • Optionalhints?: boolean

            Whether to show dim inline hints (e.g. :help) on the empty prompt; automatically disabled on non-interactive terminals

          • Optionalplugins?: (...)[]

            Plugins to load in REPL mode

          • OptionalqueryStats?: boolean

            Whether :query closes with the line stating how long the queries took (default true, :query* never prints it)

          • OptionalquickStats?: boolean

            Whether to show quick stats in the REPL after each evaluation

          • OptionalshowPlugins?: boolean

            Whether :version grays out the plugins that did not activate during the last analysis (default false)

        • Optional Readonlysemantics?: { environment?: { overwriteBuiltIns?: ... } }

          Configure language semantics and how flowR handles them

          • Optional Readonlyenvironment?: { overwriteBuiltIns?: ... }

            Semantics regarding the handling of the environment

            • Optional ReadonlyoverwriteBuiltIns?: ...

              Do you want to overwrite (parts) of the builtin definition?

        • Optional Readonlysolver?: {
              evalStrings?: boolean;
              instrument?: { dataflowExtractors?: ... };
              resolveSource?: {
                  applyReplacements?: ...;
                  assumeFilesExist?: ...;
                  dropPaths?: ...;
                  ignoreCapitalization?: ...;
                  inferWorkingDirectory?: ...;
                  repeatedSourceLimit?: ...;
                  searchPath?: ...;
                  [key: ...]: ...;
              };
              sigdb?: {
                  additionalPaths?: ...;
                  assumedRVersion?: ...;
                  autoSync?: ...;
                  downloadRepo?: ...;
                  eagerlyLoad?: ...;
                  eagerlyLoadExports?: ...;
                  enabled?: ...;
                  installedLibrary?: ...;
                  linkBaseR?: ...;
                  linkBaseRCalls?: ...;
                  linkDescriptionDependencies?: ...;
                  linkPackageCalls?: ...;
                  loadProjectDependencies?: ...;
                  versionOverrides?: ...;
                  versionSelection?: ...;
                  warmInBackground?: ...;
              };
              slicer?: { autoExtend?: ...; threshold?: ... };
              trackEnvironments?: boolean;
              variables?: VariableResolve;
              versionManagement?: { linkedVersionGroups?: ... };
          }

          How to resolve constants, constraints, cells, …

          • Optional ReadonlyevalStrings?: boolean

            Should we include eval(parse(text="...")) calls in the dataflow graph?

          • Optional Readonlyinstrument?: { dataflowExtractors?: ... }

            These keys are only intended for use within code, allowing to instrument the dataflow analyzer!

            • OptionaldataflowExtractors?: ...

              Modify the dataflow processors used during dataflow analysis. Make sure that all processors required for correct analysis are still present! This may have arbitrary consequences on the analysis precision and performance, consider focusing on decorating existing processors instead of replacing them.

          • Optional ReadonlyresolveSource?: {
                applyReplacements?: ...;
                assumeFilesExist?: ...;
                dropPaths?: ...;
                ignoreCapitalization?: ...;
                inferWorkingDirectory?: ...;
                repeatedSourceLimit?: ...;
                searchPath?: ...;
                [key: ...]: ...;
            }

            If lax source calls are active, flowR searches for sourced files much more freely, based on the configurations you give it. This option is only in effect if ignoreSourceCalls is set to false.

            • Optional ReadonlyapplyReplacements?: ...

              sometimes files may have a different name in the source call (e.g., due to later replacements), with this setting you can provide a list of replacements to apply for each sourced file. Every replacement consists of a record that maps a regex to a replacement string.

              [
              { }, // no replacement -> still try the original name/path
              { '.*\\.R$': 'main.R' }, // replace all .R files with main.R
              { '\s' : '_' }, // replace all spaces with underscores
              { '\s' : '-', 'oo': 'aa' }, // replace all spaces with dashes and oo with aa
              ]

              Given a source("foo bar.R") this configuration will search for (in this order):

              • foo bar.R (original name)
              • main.R (replaced with main.R)
              • foo_bar.R (replaced spaces)
              • faa-bar.R (replaced spaces and oo)
            • Optional ReadonlyassumeFilesExist?: ...

              Assume a sourced file is always there, making what it defines certain instead of conditional on the source call.

            • Optional ReadonlydropPaths?: ...

              Allow to drop the first or all parts of the sourced path, if it is relative.

            • Optional ReadonlyignoreCapitalization?: ...

              search for filenames matching in the lowercase

            • Optional ReadonlyinferWorkingDirectory?: ...

              try to infer the working directory from the main or any script to analyze.

            • Optional ReadonlyrepeatedSourceLimit?: ...

              How often the same file can be sourced within a single run? Please be aware: in case of cyclic sources this may not reach a fixpoint so give this a sensible limit.

            • Optional ReadonlysearchPath?: ...

              Additionally search in these paths

          • Optional Readonlysigdb?: {
                additionalPaths?: ...;
                assumedRVersion?: ...;
                autoSync?: ...;
                downloadRepo?: ...;
                eagerlyLoad?: ...;
                eagerlyLoadExports?: ...;
                enabled?: ...;
                installedLibrary?: ...;
                linkBaseR?: ...;
                linkBaseRCalls?: ...;
                linkDescriptionDependencies?: ...;
                linkPackageCalls?: ...;
                loadProjectDependencies?: ...;
                versionOverrides?: ...;
                versionSelection?: ...;
                warmInBackground?: ...;
            }

            Resolving library()/use() exports from a signature database (e.g. the bundled flowr-sigdb).

            • Optional ReadonlyadditionalPaths?: ...

              Extra directories (or bundle/manifest files) searched for signature databases, alongside the shipped default and $FLOWR_SIGDB_DIR. A downloaded full-history bundle placed here is mounted automatically.

            • Optional ReadonlyassumedRVersion?: ...

              The R version analysis assumes when resolving versioned (base-R) package exports: a pin like "4.5", or "auto" to detect the locally installed R (falling back to DefaultAssumedRVersion when the engine reports none, e.g. the tree-sitter engine). Resolve it with resolveAssumedRVersion.

            • Optional ReadonlyautoSync?: ...

              On startup, compare the cache against the committed sigdb.remote.json link file and re-download changed shards in the background (default false; needs network, so opt-in — a git pull that updates the pointer then re-syncs automatically).

            • Optional ReadonlydownloadRepo?: ...

              GitHub owner/repo the full-history bundle is downloaded from (:signature download); default flowr-analysis/flowr, release tag sigdb-v<flowR-version>.

            • Optional ReadonlyeagerlyLoad?: ...

              Parse the database up front rather than on the first package load (default false, ignored if disabled).

            • Optional ReadonlyeagerlyLoadExports?: ...

              Add a vertex for every export on load rather than on demand (default false); keeps the graph small.

            • Optional Readonlyenabled?: ...

              Resolve library exports from a signature database (default true); when false no database is consulted.

            • Optional ReadonlyinstalledLibrary?: ...

              Recovering a package no signature database knows (a CRAN-archived one like maptools) from the copy installed on this machine: its DESCRIPTION states the version, its NAMESPACE the exports. Opt-in, as it reads directories outside the analyzed project and ties the analysis to what is installed here.

            • Optional ReadonlylinkBaseR?: ...

              Eagerly attach base-R namespaces (from a signature database) so bare base calls resolve without library() (default false; changes every analysis; needs a base-R signature database).

            • Optional ReadonlylinkBaseRCalls?: ...

              Add a lightweight Reads edge from a bare base-R call to its signature-database function vertex (built-in:pkg:fn); base-R qualification stays edge-free unless this is on (default false; adds edges to every base call).

            • Optional ReadonlylinkDescriptionDependencies?: ...

              Eagerly attach the namespaces of the project's declared DESCRIPTION dependencies (Imports/Depends) so their exports resolve without an explicit library() (default false; changes every analysis; needs a signature database resolving the declared packages).

            • Optional ReadonlylinkPackageCalls?: ...

              Add a lightweight Reads edge from a resolved package call (pkg::fn/attached export) to its signature-database function vertex (default false).

            • Optional ReadonlyloadProjectDependencies?: ...

              Load the project's declared dependencies from its metadata files (DESCRIPTION Imports/Depends, rproject.toml, uvr.toml, renv.lock, rv.lock, uvr.lock) into the dependency context (default true); when false these files are not read, so neither the undefined-symbol linter nor linkDescriptionDependencies sees any project-declared dependency.

            • Optional ReadonlyversionOverrides?: ...

              Force an exact version for specific packages (mapping a package name to a version), overriding both the project constraint and the versionSelection policy; a version missing from the database falls back with a warning (default {}).

            • Optional ReadonlyversionSelection?: ...

              When a project constrains a dependency, resolve to the newest (default) or oldest version satisfying the constraint, or the system-installed version (needs R; falls back to newest when unavailable). Base-R packages always resolve against the assumed R version.

            • Optional ReadonlywarmInBackground?: ...

              Decompress the hot shards (base + most-downloaded) in a background task on startup, so the first library() lookup is warm (default false; useful for long-running servers/REPLs, not one-shot runs).

          • Optionalslicer?: { autoExtend?: ...; threshold?: ... }

            The configuration for flowR's slicer

            • Optional ReadonlyautoExtend?: ...

              If set, the slicer will gain an additional post-pass

            • Optional Readonlythreshold?: ...

              The maximum number of iterations to perform on a single function call during slicing

          • Optional ReadonlytrackEnvironments?: boolean

            Track user-created environments (new.env(), assign(..., envir=e), get(..., envir=e), local({}, envir=e), e$x <- v, attach(e)) with precise per-variable envState. When disabled all envir-style calls fall through to the conservative global treatment.

          • Optional Readonlyvariables?: VariableResolve

            How to resolve variables and their values

          • Optional ReadonlyversionManagement?: { linkedVersionGroups?: ... }

            Policies for reasoning about dependency versions (independent of how the signature database is loaded).

            • Optional ReadonlylinkedVersionGroups?: ...

              Groups of packages that must resolve to the same version (like the base packages, which share the R version); version guessing intersects each group so its members stay mutually compatible (default []).

        • Optional ReadonlyspecializeConfig?: {
              notebook?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
              package?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
              project?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
              script?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
              "shiny-app"?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
              unknown?: {
                  abstractInterpretation?: ...;
                  defaultEngine?: ...;
                  defaultPlugins?: ...;
                  engines?: ...;
                  gas?: ...;
                  ignoreLoadCalls?: ...;
                  ignoreSourceCalls?: ...;
                  incremental?: ...;
                  inherit?: ...;
                  inputSources?: ...;
                  linter?: ...;
                  logLevel?: ...;
                  project?: ...;
                  repl?: ...;
                  semantics?: ...;
                  solver?: ...;
                  specializeConfig?: ...;
                  [key: ...]: ...;
              };
          }

          Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalnotebook?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalpackage?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalproject?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalscript?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalshiny-app?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

          • Optionalunknown?: {
                abstractInterpretation?: ...;
                defaultEngine?: ...;
                defaultPlugins?: ...;
                engines?: ...;
                gas?: ...;
                ignoreLoadCalls?: ...;
                ignoreSourceCalls?: ...;
                incremental?: ...;
                inherit?: ...;
                inputSources?: ...;
                linter?: ...;
                logLevel?: ...;
                project?: ...;
                repl?: ...;
                semantics?: ...;
                solver?: ...;
                specializeConfig?: ...;
                [key: ...]: ...;
            }
            • Optional ReadonlyabstractInterpretation?: ...

              Configuration options for abstract interpretation

            • Optional ReadonlydefaultEngine?: ...

              The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

            • Optional ReadonlydefaultPlugins?: ...

              Plugins to load by default when creating a new FlowrAnalyzer

            • Optional Readonlyengines?: ...

              The engines to use for interacting with R code. Currently, supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

            • Optional Readonlygas?: ...

              Resource-usage guard (gas) configuration. Gas checks are disabled by default (all feature factors are 0). Set a feature factor > 0 to enable checking for that feature.

            • Optional ReadonlyignoreLoadCalls?: ...

              Whether load calls should be ignored, causing processLoadCall's behavior to be skipped

            • Optional ReadonlyignoreSourceCalls?: ...

              Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

            • Optional Readonlyincremental?: ...
            • Optional Readonlyinherit?: ...
            • Optional ReadonlyinputSources?: ...

              Teaches the InputSourcesQuery|input-sources analysis (and with it the problematic-inputs linter) about further frameworks. Everything here is added to what flowR already knows, so a shiny app keeps its input even when you declare your own. Usually set per ProjectKind via specializeConfig.

              InputClassifierConfig - for what the entries mean

            • Optional Readonlylinter?: ...

              Linter configuration, usually specialized per ProjectKind via FlowrConfig.specializeConfig.

            • Optional ReadonlylogLevel?: ...
            • Optional Readonlyproject?: ...
            • Optional Readonlyrepl?: ...

              Configuration options for the REPL

            • Optional Readonlysemantics?: ...

              Configure language semantics and how flowR handles them

            • Optional Readonlysolver?: ...

              How to resolve constants, constraints, cells, …

            • Optional ReadonlyspecializeConfig?: ...

              Overwrite (parts of) this configuration depending on the ProjectKind flowR detects for the project, e.g. to give a shiny app its implicit sources. An entry may inherit another kind's overwrite (merged first, with the entry's own keys winning) to avoid repeating it. Resolve it with FlowrConfig.forKind.

      Returns void