Types

Core types

JuliaWorkspaces.JuliaWorkspace — Type

struct JuliaWorkspace

The central handle representing a Julia workspace. It wraps a Salsa runtime that holds all mutable inputs (the set of files, the active project, and dynamic-feature results) and memoizes every derived query computed from them. A workspace is manipulated through the mutation functions (add_file!, update_file!, remove_file!, …) and inspected through the query functions (get_diagnostics, get_julia_syntax_tree, …).

Constructor

JuliaWorkspace(; dynamic=DynamicOff, store_path=nothing,
                 symbolcache_download=false,
                 symbolcache_upstream=DEFAULT_SYMBOLCACHE_UPSTREAM,
                 indirect_file_watch_callback=nothing,
                 progress_callback=nothing)

Create an empty workspace. To build one directly from folders on disc, use workspace_from_folders instead.

Keyword arguments

dynamic::DynamicMode: Whether and how to run the out-of-process dynamic feature that indexes environments. See DynamicMode.
store_path::Union{Nothing,String}: Directory used to cache package symbol data (.jstore files). Defaults to a managed scratch space.
symbolcache_download::Bool: If true, allow downloading precomputed symbol caches from symbolcache_upstream rather than indexing locally.
symbolcache_upstream::String: Upstream URL for symbol-cache downloads. Defaults to DEFAULT_SYMBOLCACHE_UPSTREAM.
indirect_file_watch_callback::Union{Nothing,Function}: Invoked once with a URI the first time an indirect file (a file pulled in via include but not explicitly added) is requested. Intended for a host to register a file watcher.
progress_callback::Union{Nothing,Function}: Invoked as (key::String, message::String, percentage::Int) with progress updates while the dynamic feature indexes environments. key identifies the operation (each concurrently running operation — downloading caches for a project, indexing a project, loading caches — is its own progress bar with the full 0–100 range); a report with percentage >= 100 ends that operation's bar.
status_callback::Union{Nothing,Function}: Invoked as (snapshot::DynamicStatusSnapshot) from the dynamic feature's reactor whenever the observable dynamic state changes (a work item is queued, launched, progresses, completes, fails, ...). The callback must not block; hand the snapshot off to a channel or task for any real work.
err_handler::Union{Nothing,Function}: Invoked as (err, bt) when an internal background task of the dynamic feature fails in a way that would otherwise only be printed to stderr (most importantly the reactor task itself). Intended for a host's crash reporting.
max_concurrent_djps::Int: Maximum number of concurrently working dynamic child processes (0 disables the limit). Defaults to 4.
max_failure_attempts::Int: How many terminal failures a project may accumulate before the dynamic feature stops launching child processes for it (0 or less disables the bound). Defaults to DEFAULT_MAX_FAILURE_ATTEMPTS. See retry_failed_dynamic_projects! to clear the budget.
djp_request_timeout_seconds::Int: How long a child process may go without showing progress on one indexing request before the work item is failed (0 or less means no deadline). Defaults to DEFAULT_DJP_REQUEST_TIMEOUT_SECONDS.
resolve_workspace_environments::Bool: When false, no standalone package projects or test environments are created; only real project environments are watched. Defaults to true.