Interface ConfigQuery

Type Declaration

• Optional ReadonlyabstractInterpretation?: {
      dataFrame?: (...) | (...);
      followCalls?: (...) | (...) | (...);
      wideningThreshold?: (...) | (...);
  }

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

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

• Optional ReadonlydefaultPlugins?: ((...) | (...) | (...))[]

• Optional Readonlyengines?: ((...) | (...) | (...))[]

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

• Optional Readonlygas?: {
      countedCheckEvery?: (...) | (...);
      features?: (...) | (...);
      heapProvider?: (...) | (...);
      thresholds?: (...) | (...);
      [key: string]: unknown;
  }

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

  • Optional ReadonlycountedCheckEvery?: (...) | (...)

    How many calls one accounting of an armed budget covers (default DefaultCountedCheckEvery). Trades how far a run may overshoot a bound against what the guard costs per node: 1 counts exactly, larger counts coarsely.

  • Optional Readonlyfeatures?: (...) | (...)

    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 v8/performance.memory detection. Return undefined to skip the memory check.

  • Optional Readonlythresholds?: (...) | (...)

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

• Optional ReadonlyignoreLoadCalls?: boolean

• Optional ReadonlyignoreSourceCalls?: boolean

• Optional Readonlyincremental?: { alwaysIncremental?: (...) | (...) | (...); parsing?: (...) | (...) }

• 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 further frameworks; entries are added to what flowR knows already. Usually set per ProjectKind via specializeConfig. See InputClassifierConfig.

  • 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.

    See

    LinkedInputEntryPoint

  • OptionallinkedObjects?: (...) | (...)

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

    See

    LinkedInputObject

  • Optionalnarrowing?: (...) | (...)

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

    See

    NarrowingFunction

  • 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?: (...) | (...) }

• Optional ReadonlylogLevel?: "debug" | "silly" | "trace" | "info" | "warn" | "error" | "fatal"

• Optional Readonlyproject?: {
      assumeImplicitEcho?: (...) | (...) | (...);
      basePackages?: (...) | (...);
      classification?: (...) | (...);
      discovery?: (...) | (...);
      failOnInaccessiblePath?: (...) | (...) | (...);
      implicitSources?: (...) | (...);
      resolveUnknownPathsOnDisk?: (...) | (...) | (...);
      useProjectType?: (...) | (...);
  }

  • OptionalassumeImplicitEcho?: (...) | (...) | (...)

    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?: (...) | (...)

    The packages considered part of R itself; if unset, flowR derives them (for the assumed R version) from the signature database via baseRPackages.

  • Optionalclassification?: (...) | (...)

  • Optionaldiscovery?: (...) | (...)

  • OptionalfailOnInaccessiblePath?: (...) | (...) | (...)

  • OptionalimplicitSources?: (...) | (...)

  • OptionalresolveUnknownPathsOnDisk?: (...) | (...) | (...)

  • OptionaluseProjectType?: (...) | (...)

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

  • OptionalautoUseFileProtocol?: (...) | (...) | (...)

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

  • OptionaldfProcessorHeat?: (...) | (...) | (...)

  • Optionalhints?: (...) | (...) | (...)

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

  • Optionalplugins?: (...) | (...)

  • OptionalqueryStats?: (...) | (...) | (...)

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

  • OptionalquickStats?: (...) | (...) | (...)

  • OptionalshowPlugins?: (...) | (...) | (...)

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

• Optional Readonlysemantics?: { environment?: (...) | (...) }

• Optional Readonlysolver?: {
      assumeAttachedPackages?: (...) | (...);
      evalStrings?: (...) | (...) | (...);
      instrument?: (...) | (...);
      resolveSource?: (...) | (...);
      sigdb?: (...) | (...);
      slicer?: (...) | (...);
      trackEnvironments?: (...) | (...) | (...);
      transitiveSideEffectRounds?: (...) | (...);
      variables?: (...) | (...);
      versionManagement?: (...) | (...);
  }

• Optional ReadonlyspecializeConfig?: {
      notebook?: (...) | (...);
      package?: (...) | (...);
      project?: (...) | (...);
      script?: (...) | (...);
      "shiny-app"?: (...) | (...);
      unknown?: (...) | (...);
  }

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