Merge pull request #12271 from quarto-dev/execution-engine-env/add-filename

 FR: set `QUARTO_DOCUMENT_FILE` to the path of the input file

Author: cderv

dev-docs/package-author-information/execution-environment.qmd

@@ -1,3 +1,4 @@
 - `QUARTO_PROJECT_ROOT` points to the root of the project, or the directory of the file is not in project mode
 - `QUARTO_DOCUMENT_PATH` points to the directory of the document being rendered
+- `QUARTO_DOCUMENT_FILE` points to the source filename of the document being rendered
 - `QUARTO_PROFILE` is set to profile used, e.g `QUARTO_PROFILE=advanced,production` for `quarto render --profile advanced,production`

news/changelog-1.7.md

@@ -138,3 +138,4 @@ All changes included in 1.7:
 - ([#12264](https://github.com/quarto-dev/quarto-cli/issues/12264)): Upgrade `dart-sass` to 1.85.1.
 - ([#11803](https://github.com/quarto-dev/quarto-cli/pull/11803)): Added a new CLI command `quarto call`. First users of this interface are the new `quarto call engine julia ...` subcommands.
 - A new folder `quarto-session-temp` can be created in `.quarto` to store temporary files created by Quarto during a rendering. Reminder: `.quarto` is for internal use of Quarto and should not be versioned (thus added to `.gitignore`).
+- ([#11606](https://github.com/quarto-dev/quarto-cli/discussions/11606)): Added a new `QUARTO_DOCUMENT_FILE` env var available to computation engine to the name of the file currently being rendered.

src/execute/environment.ts

@@ -4,7 +4,7 @@
  * Copyright (C) 2024 Posit Software, PBC
  */
 
-import { dirname } from "../deno_ral/path.ts";
+import { basename, dirname } from "../deno_ral/path.ts";
 import { ExecuteOptions } from "./types.ts";
 import { InternalError } from "../core/lib/error.ts";
 
@@ -14,13 +14,17 @@ export const setExecuteEnvironment: (options: ExecuteOptions) => void = (
   if (options.projectDir) {
     Deno.env.set("QUARTO_PROJECT_ROOT", options.projectDir);
     Deno.env.set("QUARTO_DOCUMENT_PATH", dirname(options.target.source));
+    Deno.env.set("QUARTO_DOCUMENT_FILE", basename(options.target.source));
   } else {
+    // FIXME: This should not be passthrough anymore as singleFileProjectContext always set `options.projectDir`
+    // https://github.com/quarto-dev/quarto-cli/pull/8771
     if (!options.cwd) {
       throw new InternalError(
         "No project directory or current working directory",
       );
     }
     Deno.env.set("QUARTO_PROJECT_ROOT", options.cwd);
     Deno.env.set("QUARTO_DOCUMENT_PATH", options.cwd);
+    Deno.env.set("QUARTO_DOCUMENT_FILE", basename(options.target.source));
   }
 };

tests/docs/smoke-all/julia/execution-env-project/.gitignore

@@ -0,0 +1 @@
+/.quarto/

tests/docs/smoke-all/julia/execution-env-project/_quarto.yml

@@ -0,0 +1,2 @@
+project:
+  type: default

tests/docs/smoke-all/julia/execution-env-project/execution-env-var.qmd

@@ -0,0 +1,33 @@
+---
+title: "Testing env var available in execution in project context"
+format: markdown
+_quarto:
+  tests:
+    markdown:
+      ensureFileRegexMatches:
+      -   
+        - 'QUARTO_PROJECT_ROOT: \S+smoke-all[\\/]julia[\\/]execution-env-project'
+        - 'QUARTO_DOCUMENT_PATH: \S+smoke-all[\\/]julia[\\/]execution-env-project'
+        - 'QUARTO_DOCUMENT_FILE: execution-env-var.qmd'
+      - ['UNDEFINED']
+---
+
+#### Show execution env var
+
+````{julia}
+#| echo: false
+#| output: asis
+function get_env(name, default)
+    haskey(ENV, name) ? ENV[name] : default
+end
+
+# Create the markdown output with the same formatting
+env_vars = """```{=markdown}
+QUARTO_PROJECT_ROOT: $(get_env("QUARTO_PROJECT_ROOT", "UNDEFINED"))
+QUARTO_DOCUMENT_PATH: $(get_env("QUARTO_DOCUMENT_PATH", "UNDEFINED"))
+QUARTO_DOCUMENT_FILE: $(get_env("QUARTO_DOCUMENT_FILE", "UNDEFINED"))
+```
+"""
+
+print(env_vars)
+````

tests/docs/smoke-all/julia/execution-env-var.qmd

@@ -0,0 +1,34 @@
+---
+title: "Testing env var available in execution in single file project context"
+engine: julia
+format: markdown
+_quarto:
+  tests:
+    markdown:
+      ensureFileRegexMatches:
+      -   
+        - 'QUARTO_PROJECT_ROOT: \S+[\\/]smoke-all[\\/]julia'
+        - 'QUARTO_DOCUMENT_PATH: \S+[\\/]smoke-all[\\/]julia'
+        - 'QUARTO_DOCUMENT_FILE: execution-env-var.qmd'
+      - ['UNDEFINED']
+---
+
+#### Show execution env var
+
+````{julia}
+#| echo: false
+#| output: asis
+function get_env(name, default)
+    haskey(ENV, name) ? ENV[name] : default
+end
+
+# Create the markdown output with the same formatting
+env_vars = """```{=markdown}
+QUARTO_PROJECT_ROOT: $(get_env("QUARTO_PROJECT_ROOT", "UNDEFINED"))
+QUARTO_DOCUMENT_PATH: $(get_env("QUARTO_DOCUMENT_PATH", "UNDEFINED"))
+QUARTO_DOCUMENT_FILE: $(get_env("QUARTO_DOCUMENT_FILE", "UNDEFINED"))
+```
+"""
+
+print(env_vars)
+````

tests/docs/smoke-all/jupyter/execution-env-project/.gitignore

@@ -0,0 +1 @@
+/.quarto/

tests/docs/smoke-all/jupyter/execution-env-project/_quarto.yml

@@ -0,0 +1,2 @@
+project:
+  type: default

tests/docs/smoke-all/jupyter/execution-env-project/execution-env-var.qmd

@@ -0,0 +1,32 @@
+---
+title: "Testing env var available in execution in project context"
+format: markdown
+_quarto:
+  tests:
+    markdown:
+      ensureFileRegexMatches:
+      -   
+        - 'QUARTO_PROJECT_ROOT: \S+smoke-all[\\/]jupyter[\\/]execution-env-project'
+        - 'QUARTO_DOCUMENT_PATH: \S+smoke-all[\\/]jupyter[\\/]execution-env-project'
+        - 'QUARTO_DOCUMENT_FILE: execution-env-var.qmd'
+      - ['UNDEFINED']
+---
+
+#### Show execution env var
+
+```{python}
+#| echo: false
+#| output: asis
+import os
+from IPython.display import Markdown
+
+env_vars = (
+    "```{=markdown}\n"
+    f"QUARTO_PROJECT_ROOT: {os.environ.get('QUARTO_PROJECT_ROOT', 'UNDEFINED')}\n"
+    f"QUARTO_DOCUMENT_PATH: {os.environ.get('QUARTO_DOCUMENT_PATH', 'UNDEFINED')}\n"
+    f"QUARTO_DOCUMENT_FILE: {os.environ.get('QUARTO_DOCUMENT_FILE', 'UNDEFINED')}\n"
+    "```\n"
+)
+
+Markdown(env_vars)
+```