Skip to main content

php_lsp/lang/
config.rs

1/// Per-category diagnostic toggle flags.
2/// The master `enabled` switch defaults to `true`. Individual category flags
3/// also default to `true`, so all diagnostics are on out of the box; set
4/// `initializationOptions.diagnostics.enabled = false` to silence everything,
5/// or turn off specific categories individually.
6#[derive(Debug, Clone)]
7pub struct DiagnosticsConfig {
8    /// Master switch: when `false`, no diagnostics are emitted. Defaults to `true`.
9    pub enabled: bool,
10    /// Undefined variable references.
11    pub undefined_variables: bool,
12    /// Calls to undefined functions.
13    pub undefined_functions: bool,
14    /// References to undefined classes / interfaces / traits.
15    pub undefined_classes: bool,
16    /// Wrong number of arguments passed to a function.
17    pub arity_errors: bool,
18    /// Return-type mismatches.
19    pub type_errors: bool,
20    /// Calls to `@deprecated` members.
21    pub deprecated_calls: bool,
22    /// Duplicate class / function declarations.
23    pub duplicate_declarations: bool,
24    /// Unused-symbol warnings (unused variables / parameters / methods /
25    /// properties / functions). New in mir 0.22; defaults to `false` so the
26    /// LSP doesn't add noisy warnings to existing workspaces without an
27    /// opt-in. Toggle via `diagnostics.unusedSymbols` in initializationOptions.
28    pub unused_symbols: bool,
29    /// Missing type annotations on interface methods and class properties
30    /// (MissingReturnType, MissingParamType, MissingPropertyType). Off by
31    /// default; opt in via `diagnostics.missingTypes`.
32    pub missing_types: bool,
33    /// Mixed-type usage lints: passing `mixed` to a typed parameter, assigning
34    /// mixed to a typed property, array/property access on mixed, etc. Off by
35    /// default; opt in via `diagnostics.mixedUsage`.
36    pub mixed_usage: bool,
37}
38
39impl Default for DiagnosticsConfig {
40    fn default() -> Self {
41        DiagnosticsConfig {
42            enabled: true,
43            undefined_variables: true,
44            undefined_functions: true,
45            undefined_classes: true,
46            arity_errors: true,
47            type_errors: true,
48            deprecated_calls: true,
49            duplicate_declarations: true,
50            unused_symbols: false,
51            missing_types: false,
52            mixed_usage: false,
53        }
54    }
55}
56
57impl DiagnosticsConfig {
58    /// All categories on. Used in tests and by clients that explicitly enable
59    /// diagnostics without overriding individual flags.
60    #[cfg(test)]
61    pub fn all_enabled() -> Self {
62        DiagnosticsConfig {
63            enabled: true,
64            ..DiagnosticsConfig::default()
65        }
66    }
67
68    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
69        let mut cfg = DiagnosticsConfig::default();
70        let Some(obj) = v.as_object() else { return cfg };
71        let flag = |key: &str| obj.get(key).and_then(|x| x.as_bool()).unwrap_or(true);
72        cfg.enabled = obj.get("enabled").and_then(|x| x.as_bool()).unwrap_or(true);
73        cfg.undefined_variables = flag("undefinedVariables");
74        cfg.undefined_functions = flag("undefinedFunctions");
75        cfg.undefined_classes = flag("undefinedClasses");
76        cfg.arity_errors = flag("arityErrors");
77        cfg.type_errors = flag("typeErrors");
78        cfg.deprecated_calls = flag("deprecatedCalls");
79        cfg.duplicate_declarations = flag("duplicateDeclarations");
80        cfg.unused_symbols = obj
81            .get("unusedSymbols")
82            .and_then(|x| x.as_bool())
83            .unwrap_or(false);
84        cfg.missing_types = obj
85            .get("missingTypes")
86            .and_then(|x| x.as_bool())
87            .unwrap_or(false);
88        cfg.mixed_usage = obj
89            .get("mixedUsage")
90            .and_then(|x| x.as_bool())
91            .unwrap_or(false);
92        cfg
93    }
94}
95
96/// Per-feature capability toggles. All default to `true` (enabled).
97/// Set `initializationOptions.features.<name> = false` to suppress a capability.
98#[derive(Debug, Clone)]
99pub struct FeaturesConfig {
100    pub completion: bool,
101    pub hover: bool,
102    pub definition: bool,
103    pub declaration: bool,
104    pub references: bool,
105    pub document_symbols: bool,
106    pub workspace_symbols: bool,
107    pub rename: bool,
108    pub signature_help: bool,
109    pub inlay_hints: bool,
110    pub semantic_tokens: bool,
111    pub selection_range: bool,
112    pub call_hierarchy: bool,
113    pub document_highlight: bool,
114    pub implementation: bool,
115    pub code_action: bool,
116    pub type_definition: bool,
117    pub code_lens: bool,
118    pub formatting: bool,
119    pub range_formatting: bool,
120    pub on_type_formatting: bool,
121    pub document_link: bool,
122    pub linked_editing_range: bool,
123    pub inline_values: bool,
124}
125
126impl Default for FeaturesConfig {
127    fn default() -> Self {
128        FeaturesConfig {
129            completion: true,
130            hover: true,
131            definition: true,
132            declaration: true,
133            references: true,
134            document_symbols: true,
135            workspace_symbols: true,
136            rename: true,
137            signature_help: true,
138            inlay_hints: true,
139            semantic_tokens: true,
140            selection_range: true,
141            call_hierarchy: true,
142            document_highlight: true,
143            implementation: true,
144            code_action: true,
145            type_definition: true,
146            code_lens: true,
147            formatting: true,
148            range_formatting: true,
149            on_type_formatting: true,
150            document_link: true,
151            linked_editing_range: true,
152            inline_values: true,
153        }
154    }
155}
156
157impl FeaturesConfig {
158    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
159        let mut cfg = FeaturesConfig::default();
160        let Some(obj) = v.as_object() else { return cfg };
161        let flag = |key: &str| obj.get(key).and_then(|x| x.as_bool()).unwrap_or(true);
162        cfg.completion = flag("completion");
163        cfg.hover = flag("hover");
164        cfg.definition = flag("definition");
165        cfg.declaration = flag("declaration");
166        cfg.references = flag("references");
167        cfg.document_symbols = flag("documentSymbols");
168        cfg.workspace_symbols = flag("workspaceSymbols");
169        cfg.rename = flag("rename");
170        cfg.signature_help = flag("signatureHelp");
171        cfg.inlay_hints = flag("inlayHints");
172        cfg.semantic_tokens = flag("semanticTokens");
173        cfg.selection_range = flag("selectionRange");
174        cfg.call_hierarchy = flag("callHierarchy");
175        cfg.document_highlight = flag("documentHighlight");
176        cfg.implementation = flag("implementation");
177        cfg.code_action = flag("codeAction");
178        cfg.type_definition = flag("typeDefinition");
179        cfg.code_lens = flag("codeLens");
180        cfg.formatting = flag("formatting");
181        cfg.range_formatting = flag("rangeFormatting");
182        cfg.on_type_formatting = flag("onTypeFormatting");
183        cfg.document_link = flag("documentLink");
184        cfg.linked_editing_range = flag("linkedEditingRange");
185        cfg.inline_values = flag("inlineValues");
186        cfg
187    }
188}
189
190/// PHPStan integration. Off by default: running a project's own PHPStan
191/// installation takes far longer than the built-in analyzer (seconds, not
192/// milliseconds) and requires a project-specific config, so it's an explicit
193/// opt-in rather than something that fires for every workspace.
194#[derive(Debug, Clone)]
195pub struct PhpstanConfig {
196    pub enabled: bool,
197    /// Executable name or path. Defaults to `phpstan` resolved via `$PATH`;
198    /// set to e.g. `vendor/bin/phpstan` for a project-local install.
199    pub bin_path: String,
200    /// Passed as `-c <path>` when set. Otherwise PHPStan uses its own
201    /// discovery (`phpstan.neon` / `phpstan.neon.dist` in the workspace root).
202    pub config_path: Option<String>,
203}
204
205impl Default for PhpstanConfig {
206    fn default() -> Self {
207        PhpstanConfig {
208            enabled: false,
209            bin_path: "phpstan".to_string(),
210            config_path: None,
211        }
212    }
213}
214
215impl PhpstanConfig {
216    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
217        let mut cfg = PhpstanConfig::default();
218        let Some(obj) = v.as_object() else { return cfg };
219        cfg.enabled = obj
220            .get("enabled")
221            .and_then(|x| x.as_bool())
222            .unwrap_or(false);
223        if let Some(s) = obj.get("binPath").and_then(|x| x.as_str()) {
224            cfg.bin_path = s.to_string();
225        }
226        if let Some(s) = obj.get("configPath").and_then(|x| x.as_str()) {
227            cfg.config_path = Some(s.to_string());
228        }
229        cfg
230    }
231}
232
233/// PHPCS integration. Off by default, same rationale as [`PhpstanConfig`].
234#[derive(Debug, Clone)]
235pub struct PhpcsConfig {
236    pub enabled: bool,
237    /// Executable name or path. Defaults to `phpcs` resolved via `$PATH`;
238    /// set to e.g. `vendor/bin/phpcs` for a project-local install.
239    pub bin_path: String,
240    /// Passed as `--standard=<value>` when set (e.g. `"PSR12"`). Otherwise
241    /// PHPCS uses its own default/ruleset discovery.
242    pub standard: Option<String>,
243}
244
245impl Default for PhpcsConfig {
246    fn default() -> Self {
247        PhpcsConfig {
248            enabled: false,
249            bin_path: "phpcs".to_string(),
250            standard: None,
251        }
252    }
253}
254
255impl PhpcsConfig {
256    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
257        let mut cfg = PhpcsConfig::default();
258        let Some(obj) = v.as_object() else { return cfg };
259        cfg.enabled = obj
260            .get("enabled")
261            .and_then(|x| x.as_bool())
262            .unwrap_or(false);
263        if let Some(s) = obj.get("binPath").and_then(|x| x.as_str()) {
264            cfg.bin_path = s.to_string();
265        }
266        if let Some(s) = obj.get("standard").and_then(|x| x.as_str()) {
267            cfg.standard = Some(s.to_string());
268        }
269        cfg
270    }
271}
272
273/// External static-analysis tools run as child processes and merged into
274/// published diagnostics, in addition to (not instead of) the built-in
275/// analyzer. See [`PhpstanConfig`] / [`PhpcsConfig`] for why they default off.
276#[derive(Debug, Clone, Default)]
277pub struct ExternalToolsConfig {
278    pub phpstan: PhpstanConfig,
279    pub phpcs: PhpcsConfig,
280}
281
282impl ExternalToolsConfig {
283    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
284        let mut cfg = ExternalToolsConfig::default();
285        let Some(obj) = v.as_object() else { return cfg };
286        if let Some(v) = obj.get("phpstan") {
287            cfg.phpstan = PhpstanConfig::from_value(v);
288        }
289        if let Some(v) = obj.get("phpcs") {
290            cfg.phpcs = PhpcsConfig::from_value(v);
291        }
292        cfg
293    }
294}
295
296/// Maximum number of PHP files indexed during a workspace scan.
297/// Prevents excessive memory use on projects with very large vendor trees.
298pub const MAX_INDEXED_FILES: usize = 50_000;
299
300/// Configuration received from the client via `initializationOptions`.
301#[derive(Debug, Clone)]
302pub struct LspConfig {
303    /// PHP version string, e.g. `"8.1"`.  Set explicitly via `initializationOptions`
304    /// or auto-detected from `composer.json` / the `php` binary at startup.
305    pub php_version: Option<String>,
306    /// Glob patterns for paths to exclude from workspace indexing.
307    pub exclude_paths: Vec<String>,
308    /// Glob patterns for paths that must be indexed even if they match an
309    /// `excludePaths` entry.  Patterns are matched against path components
310    /// (same semantics as `excludePaths`).  Example: `["vendor/yiisoft"]`.
311    pub include_paths: Vec<String>,
312    /// Directories of user-supplied PHP stub files to load in addition to the
313    /// bundled built-ins. Each entry is resolved relative to the workspace
314    /// root if not already absolute. Every `.php` file found (recursively) is
315    /// registered as a read-only, highest-precedence symbol source — useful
316    /// for extensions or frameworks the bundled stubs don't cover.
317    pub stub_dirs: Vec<String>,
318    /// Per-category diagnostic toggles.
319    pub diagnostics: DiagnosticsConfig,
320    /// Per-feature capability toggles.
321    pub features: FeaturesConfig,
322    /// Hard cap on the number of PHP files indexed during a workspace scan.
323    /// Defaults to [`MAX_INDEXED_FILES`]. Set lower via `initializationOptions`
324    /// to reduce memory on projects with very large vendor trees.
325    pub max_indexed_files: usize,
326    /// Whether to eagerly index `vendor/` during the workspace scan.
327    ///
328    /// Default `true`: `vendor/` is walked and declaration-extracted
329    /// (name/namespace/signature, no type inference) alongside the rest of
330    /// the workspace, so bare-name completion, workspace symbols, and
331    /// find-implementations/type-hierarchy see vendor classes without extra
332    /// configuration (issues #240, #246). This scan is I/O-bound, not
333    /// CPU-bound, and cheap relative to the fear it usually gets: on real
334    /// fixtures the walk+read+parse+extract for ~5k files runs in ~200ms, and
335    /// unchanged files replay from the on-disk content-hash cache
336    /// (`index/cache.rs`) on subsequent starts. What eager vendor indexing
337    /// does NOT do is pull vendor into the background `warm_analysis_sweep`
338    /// (full type analysis for find-references/rename) — that sweep skips
339    /// vendor files unconditionally (see `document_store::is_vendor_uri`)
340    /// since sweeping the whole vendor tree buys nothing lasting (the
341    /// analysis-result cache is capped, see `ANALYSIS_CACHE_CAP`) and would
342    /// multiply background CPU cost by vendor's file count. A vendor file
343    /// still gets fully analyzed on demand — when a request touches it
344    /// directly, or when it's referenced by a currently-open file (which the
345    /// sweep prioritizes regardless of this flag).
346    ///
347    /// Set `false` to skip `vendor/` entirely on scan (old default): vendor
348    /// files then load only on demand via PSR-4 resolution (composer
349    /// autoload + per-file parse). Useful for very large vendor trees where
350    /// even the cheap declaration scan isn't worth paying for.
351    pub index_vendor: bool,
352    /// Emit extra diagnostic log messages on startup: cache hit/miss ratio,
353    /// workspace root paths, and PSR-4 namespace count.
354    /// Enable via `initializationOptions.debug = true`.
355    pub debug: bool,
356    /// Debounce delay in milliseconds between the last `textDocument/didChange`
357    /// and the parse + analysis run. Defaults to 100 ms. Set lower for
358    /// fast machines / Neovim users; set higher for slow machines or large
359    /// files to reduce thrashing.
360    pub debounce_ms: u64,
361    /// Background-analyze the workspace after indexing (and re-warm after
362    /// edits settle) so find-references / rename answer from warm memos
363    /// instead of paying a cold per-file analysis at request time. Default
364    /// `true`; set `warmAnalysis: false` to trade slower references for a
365    /// smaller resident footprint.
366    pub warm_analysis: bool,
367    /// Extend the background warm-analysis sweep to `vendor/` files (see the
368    /// `index_vendor` docs above for why the ambient sweep skips vendor by
369    /// default). Opt-in and throttled/idle-priority once implemented — ships
370    /// off by default since it's new background CPU cost with no prior
371    /// production data on real vendor-tree sizes (ROADMAP 0c step 2,
372    /// `~/.claude/plans/crispy-noodling-key.md`). **Not implemented yet**:
373    /// setting this to `true` is currently a no-op.
374    pub warm_vendor_analysis: bool,
375    /// Override the on-disk cache directory. When set, used verbatim (no
376    /// schema-version or workspace-hash subdirectories appended). Primarily
377    /// useful in tests and CI environments with non-standard cache locations.
378    /// When absent, falls back to the platform default (`$XDG_CACHE_HOME` /
379    /// `$HOME/.cache` on Unix, `%LOCALAPPDATA%` on Windows).
380    pub cache_path: Option<std::path::PathBuf>,
381    /// How often the background loop persists staged analysis-cache postings
382    /// (reference postings from an in-progress warm sweep or an on-demand
383    /// query freshness pass) to disk. Bounds data loss on an unclean exit
384    /// (crash, kill — anything that skips `shutdown`) to roughly one
385    /// interval. Defaults to 20 s; lower mainly useful in tests.
386    pub flush_interval_ms: u64,
387    /// External static-analysis tool integration (PHPStan / PHPCS). Both
388    /// default off; see [`ExternalToolsConfig`].
389    pub external_tools: ExternalToolsConfig,
390}
391
392impl Default for LspConfig {
393    fn default() -> Self {
394        LspConfig {
395            php_version: None,
396            exclude_paths: Vec::new(),
397            include_paths: Vec::new(),
398            stub_dirs: Vec::new(),
399            diagnostics: DiagnosticsConfig::default(),
400            features: FeaturesConfig::default(),
401            max_indexed_files: MAX_INDEXED_FILES,
402            index_vendor: true,
403            debug: false,
404            debounce_ms: 100,
405            warm_analysis: true,
406            warm_vendor_analysis: false,
407            cache_path: None,
408            flush_interval_ms: 20_000,
409            external_tools: ExternalToolsConfig::default(),
410        }
411    }
412}
413
414impl LspConfig {
415    /// Merge a `.php-lsp.json` value with editor `initializationOptions` /
416    /// `workspace/configuration`. Editor settings win per-key; `excludePaths`,
417    /// `includePaths`, and `stubDirs` arrays are **concatenated** (file entries
418    /// first, editor entries appended) rather than replaced, since exclusion
419    /// patterns and stub directories are both additive.
420    ///
421    /// Hot-reload of `.php-lsp.json` on file change is not supported; the file
422    /// is only read during `initialize` and `did_change_configuration`.
423    pub(crate) fn merge_project_configs(
424        file: Option<&serde_json::Value>,
425        editor: Option<&serde_json::Value>,
426    ) -> serde_json::Value {
427        let mut merged = file
428            .cloned()
429            .unwrap_or(serde_json::Value::Object(Default::default()));
430        let Some(editor_obj) = editor.and_then(|e| e.as_object()) else {
431            return merged;
432        };
433        let merged_obj = merged
434            .as_object_mut()
435            .expect("merged base is always an object");
436        for (key, val) in editor_obj {
437            // excludePaths/includePaths/stubDirs are concatenated rather than replaced.
438            if key == "excludePaths" || key == "includePaths" || key == "stubDirs" {
439                let file_arr = merged_obj
440                    .get(key)
441                    .and_then(|v| v.as_array())
442                    .cloned()
443                    .unwrap_or_default();
444                let editor_arr = val.as_array().cloned().unwrap_or_default();
445                merged_obj.insert(
446                    key.clone(),
447                    serde_json::Value::Array([file_arr, editor_arr].concat()),
448                );
449            } else {
450                merged_obj.insert(key.clone(), val.clone());
451            }
452        }
453        merged
454    }
455
456    pub(crate) fn from_value(v: &serde_json::Value) -> Self {
457        let mut cfg = LspConfig::default();
458        if let Some(ver) = v.get("phpVersion").and_then(|x| x.as_str()) {
459            if crate::lang::autoload::is_valid_php_version(ver) {
460                cfg.php_version = Some(ver.to_string());
461            } else {
462                // Invalid version: skip environment detection, use the latest stubs.
463                cfg.php_version = Some(crate::lang::autoload::PHP_8_5.to_string());
464            }
465        }
466        if let Some(arr) = v.get("excludePaths").and_then(|x| x.as_array()) {
467            cfg.exclude_paths = arr
468                .iter()
469                .filter_map(|x| x.as_str().map(str::to_string))
470                .collect();
471        }
472        if let Some(arr) = v.get("includePaths").and_then(|x| x.as_array()) {
473            cfg.include_paths = arr
474                .iter()
475                .filter_map(|x| x.as_str().map(str::to_string))
476                .collect();
477        }
478        if let Some(arr) = v.get("stubDirs").and_then(|x| x.as_array()) {
479            cfg.stub_dirs = arr
480                .iter()
481                .filter_map(|x| x.as_str().map(str::to_string))
482                .collect();
483        }
484        if let Some(diag_val) = v.get("diagnostics") {
485            cfg.diagnostics = DiagnosticsConfig::from_value(diag_val);
486        }
487        if let Some(feat_val) = v.get("features") {
488            cfg.features = FeaturesConfig::from_value(feat_val);
489        }
490        if let Some(n) = v.get("maxIndexedFiles").and_then(|x| x.as_u64()) {
491            cfg.max_indexed_files = n as usize;
492        }
493        if let Some(b) = v.get("indexVendor").and_then(|x| x.as_bool()) {
494            cfg.index_vendor = b;
495        }
496        if let Some(b) = v.get("debug").and_then(|x| x.as_bool()) {
497            cfg.debug = b;
498        }
499        if let Some(n) = v.get("debounceMs").and_then(|x| x.as_u64()) {
500            cfg.debounce_ms = n.max(1);
501        }
502        if let Some(b) = v.get("warmAnalysis").and_then(|x| x.as_bool()) {
503            cfg.warm_analysis = b;
504        }
505        if let Some(b) = v.get("warmVendorAnalysis").and_then(|x| x.as_bool()) {
506            cfg.warm_vendor_analysis = b;
507        }
508        if let Some(s) = v.get("cachePath").and_then(|x| x.as_str()) {
509            cfg.cache_path = Some(std::path::PathBuf::from(s));
510        }
511        if let Some(n) = v
512            .get("analysisCacheFlushIntervalMs")
513            .and_then(|x| x.as_u64())
514        {
515            cfg.flush_interval_ms = n.max(1);
516        }
517        if let Some(v) = v.get("externalTools") {
518            cfg.external_tools = ExternalToolsConfig::from_value(v);
519        }
520        cfg
521    }
522}
523
524#[cfg(test)]
525mod tests {
526    use super::*;
527
528    /// Snapshot of every default value `LspConfig` (and its nested
529    /// `DiagnosticsConfig`/`FeaturesConfig`) ships with. A default flip like
530    /// `index_vendor: false -> true` (issue #246 fix) shows up here as a diff
531    /// instead of silently changing behavior for every user who never sets
532    /// the option explicitly — the snapshot forces a conscious
533    /// `UPDATE_EXPECT=1` step, which is exactly the point where the author
534    /// should also be checking every test/doc that assumed the old default.
535    #[test]
536    fn default_config_matches_expected_snapshot() {
537        expect_test::expect![[r#"
538            LspConfig {
539                php_version: None,
540                exclude_paths: [],
541                include_paths: [],
542                stub_dirs: [],
543                diagnostics: DiagnosticsConfig {
544                    enabled: true,
545                    undefined_variables: true,
546                    undefined_functions: true,
547                    undefined_classes: true,
548                    arity_errors: true,
549                    type_errors: true,
550                    deprecated_calls: true,
551                    duplicate_declarations: true,
552                    unused_symbols: false,
553                    missing_types: false,
554                    mixed_usage: false,
555                },
556                features: FeaturesConfig {
557                    completion: true,
558                    hover: true,
559                    definition: true,
560                    declaration: true,
561                    references: true,
562                    document_symbols: true,
563                    workspace_symbols: true,
564                    rename: true,
565                    signature_help: true,
566                    inlay_hints: true,
567                    semantic_tokens: true,
568                    selection_range: true,
569                    call_hierarchy: true,
570                    document_highlight: true,
571                    implementation: true,
572                    code_action: true,
573                    type_definition: true,
574                    code_lens: true,
575                    formatting: true,
576                    range_formatting: true,
577                    on_type_formatting: true,
578                    document_link: true,
579                    linked_editing_range: true,
580                    inline_values: true,
581                },
582                max_indexed_files: 50000,
583                index_vendor: true,
584                debug: false,
585                debounce_ms: 100,
586                warm_analysis: true,
587                warm_vendor_analysis: false,
588                cache_path: None,
589                flush_interval_ms: 20000,
590                external_tools: ExternalToolsConfig {
591                    phpstan: PhpstanConfig {
592                        enabled: false,
593                        bin_path: "phpstan",
594                        config_path: None,
595                    },
596                    phpcs: PhpcsConfig {
597                        enabled: false,
598                        bin_path: "phpcs",
599                        standard: None,
600                    },
601                },
602            }"#]]
603        .assert_eq(&format!("{:#?}", LspConfig::default()));
604    }
605
606    /// Every key `LspConfig::from_value`/`DiagnosticsConfig::from_value`/
607    /// `FeaturesConfig::from_value` actually reads — scraped from this
608    /// file's own JSON-object-key lookups, so a newly wired-up option is
609    /// caught automatically, no hand-maintained list to fall out of sync —
610    /// must appear somewhere in `documentation/src/content/docs/configuration.md`.
611    /// This is the gap that let `indexVendor` ship real, tested, and
612    /// completely undocumented for months (issue #246): a user had no way
613    /// to discover the one setting that fixed their exact problem.
614    #[test]
615    fn every_config_key_is_documented() {
616        let source = include_str!("config.rs");
617        let docs = include_str!("../../documentation/src/content/docs/configuration.md");
618
619        let mut keys: Vec<&str> = Vec::new();
620        for marker in ["get(\"", "flag(\""] {
621            let mut rest = source;
622            while let Some(idx) = rest.find(marker) {
623                rest = &rest[idx + marker.len()..];
624                if let Some(end) = rest.find('"') {
625                    keys.push(&rest[..end]);
626                }
627            }
628        }
629        keys.sort_unstable();
630        keys.dedup();
631
632        let undocumented: Vec<&str> = keys
633            .into_iter()
634            .filter(|k| !docs.contains(&format!("`{k}`")))
635            .collect();
636        assert!(
637            undocumented.is_empty(),
638            "config keys read by LspConfig::from_value but missing from \
639             documentation/src/content/docs/configuration.md: {undocumented:?}"
640        );
641    }
642
643    #[test]
644    fn stub_dirs_parses_from_initialization_options() {
645        let v = serde_json::json!({"stubDirs": ["stubs", "/abs/other-stubs"]});
646        let cfg = LspConfig::from_value(&v);
647        assert_eq!(cfg.stub_dirs, vec!["stubs", "/abs/other-stubs"]);
648    }
649
650    #[test]
651    fn stub_dirs_absent_defaults_to_empty() {
652        let cfg = LspConfig::from_value(&serde_json::json!({}));
653        assert!(cfg.stub_dirs.is_empty());
654    }
655
656    /// `stubDirs` is additive like `excludePaths`/`includePaths`: a project's
657    /// `.php-lsp.json` and an editor's `initializationOptions` both listing
658    /// directories must combine, not have one replace the other.
659    #[test]
660    fn stub_dirs_concatenates_file_and_editor_config() {
661        let file = serde_json::json!({"stubDirs": ["project-stubs"]});
662        let editor = serde_json::json!({"stubDirs": ["personal-stubs"]});
663        let merged = LspConfig::merge_project_configs(Some(&file), Some(&editor));
664        let cfg = LspConfig::from_value(&merged);
665        assert_eq!(cfg.stub_dirs, vec!["project-stubs", "personal-stubs"]);
666    }
667}