Interface FlowrConfig

The configuration file format for flowR.

See

FlowrConfig.default for the default configuration.
FlowrConfig.Schema for the Joi schema for validation.

interface FlowrConfig {
    abstractInterpretation: {
        dataFrame: {
            maxColNames: number;
            readLoadedData: { maxReadLines: number; readExternalFiles: boolean };
        };
        followCalls: boolean;
        wideningThreshold: number;
    };
    defaultEngine?: "r-shell"
    | "tree-sitter";
    defaultPlugins: ConfigPlugin<string>[];
    engines: EngineConfig[];
    gas: FlowrGasConfig;
    ignoreLoadCalls: boolean;
    ignoreSourceCalls: boolean;
    incremental: {
        alwaysIncremental: boolean;
        parsing: {
            activated: boolean;
            heuristics: {
                activated: boolean;
                alwaysWithEdits: boolean;
                bytesFrom: number;
                linesFrom: number;
                minFiles: number;
                mtime: boolean;
            };
        };
    };
    inputSources?: {
        cmdline?: string[];
        const?: string[];
        dconst?: string[];
        ffi?: string[];
        file?: string[];
        glob?: string[];
        lang?: string[];
        linkedEntryPoints?: { argIdx: ...; argName: ...; call: ...; params: ... }[];
        linkedObjects?: {
            declaredBy?: ...;
            fields?: ...;
            name: ...;
            requires?: ...;
            type: ...;
            withParams?: ...;
        }[];
        narrowing?: { argIdx?: ...; argName?: ...; call: ... }[];
        net?: string[];
        options?: string[];
        param?: string[];
        pure?: string[];
        rand?: string[];
        scope?: string[];
        system?: string[];
        tempfile?: string[];
        unknown?: string[];
        user?: string[];
    };
    linter: { disabledRules: string[] };
    logLevel?:
        | "debug"
        | "silly"
        | "trace"
        | "info"
        | "warn"
        | "error"
        | "fatal";
    project: {
        assumeImplicitEcho?: boolean;
        basePackages?: string[];
        classification?: {
            notebookExtensions?: (...)[];
            shinyDescriptionTypes?: (...)[];
            shinyEntryFiles?: (...)[];
            shinyUsagePattern?: string;
        };
        discovery?: { full?: boolean; ignore?: (...)[]; perKind?: Partial<(...)> };
        failOnInaccessiblePath?: boolean;
        implicitSources?: string[];
        resolveUnknownPathsOnDisk: boolean;
        useProjectType?: ProjectKind;
    };
    repl: {
        autoUseFileProtocol?: boolean;
        dfProcessorHeat: boolean;
        hints: boolean;
        plugins: ConfigPlugin<string>[];
        queryStats?: boolean;
        quickStats: boolean;
        showPlugins?: boolean;
    };
    semantics: {
        environment: {
            overwriteBuiltIns: {
                definitions: BuiltInDefinition<(...)>[];
                loadDefaults?: boolean;
            };
        };
    };
    solver: {
        assumeAttachedPackages?: string[];
        evalStrings: boolean;
        instrument: {
            dataflowExtractors?: (
                extractor: DataflowProcessors<(...)>,
                ctx: FlowrAnalyzerContext,
            ) => DataflowProcessors<(...)>;
        };
        resolveSource?: FlowrLaxSourcingOptions;
        sigdb: {
            additionalPaths?: string[];
            assumedRVersion?: string;
            autoSync?: boolean;
            blobCacheBudgetMb?: number;
            downloadRepo?: string;
            eagerlyLoad: boolean;
            eagerlyLoadExports: boolean;
            enabled: boolean;
            installedLibrary?: {
                enabled: boolean;
                maxDepth?: (...)
                | (...);
                packages?: (...) | (...);
                paths?: (...) | (...);
                useEnvironment?: (...) | (...) | (...);
                useProjectLibrary?: (...) | (...) | (...);
            };
            linkBaseR: boolean;
            linkBaseRCalls?: boolean;
            linkDescriptionDependencies: boolean;
            linkPackageCalls?: boolean;
            loadProjectDependencies: boolean;
            versionOverrides?: Record<string, string>;
            versionSelection?: VersionSelection;
            warmInBackground?: boolean;
        };
        slicer?: { autoExtend?: boolean; threshold?: number };
        trackEnvironments: boolean;
        transitiveSideEffectRounds?: number;
        variables: VariableResolve;
        versionManagement?: { linkedVersionGroups?: (...)[] };
    };
    specializeConfig?: Partial<Record<ProjectKind, SpecializeConfigEntry>>;
}

Index

Properties

abstractInterpretation defaultEngine? defaultPlugins engines gas ignoreLoadCalls ignoreSourceCalls incremental inputSources? linter logLevel? project repl semantics solver specializeConfig?

Properties

`Readonly`abstractInterpretation

abstractInterpretation: {
    dataFrame: {
        maxColNames: number;
        readLoadedData: { maxReadLines: number; readExternalFiles: boolean };
    };
    followCalls: boolean;
    wideningThreshold: number;
}

`Optional` `Readonly`defaultEngine

defaultEngine?: "r-shell" | "tree-sitter"

The default engine to use. If undefined, an arbitrary one from engines is used.

`Readonly`defaultPlugins

defaultPlugins: ConfigPlugin<string>[]

`Readonly`engines

engines: EngineConfig[]

Engines to use for interacting with R code (TreeSitterEngineConfig, RShellEngineConfig); empty means all available engines.

`Readonly`gas

gas: FlowrGasConfig

Resource-usage guard (gas) configuration; disabled by default (every feature factor 0), enable by setting a feature's factor > 0. See FlowrGasConfig, ReadOnlyFlowrAnalyzerGasContext.

`Readonly`ignoreLoadCalls

ignoreLoadCalls: boolean

`Readonly`ignoreSourceCalls

ignoreSourceCalls: boolean

`Readonly`incremental

incremental: {
    alwaysIncremental: boolean;
    parsing: {
        activated: boolean;
        heuristics: {
            activated: boolean;
            alwaysWithEdits: boolean;
            bytesFrom: number;
            linesFrom: number;
            minFiles: number;
            mtime: boolean;
        };
    };
}

`Optional` `Readonly`inputSources

inputSources?: {
    cmdline?: string[];
    const?: string[];
    dconst?: string[];
    ffi?: string[];
    file?: string[];
    glob?: string[];
    lang?: string[];
    linkedEntryPoints?: { argIdx: ...; argName: ...; call: ...; params: ... }[];
    linkedObjects?: {
        declaredBy?: ...;
        fields?: ...;
        name: ...;
        requires?: ...;
        type: ...;
        withParams?: ...;
    }[];
    narrowing?: { argIdx?: ...; argName?: ...; call: ... }[];
    net?: string[];
    options?: string[];
    param?: string[];
    pure?: string[];
    rand?: string[];
    scope?: string[];
    system?: string[];
    tempfile?: string[];
    unknown?: string[];
    user?: string[];
}

Teaches the InputSourcesQuery|input-sources analysis further frameworks; entries are added to what flowR knows already. Usually set per ProjectKind via specializeConfig. See InputClassifierConfig.

Type Declaration

Optionalcmdline?: string[]
Optionalconst?: string[]
Optionaldconst?: string[]
Optionalffi?: string[]
Optionalfile?: string[]
Optionalglob?: string[]
Optionallang?: string[]
OptionallinkedEntryPoints?: { argIdx: ...; argName: ...; call: ...; params: ... }[]

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

See
LinkedInputEntryPoint
OptionallinkedObjects?: {
    declaredBy?: ...;
    fields?: ...;
    name: ...;
    requires?: ...;
    type: ...;
    withParams?: ...;
}[]

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

See
LinkedInputObject
Optionalnarrowing?: { argIdx?: ...; argName?: ...; call: ... }[]

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

See
NarrowingFunction
Optionalnet?: string[]
Optionaloptions?: string[]
Optionalparam?: string[]
Optionalpure?: string[]

Functions which are considered to be pure (i.e., deterministic, trusted, safe, idempotent on the lub of the input types)
Optionalrand?: string[]
Optionalscope?: string[]
Optionalsystem?: string[]
Optionaltempfile?: string[]
Optionalunknown?: string[]
Optionaluser?: string[]

`Readonly`linter

linter: { disabledRules: string[] }

`Optional` `Readonly`logLevel

`Readonly`project

project: {
    assumeImplicitEcho?: boolean;
    basePackages?: string[];
    classification?: {
        notebookExtensions?: (...)[];
        shinyDescriptionTypes?: (...)[];
        shinyEntryFiles?: (...)[];
        shinyUsagePattern?: string;
    };
    discovery?: { full?: boolean; ignore?: (...)[]; perKind?: Partial<(...)> };
    failOnInaccessiblePath?: boolean;
    implicitSources?: string[];
    resolveUnknownPathsOnDisk: boolean;
    useProjectType?: ProjectKind;
}

Type Declaration

OptionalassumeImplicitEcho?: boolean

Whether the top level's visible results count as an output (the print category); off by default for a ProjectKind.Package, whose top level runs at install time.
OptionalbasePackages?: string[]

The packages considered part of R itself; if unset, flowR derives them (for the assumed R version) from the signature database via baseRPackages.
Optionalclassification?: {
    notebookExtensions?: (...)[];
    shinyDescriptionTypes?: (...)[];
    shinyEntryFiles?: (...)[];
    shinyUsagePattern?: string;
}
- 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?: string
Optionaldiscovery?: { full?: boolean; ignore?: (...)[]; perKind?: Partial<(...)> }
OptionalfailOnInaccessiblePath?: boolean
OptionalimplicitSources?: string[]
resolveUnknownPathsOnDisk: boolean
OptionaluseProjectType?: ProjectKind

`Readonly`repl

repl: {
    autoUseFileProtocol?: boolean;
    dfProcessorHeat: boolean;
    hints: boolean;
    plugins: ConfigPlugin<string>[];
    queryStats?: boolean;
    quickStats: boolean;
    showPlugins?: boolean;
}

Type Declaration

OptionalautoUseFileProtocol?: boolean

Automatically use the file protocol for inputs that look like paths (default true)
dfProcessorHeat: boolean
hints: boolean

Whether to show dim inline hints (e.g. :help) on the empty prompt; automatically disabled on non-interactive terminals
plugins: ConfigPlugin<string>[]
OptionalqueryStats?: boolean

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

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

`Readonly`semantics

semantics: {
    environment: {
        overwriteBuiltIns: {
            definitions: BuiltInDefinition<(...)>[];
            loadDefaults?: boolean;
        };
    };
}

`Readonly`solver

solver: {
    assumeAttachedPackages?: string[];
    evalStrings: boolean;
    instrument: {
        dataflowExtractors?: (
            extractor: DataflowProcessors<(...)>,
            ctx: FlowrAnalyzerContext,
        ) => DataflowProcessors<(...)>;
    };
    resolveSource?: FlowrLaxSourcingOptions;
    sigdb: {
        additionalPaths?: string[];
        assumedRVersion?: string;
        autoSync?: boolean;
        blobCacheBudgetMb?: number;
        downloadRepo?: string;
        eagerlyLoad: boolean;
        eagerlyLoadExports: boolean;
        enabled: boolean;
        installedLibrary?: {
            enabled: boolean;
            maxDepth?: (...)
            | (...);
            packages?: (...) | (...);
            paths?: (...) | (...);
            useEnvironment?: (...) | (...) | (...);
            useProjectLibrary?: (...) | (...) | (...);
        };
        linkBaseR: boolean;
        linkBaseRCalls?: boolean;
        linkDescriptionDependencies: boolean;
        linkPackageCalls?: boolean;
        loadProjectDependencies: boolean;
        versionOverrides?: Record<string, string>;
        versionSelection?: VersionSelection;
        warmInBackground?: boolean;
    };
    slicer?: { autoExtend?: boolean; threshold?: number };
    trackEnvironments: boolean;
    transitiveSideEffectRounds?: number;
    variables: VariableResolve;
    versionManagement?: { linkedVersionGroups?: (...)[] };
}

`Optional` `Readonly`specializeConfig

specializeConfig?: Partial<Record<ProjectKind, SpecializeConfigEntry>>

Overwrite (parts of) this configuration per ProjectKind; an entry may inherit another kind's overwrite first (own keys win). Resolve with FlowrConfig.forKind.

Interface FlowrConfig

See

Index

Properties

Properties

ReadonlyabstractInterpretation

Optional ReadonlydefaultEngine

ReadonlydefaultPlugins

Readonlyengines

Readonlygas

ReadonlyignoreLoadCalls

ReadonlyignoreSourceCalls

Readonlyincremental

Optional ReadonlyinputSources

Type Declaration

Optionalcmdline?: string[]

Optionalconst?: string[]

Optionaldconst?: string[]

Optionalffi?: string[]

Optionalfile?: string[]

Optionalglob?: string[]

Optionallang?: string[]

OptionallinkedEntryPoints?: { argIdx: ...; argName: ...; call: ...; params: ... }[]

See

OptionallinkedObjects?: { declaredBy?: ...; fields?: ...; name: ...; requires?: ...; type: ...; withParams?: ...;}[]

See

Optionalnarrowing?: { argIdx?: ...; argName?: ...; call: ... }[]

See

Optionalnet?: string[]

Optionaloptions?: string[]

Optionalparam?: string[]

Optionalpure?: string[]

Optionalrand?: string[]

Optionalscope?: string[]

Optionalsystem?: string[]

Optionaltempfile?: string[]

Optionalunknown?: string[]

Optionaluser?: string[]

Readonlylinter

Optional ReadonlylogLevel

Readonlyproject

Type Declaration

OptionalassumeImplicitEcho?: boolean

OptionalbasePackages?: string[]

Optionalclassification?: { notebookExtensions?: (...)[]; shinyDescriptionTypes?: (...)[]; shinyEntryFiles?: (...)[]; shinyUsagePattern?: string;}

OptionalnotebookExtensions?: (...)[]

OptionalshinyDescriptionTypes?: (...)[]

OptionalshinyEntryFiles?: (...)[]

OptionalshinyUsagePattern?: string

Optionaldiscovery?: { full?: boolean; ignore?: (...)[]; perKind?: Partial<(...)> }

OptionalfailOnInaccessiblePath?: boolean

OptionalimplicitSources?: string[]

resolveUnknownPathsOnDisk: boolean

OptionaluseProjectType?: ProjectKind

Readonlyrepl

Type Declaration

OptionalautoUseFileProtocol?: boolean

dfProcessorHeat: boolean

hints: boolean

plugins: ConfigPlugin<string>[]

OptionalqueryStats?: boolean

quickStats: boolean

OptionalshowPlugins?: boolean

Readonlysemantics

Readonlysolver

Optional ReadonlyspecializeConfig

Settings

On This Page

`Readonly`abstractInterpretation

`Optional` `Readonly`defaultEngine

`Readonly`defaultPlugins

`Readonly`engines

`Readonly`gas

`Readonly`ignoreLoadCalls

`Readonly`ignoreSourceCalls

`Readonly`incremental

`Optional` `Readonly`inputSources

`Optional`cmdline?: string[]

`Optional`const?: string[]

`Optional`dconst?: string[]

`Optional`ffi?: string[]

`Optional`file?: string[]

`Optional`glob?: string[]

`Optional`lang?: string[]

`Optional`linkedEntryPoints?: { argIdx: ...; argName: ...; call: ...; params: ... }[]

`Optional`linkedObjects?: {
declaredBy?: ...;
fields?: ...;
name: ...;
requires?: ...;
type: ...;
withParams?: ...;
}[]

`Optional`narrowing?: { argIdx?: ...; argName?: ...; call: ... }[]

`Optional`net?: string[]

`Optional`options?: string[]

`Optional`param?: string[]

`Optional`pure?: string[]

`Optional`rand?: string[]

`Optional`scope?: string[]

`Optional`system?: string[]

`Optional`tempfile?: string[]

`Optional`unknown?: string[]

`Optional`user?: string[]

`Readonly`linter

`Optional` `Readonly`logLevel

`Readonly`project

`Optional`assumeImplicitEcho?: boolean

`Optional`basePackages?: string[]

`Optional`classification?: {
notebookExtensions?: (...)[];
shinyDescriptionTypes?: (...)[];
shinyEntryFiles?: (...)[];
shinyUsagePattern?: string;
}

`Optional`notebookExtensions?: (...)[]

`Optional`shinyDescriptionTypes?: (...)[]

`Optional`shinyEntryFiles?: (...)[]

`Optional`shinyUsagePattern?: string

`Optional`discovery?: { full?: boolean; ignore?: (...)[]; perKind?: Partial<(...)> }

`Optional`failOnInaccessiblePath?: boolean

`Optional`implicitSources?: string[]

`Optional`useProjectType?: ProjectKind

`Readonly`repl

`Optional`autoUseFileProtocol?: boolean

`Optional`queryStats?: boolean

`Optional`showPlugins?: boolean

`Readonly`semantics

`Readonly`solver

`Optional` `Readonly`specializeConfig