Class FlowrAnalyzerBuilder

Builder for the FlowrAnalyzer, use it to configure all analysis aspects before creating the analyzer instance with .build() or .buildSync().

You can add new files and folders to analyze using the .addRequest() method on the resulting analyzer.

See

https://github.com/flowr-analysis/flowr/wiki/Analyzer

Example: Let's create an analyzer for a single R script file:

const analyzer = new FlowrAnalyzerBuilder()
                     .setParser(new TreeSitterExecutor())
                     .buildSync()
                     .addRequest('file:///path/to/script.R')

If you now want to get the dataflow information for the file, you can do this:

const dfInfo = await analyzer.dataflow();
console.log(dfInfo);

Index

Constructors

constructor

Methods

amendConfig build buildSync configure registerPlugins setConfig setEngine setInput setParser unregisterPlugins

Constructors

constructor

new FlowrAnalyzerBuilder(withDefaultPlugins?: boolean): FlowrAnalyzerBuilder
Creates a new builder for the FlowrAnalyzer. By default, the standard set of plugins as returned by FlowrConfig#defaultPlugins are registered.
Parameters
- withDefaultPlugins: boolean = true
  Whether to register the default plugins upon creation. Default is true.
Returns FlowrAnalyzerBuilder
See
- FlowrDefaultPlugins - for the default plugin set.
- FlowrAnalyzerBuilder#registerPlugins - to add more plugins.
- FlowrAnalyzerBuilder#unregisterPlugins - to remove plugins.
- Defined in src/project/flowr-analyzer-builder.ts:52

Methods

amendConfig

amendConfig(
    func: (
        config: {
            abstractInterpretation: {
                dataFrame: {
                    maxColNames: number;
                    readLoadedData: { maxReadLines: ...; readExternalFiles: ... };
                };
                followCalls: boolean;
                wideningThreshold: number;
            };
            defaultEngine?: "r-shell"
            | "tree-sitter";
            defaultPlugins: ConfigPlugin<string>[];
            engines: (
                | {
                    lax?: ...;
                    treeSitterWasmPath?: ...;
                    type: ...;
                    wasmPath?: ...;
                    [key: ...]: ...;
                }
                | { pipeBind?: ...; rPath?: ...; type: ...; [key: ...]: ... }
            )[];
            gas: {
                countedCheckEvery?: number;
                features: { [key: string]: (...) | (...) };
                heapProvider?: () => ...;
                thresholds: {
                    memory: {
                        critical?: ...;
                        default?: ...;
                        problematic?: ...;
                        [key: ...]: ...;
                    };
                    steps?: (...)
                    | (...);
                    timeMs: {
                        critical?: ...;
                        default?: ...;
                        problematic?: ...;
                        [key: ...]: ...;
                    };
                    vertices?: (...)
                    | (...);
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            };
            ignoreLoadCalls: boolean;
            ignoreSourceCalls: boolean;
            incremental: {
                alwaysIncremental: boolean;
                parsing: {
                    activated: boolean;
                    heuristics: {
                        activated: ...;
                        alwaysWithEdits: ...;
                        bytesFrom: ...;
                        linesFrom: ...;
                        minFiles: ...;
                        mtime: ...;
                    };
                };
            };
            inputSources?: {
                cmdline?: (...)
                | (...);
                const?: (...) | (...);
                dconst?: (...) | (...);
                ffi?: (...) | (...);
                file?: (...) | (...);
                glob?: (...) | (...);
                lang?: (...) | (...);
                linkedEntryPoints?: (...) | (...);
                linkedObjects?: (...) | (...);
                narrowing?: (...) | (...);
                net?: (...) | (...);
                options?: (...) | (...);
                param?: (...) | (...);
                pure?: (...) | (...);
                rand?: (...) | (...);
                scope?: (...) | (...);
                system?: (...) | (...);
                tempfile?: (...) | (...);
                unknown?: (...) | (...);
                user?: (...) | (...);
            };
            linter: { disabledRules: string[] };
            logLevel?:
                | "debug"
                | "silly"
                | "trace"
                | "info"
                | "warn"
                | "error"
                | "fatal";
            project: {
                assumeImplicitEcho?: boolean;
                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: ConfigPlugin<(...)>[];
                queryStats?: boolean;
                quickStats: boolean;
                showPlugins?: boolean;
            };
            semantics: {
                environment: {
                    overwriteBuiltIns: { definitions: ...; loadDefaults?: ... };
                };
            };
            solver: {
                assumeAttachedPackages?: (...)[];
                evalStrings: boolean;
                instrument: { dataflowExtractors?: (...) | (...) };
                maxOverlayDepth?: number;
                resolveSource?: {
                    applyReplacements?: ...;
                    assumeFilesExist?: ...;
                    dropPaths: ...;
                    ignoreCapitalization: ...;
                    inferWorkingDirectory: ...;
                    repeatedSourceLimit?: ...;
                    searchPath: ...;
                    [key: ...]: ...;
                };
                sigdb: {
                    additionalPaths?: (...)
                    | (...);
                    assumedRVersion?: (...) | (...);
                    autoSync?: (...) | (...) | (...);
                    blobCacheBudgetMb?: (...) | (...);
                    downloadRepo?: (...) | (...);
                    eagerlyLoad: boolean;
                    eagerlyLoadExports: boolean;
                    enabled: boolean;
                    installedLibrary?: (...) | (...);
                    linkBaseR: boolean;
                    linkBaseRCalls?: (...) | (...) | (...);
                    linkDescriptionDependencies: boolean;
                    linkPackageCalls?: (...) | (...) | (...);
                    loadProjectDependencies: boolean;
                    versionOverrides?: (...) | (...);
                    versionSelection?: (...) | (...);
                    warmInBackground?: (...) | (...) | (...);
                };
                slicer?: { autoExtend?: ...; threshold?: ... };
                trackEnvironments: boolean;
                transitiveSideEffectRounds?: number;
                variables: VariableResolve;
                versionManagement?: { linkedVersionGroups?: ... };
            };
            specializeConfig?: {
                notebook?: (...)
                | (...);
                package?: (...) | (...);
                project?: (...) | (...);
                script?: (...) | (...);
                "shiny-app"?: (...) | (...);
                unknown?: (...) | (...);
            };
        },
    ) => void
    | FlowrConfig,
): this
Apply an amendment to the configuration the builder currently holds. This is mostly intended for more complex logic to transform the config. Please consider using FlowrAnalyzerBuilder.configure to set/amend individual values Per default, the value returned by FlowrConfig.default is used.
Parameters
- func: (
      config: {
          abstractInterpretation: {
              dataFrame: {
                  maxColNames: number;
                  readLoadedData: { maxReadLines: ...; readExternalFiles: ... };
              };
              followCalls: boolean;
              wideningThreshold: number;
          };
          defaultEngine?: "r-shell"
          | "tree-sitter";
          defaultPlugins: ConfigPlugin<string>[];
          engines: (
              | {
                  lax?: ...;
                  treeSitterWasmPath?: ...;
                  type: ...;
                  wasmPath?: ...;
                  [key: ...]: ...;
              }
              | { pipeBind?: ...; rPath?: ...; type: ...; [key: ...]: ... }
          )[];
          gas: {
              countedCheckEvery?: number;
              features: { [key: string]: (...) | (...) };
              heapProvider?: () => ...;
              thresholds: {
                  memory: {
                      critical?: ...;
                      default?: ...;
                      problematic?: ...;
                      [key: ...]: ...;
                  };
                  steps?: (...)
                  | (...);
                  timeMs: {
                      critical?: ...;
                      default?: ...;
                      problematic?: ...;
                      [key: ...]: ...;
                  };
                  vertices?: (...)
                  | (...);
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          };
          ignoreLoadCalls: boolean;
          ignoreSourceCalls: boolean;
          incremental: {
              alwaysIncremental: boolean;
              parsing: {
                  activated: boolean;
                  heuristics: {
                      activated: ...;
                      alwaysWithEdits: ...;
                      bytesFrom: ...;
                      linesFrom: ...;
                      minFiles: ...;
                      mtime: ...;
                  };
              };
          };
          inputSources?: {
              cmdline?: (...)
              | (...);
              const?: (...) | (...);
              dconst?: (...) | (...);
              ffi?: (...) | (...);
              file?: (...) | (...);
              glob?: (...) | (...);
              lang?: (...) | (...);
              linkedEntryPoints?: (...) | (...);
              linkedObjects?: (...) | (...);
              narrowing?: (...) | (...);
              net?: (...) | (...);
              options?: (...) | (...);
              param?: (...) | (...);
              pure?: (...) | (...);
              rand?: (...) | (...);
              scope?: (...) | (...);
              system?: (...) | (...);
              tempfile?: (...) | (...);
              unknown?: (...) | (...);
              user?: (...) | (...);
          };
          linter: { disabledRules: string[] };
          logLevel?:
              | "debug"
              | "silly"
              | "trace"
              | "info"
              | "warn"
              | "error"
              | "fatal";
          project: {
              assumeImplicitEcho?: boolean;
              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: ConfigPlugin<(...)>[];
              queryStats?: boolean;
              quickStats: boolean;
              showPlugins?: boolean;
          };
          semantics: {
              environment: {
                  overwriteBuiltIns: { definitions: ...; loadDefaults?: ... };
              };
          };
          solver: {
              assumeAttachedPackages?: (...)[];
              evalStrings: boolean;
              instrument: { dataflowExtractors?: (...) | (...) };
              maxOverlayDepth?: number;
              resolveSource?: {
                  applyReplacements?: ...;
                  assumeFilesExist?: ...;
                  dropPaths: ...;
                  ignoreCapitalization: ...;
                  inferWorkingDirectory: ...;
                  repeatedSourceLimit?: ...;
                  searchPath: ...;
                  [key: ...]: ...;
              };
              sigdb: {
                  additionalPaths?: (...)
                  | (...);
                  assumedRVersion?: (...) | (...);
                  autoSync?: (...) | (...) | (...);
                  blobCacheBudgetMb?: (...) | (...);
                  downloadRepo?: (...) | (...);
                  eagerlyLoad: boolean;
                  eagerlyLoadExports: boolean;
                  enabled: boolean;
                  installedLibrary?: (...) | (...);
                  linkBaseR: boolean;
                  linkBaseRCalls?: (...) | (...) | (...);
                  linkDescriptionDependencies: boolean;
                  linkPackageCalls?: (...) | (...) | (...);
                  loadProjectDependencies: boolean;
                  versionOverrides?: (...) | (...);
                  versionSelection?: (...) | (...);
                  warmInBackground?: (...) | (...) | (...);
              };
              slicer?: { autoExtend?: ...; threshold?: ... };
              trackEnvironments: boolean;
              transitiveSideEffectRounds?: number;
              variables: VariableResolve;
              versionManagement?: { linkedVersionGroups?: ... };
          };
          specializeConfig?: {
              notebook?: (...)
              | (...);
              package?: (...) | (...);
              project?: (...) | (...);
              script?: (...) | (...);
              "shiny-app"?: (...) | (...);
              unknown?: (...) | (...);
          };
      },
  ) => void
  | FlowrConfig
  Receives the current configuration of the builder and allows for amendment.
Returns this
- Defined in src/project/flowr-analyzer-builder.ts:67

build

build(): Promise<FlowrAnalyzer<KnownParser>>
Create the FlowrAnalyzer instance using the given information. Please note that the only reason this is async is that if no parser is set, we need to retrieve the default engine instance which is an async operation. If you have already initialized the engine (e.g., with TreeSitterExecutor#initTreeSitter), you can use the synchronous version FlowrAnalyzerBuilder#buildSync instead.

Returns Promise<FlowrAnalyzer<KnownParser>>
- Defined in src/project/flowr-analyzer-builder.ts:181

buildSync

buildSync(): FlowrAnalyzer
Synchronous version of FlowrAnalyzerBuilder#build, please only use this if you have set the parser using FlowrAnalyzerBuilder#setParser before, otherwise an error will be thrown.

Returns FlowrAnalyzer
- Defined in src/project/flowr-analyzer-builder.ts:202

configure

configure<K extends ValidFlowrConfigPaths | EngineConfigPath>(
key: K,
value: ConfigValueAt<K>,
): this
Set a specific value in the configuration used by the resulting analyzer.

Besides the configuration's own paths this takes an EngineConfigPath, so an engine option that lives in an array entry is reachable the same way as everything else:
Type Parameters
- K extends ValidFlowrConfigPaths | EngineConfigPath
Parameters
- key: K
- value: ConfigValueAt<K>
Returns this
Example
```
new FlowrAnalyzerBuilder()
  .setEngine('tree-sitter')
  .configure('engine.tree-sitter.lax', true)   // parse on, syntax errors and all
```
- Defined in src/project/flowr-analyzer-builder.ts:101

registerPlugins

registerPlugins<T extends string>(
...plugin: readonly PluginToRegister<T>[],
): this
Register one or multiple additional plugins. For the default plugin set, please refer to FlowrDefaultPlugins, they can be registered by passing true to the FlowrAnalyzerBuilder constructor.
Type Parameters
- T extends string
Parameters
- ...plugin: readonly PluginToRegister<T>[]
  One or multiple plugins to register.
Returns this

See
FlowrAnalyzerBuilder#unregisterPlugins to remove plugins.
- Defined in src/project/flowr-analyzer-builder.ts:150

setConfig

setConfig(config: FlowrConfig): this
Overwrite the configuration used by the resulting analyzer. This also unloads all default plugins and reloads them as set in the new config if the withDefaultPlugins flag was set in the constructor
Parameters
- config: FlowrConfig
  The new configuration.
Returns this
- Defined in src/project/flowr-analyzer-builder.ts:78

setEngine

setEngine(engine: "r-shell" | "tree-sitter"): this
Set the engine and hence the parser that will be used by the analyzer. This is an alternative to FlowrAnalyzerBuilder#setParser if you do not have a parser instance at hand.
Parameters
- engine: "r-shell" | "tree-sitter"
  The engine to analyze with; its own options are set with configure (engine.tree-sitter.lax, ...).
Returns this
- Defined in src/project/flowr-analyzer-builder.ts:129

setInput

setInput(input: Omit<NormalizeRequiredInput, "context">): this
Additional parameters for the analyses.
Parameters
- input: Omit<NormalizeRequiredInput, "context">
  The input.
Returns this
- Defined in src/project/flowr-analyzer-builder.ts:138

setParser

setParser(parser: KnownParser): this
Set the parser instance used by the analyzer. This is an alternative to FlowrAnalyzerBuilder#setEngine if you already have a parser instance. Please be aware, that if you want to parallelize multiple analyzers, there should be separate parser instances.
Parameters
- parser: KnownParser
Returns this
- Defined in src/project/flowr-analyzer-builder.ts:118

unregisterPlugins

unregisterPlugins(
...plugin: readonly (string | FlowrAnalyzerPlugin<unknown, unknown>)[],
): this
Remove one or multiple plugins.
Parameters
- ...plugin: readonly (string | FlowrAnalyzerPlugin<unknown, unknown>)[]
Returns this

See
FlowrAnalyzerBuilder#registerPlugins to add plugins.
- Defined in src/project/flowr-analyzer-builder.ts:164

Class FlowrAnalyzerBuilder

See

Example: Let's create an analyzer for a single R script file:

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FlowrAnalyzerBuilder

See

Methods

amendConfig

Parameters

Returns this

build

Returns Promise<FlowrAnalyzer<KnownParser>>

buildSync

Returns FlowrAnalyzer

configure

Type Parameters

Parameters

Returns this

Example

registerPlugins

Type Parameters

Parameters

Returns this

See

setConfig

Parameters

Returns this

setEngine

Parameters

Returns this

setInput

Parameters

Returns this

setParser

Parameters

Returns this

unregisterPlugins

Parameters

Returns this

See

Settings

On This Page