lsp: Fix ${defaultBuildDir} variable expansion

swyddfa · Oct 21, 2024 · df58b81 · df58b81
1 parent a474a07
commit df58b81
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 1 deletion.
diff --git a/lib/esbonio/changes/918.fix.md b/lib/esbonio/changes/918.fix.md
@@ -0,0 +1,2 @@
+The language server no longer escapes `.` characters in filepaths when expanding the `${defaultBuildDir}` variable
+resulting in weird filepaths
diff --git a/lib/esbonio/esbonio/sphinx_agent/config.py b/lib/esbonio/esbonio/sphinx_agent/config.py
@@ -165,7 +165,7 @@ def to_application_args(self, context: dict[str, Any]) -> dict[str, Any]:
                 continue
 
             replacement = self.resolve_config_variable(match.group(1), context)
-            result = VARIABLE.sub(re.escape(replacement), value)
+            result = VARIABLE.sub(replacement.replace("\\", r"\\"), value)
 
             setattr(self, name, result)
 

diff --git a/lib/esbonio/tests/sphinx-agent/test_sa_unit.py b/lib/esbonio/tests/sphinx-agent/test_sa_unit.py
@@ -473,6 +473,21 @@ def test_cli_arg_handling(args: list[str], expected: dict[str, Any]):
                 "cacheDir": os.sep + os.sep.join(["path", "to", "cache"]),
             },
         ),
+        (
+            ["-M", "html", "src", "${defaultBuildDir}"],
+            application_args(
+                srcdir="src",
+                confdir="src",
+                outdir=os.sep + os.path.join("path", "to", ".cache", "<HASH>", "html"),
+                doctreedir=(
+                    os.sep + os.path.join("path", "to", ".cache", "<HASH>", "doctrees")
+                ),
+                buildername="html",
+            ),
+            {
+                "cacheDir": os.sep + os.sep.join(["path", "to", ".cache"]),
+            },
+        ),
         (
             ["-b", "html", "src", "${defaultBuildDir}"],
             application_args(
@@ -488,6 +503,22 @@ def test_cli_arg_handling(args: list[str], expected: dict[str, Any]):
                 "cacheDir": os.sep + os.sep.join(["path", "to", "cache"]),
             },
         ),
+        (
+            ["-b", "html", "src", "${defaultBuildDir}"],
+            application_args(
+                srcdir="src",
+                confdir="src",
+                outdir=os.sep + os.sep.join(["path", "to", ".cache", "<HASH>"]),
+                doctreedir=(
+                    os.sep
+                    + os.path.join("path", "to", ".cache", r"<HASH>", ".doctrees")
+                ),
+                buildername="html",
+            ),
+            {
+                "cacheDir": os.sep + os.sep.join(["path", "to", ".cache"]),
+            },
+        ),
     ],
 )
 def test_cli_default_build_dir(
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		The language server no longer escapes `.` characters in filepaths when expanding the `${defaultBuildDir}` variable
		resulting in weird filepaths