Protected ReadonlyctxThe linked full project context, allowing plugins to modify and access it.
ReadonlyloadingThe loading order context provides access to the loading order of script files in the project.
ReadonlynameA human-readable name of the context. Try to make it unique to avoid confusion in the logs.
Protected ReadonlypluginsThe plugins registered for this context. These build the foundation for applyPlugins.
Record that a file has been considered during dataflow analysis.
Add a file to the context. If the file has a special role, it will be added to the corresponding list of special files. This method also applies any registered FlowrAnalyzerFilePlugins to the file before adding it to the context.
Optionalroles: readonly FileRole[]Add multiple files to the context. This is just a convenience method that calls addFile for each file.
Add multiple requests to the context. This is just a convenience method that calls addRequest for each request.
ProtectedapplyRun all registered plugins on the given args, please be aware that if they are async, it is up to you to await them.
Get all requests that have been added to this context. This is a convenience method that calls FlowrAnalyzerLoadingOrderContext.getLoadingOrder.
Get all files that have been considered during dataflow analysis.
Check if a file exists at the given path, optionally ignoring case.
Whether to ignore case when checking for the file.
Please note that this method checks the file system based on the configuration (see FlowrConfig.project.resolveUnknownPathsOnDisk).
The actual path of the file if it exists, otherwise undefined.
Get all files known to this context.
An array of all files.
Returns the project context this sub-context is attached to
Get a file by its path. Checks both disk-backed files and inline files. However, this will not load new files that have not yet been requested by flowR.
The exact path of the file.
The file if found, otherwise undefined.
The total number of files known to this context (every file added via addFile, both disk-backed and inline).
This is unrelated to getFilesByRole: A file counted here may have no role, one role, or several
(summing getFilesByRole(role).length over all roles can both over-count (multi-role files) and under-count (roleless files) relative to this method).
Files that were merely considered during dataflow analysis (see consideredFilesList) but never actually added to the context are not included.
The number of files currently held by this context.
Get all requests that have been added to this context.
The root paths that were requested for analysis: the folder for a project request, or the containing folder for a single-file request. Useful to report back which inputs did not resolve to anything.
Check if the context has a cached file with the given path.
The path to the file.
Check if the context has a file with the given path. Please note, that this may also check the file system, depending on the configuration (see FlowrConfig.project.resolveUnknownPathsOnDisk).
The path to the file.
If you do not know the exact path or, e.g., casing of the file, use exists instead.
Classify the ProjectKind of the project from its files. A shiny app
is detected first, as apps commonly ship a DESCRIPTION too. The finer distinctions rely on the source
files, which are only known once the dataflow ran; before that a non-package project reports
ProjectKind.Unknown. The result is cached and invalidated whenever the files change.
Reset the context to its initial state.
Resolve the file at path, loading it from disk through the FlowrAnalyzerFilePlugins if unknown.
Until parsers support multiple request types from the virtual context system, we resolve their contents.
The directory the analysis was asked about: a project's folder, or the one holding the requested file(s).
This is the analyzer file context to be modified by all plugins that affect the files. If you are interested in inspecting these files, refer to ReadOnlyFlowrAnalyzerFilesContext. Plugins, however, can use this context directly to modify files.