Make the working directory from which build tools are invoked configurable

[stanmart]

Preliminary questions [Required]

Disable all the other extensions except for LaTeX Workshop, restart VS Code, and check that you can not see the requested feature. [Required]

You still see this issue?: Yes

Make sure to visit the wiki FAQ before requesting a feature.

You visited the wiki?: Yes

If your requested feature is with compiling a document (not having to do with finding the root file of a project), check first that you can compile manually.

You can compile a TeX document manually?: Yes

Is your requested feature related to a problem? Please describe. [Required]

I generally have a directory structure as follows:

project-root-dir
├── out
│   ├── figures
│   │   ├── figures-to-include-in-pdf
│   └── paper
│       └── my_paper.pdf
└── src
    ├── figures
    │   └──scripts-to-create-figures
    └── paper
        └── paper.tex

When setting up build scripts (e.g. via snakemake), I assume that every command is called from the root directory of the project (project-root-dir). It implies that I call latexmk as something like latexmk -jobname=out/paper/paper src/paper/paper.tex. Consequently, when including tex files and figures, I use the relative path from the project root (e.g. includegraphics{out/figures/figure.pdf}).

I managed to make LaTeX-Workshop follow a similar behavior with one big difference. The main issue is that LaTeX-Workshop changes the current working directory to src/paper (the location of the tex file) before compilation, and basically calls latexmk from there. Consequently, a different relative path is required to include files and figures (e.g. includegraphics{../../out/figures/figure.pdf}).

It would be extremely convinient if the working directory from which latexmk (or texify/pdflatex/etc.) are invoked could be set in LaTeX-Workshop, similarly to, for example, latex-workshop.latex.outDir.

Describe the solution you'd like [Required]

Add a new option to LaTeX-Workshop, for example latex-workshop.latex.workingDir. It should do the following:

• When building the project, the relevand command (latexmk/texify/pdflatex/etc.) is invoked from a shell where the current working directory is latex-workshop.latex.workingDir
• Figure preview on hover and path autocompletion in the editor, should also assume that all paths are relative to latex-workshop.latex.workingDir

Logs [Required]

Please paste the whole log messages here, not parts of ones. The log should start with Initializing LaTeX Workshop. It is very important to identify problems.

LaTeX Workshop Output [Required]

[16:41:49] Initializing LaTeX Workshop.
[16:41:49] Extension root: c:\Users\mstancs\.vscode\extensions\james-yu.latex-workshop-8.29.0
[16:41:49] $PATH: C:\Program Files\PowerShell\7;C:\Program Files (x86)\Common Files\Oracle\Java\javapath;C:\windows\system32;C:\windows;C:\windows\System32\Wbem;C:\windows\System32\WindowsPowerShell\v1.0\;C:\windows\System32\OpenSSH\;C:\Program Files\MiKTeX 2.9\miktex\bin\x64\;C:\Program Files\MATLAB\R2020b\runtime\win64;C:\Program Files\MATLAB\R2020b\bin;C:\Program Files\dotnet\;C:\Program Files\WireGuard\;C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\;C:\Program Files\PowerShell\7\;C:\Program Files\Docker\Docker\resources\bin;C:\ProgramData\DockerDesktop\version-bin;C:\Users\mstancs\scoop\apps\haskell\current\lib\bin;C:\Users\mstancs\scoop\apps\nodejs\current\bin;C:\Users\mstancs\scoop\apps\nodejs\current;C:\Users\mstancs\scoop\apps\gcc\current\bin;C:\Users\mstancs\scoop\apps\perl\current\perl\site\bin;C:\Users\mstancs\scoop\apps\perl\current\perl\bin;C:\Users\mstancs\scoop\apps\perl\current\c\bin;C:\Users\mstancs\scoop\apps\haskell\current\lib\extralibs\bin;C:\Users\mstancs\.cargo\bin;C:\Users\mstancs\Miniconda3;C:\Users\mstancs\Miniconda3\Library\mingw-w64\bin;C:\Users\mstancs\Miniconda3\Library\usr\bin;C:\Users\mstancs\Miniconda3\Library\bin;C:\Users\mstancs\Miniconda3\Scripts;C:\Users\mstancs\scoop\shims;C:\Users\mstancs\AppData\Local\Microsoft\WindowsApps;C:\Users\mstancs\AppData\Local\Programs\Microsoft VS Code\bin;C:\Program Files\7-Zip;C:\Users\mstancs\.dotnet\tools;C:\Users\mstancs\.cabal\bin
[16:41:49] $SHELL: undefined
[16:41:49] $LANG: undefined
[16:41:49] $LC_ALL: undefined
[16:41:49] process.platform: win32
[16:41:49] process.arch: x64
[16:41:49] vscode.env.appName: Visual Studio Code
[16:41:49] vscode.env.remoteName: undefined
[16:41:49] vscode.env.uiKind: 1
[16:41:49] Configuration for workspace: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation
[16:41:49] editor.acceptSuggestionOnEnter: "on"
[16:41:49] latex-workshop.bind.enter.key: true
[16:41:49] latex-workshop.docker.enabled: false
[16:41:49] latex-workshop.docker.image.latex: ""
[16:41:49] latex-workshop.hover.preview.mathjax.extensions: []
[16:41:49] latex-workshop.intellisense.package.enabled: true
[16:41:49] latex-workshop.intellisense.update.aggressive.enabled: false
[16:41:49] latex-workshop.intellisense.update.delay: 1000
[16:41:49] latex-workshop.latex.autoBuild.run: "onFileChange"
[16:41:49] latex-workshop.latex.build.forceRecipeUsage: true
[16:41:49] latex-workshop.latex.outDir: "%WORKSPACE_FOLDER%/out/%DOCFILE%/"
[16:41:49] latex-workshop.latex.recipes: [
 {
  "name": "latexmk 🔃",
  "tools": [
   "latexmk"
  ]
 }
]
[16:41:49] latex-workshop.latex.tools: [
 {
  "name": "latexmk",
  "command": "latexmk",
  "args": [
   "-e",
   "$pdflatex=q/pdflatex %O -synctex=1 -interaction=nonstopmode -file-line-error %S/",
   "-outdir=%OUTDIR%",
   "-pdf",
   "-shell-escape",
   "%DOC%"
  ]
 }
]
[16:41:49] latex-workshop.viewer.pdf.internal.keyboardEvent: "auto"
[16:41:49] Creating a new file watcher.
[16:41:49] watcherOptions: {"useFsEvents":false,"usePolling":false,"interval":300,"binaryInterval":1000,"awaitWriteFinish":{"stabilityThreshold":250}}
[16:41:49] Creating PDF file watcher.
[16:41:49] watcherOptions: {"useFsEvents":false,"usePolling":false,"interval":300,"binaryInterval":1000,"awaitWriteFinish":{}}
[16:41:49] Creating Bib file watcher.
[16:41:49] watcherOptions: {"useFsEvents":false,"usePolling":false,"interval":300,"binaryInterval":1000,"awaitWriteFinish":{"stabilityThreshold":250}}
[16:41:49] Set $LATEXWORKSHOP_DOCKER_LATEX: ""
[16:41:50] pdflatex is provided by MiKTeX
[16:41:50] [Server] Creating LaTeX Workshop http and websocket server.
[16:41:51] LaTeX Workshop initialized.
[16:41:51] Trigger characters for intellisense of LaTeX documents: ["\\",",","{"]
[16:41:51] Bibtex format config: {"tab":"  ","case":"lowercase","left":"{","right":"}","trailingComma":false,"sort":["key"],"alignOnEqual":true,"sortFields":false,"fieldsOrder":[],"firstEntries":["string","xdata"]}
[16:41:51] Current workspace folders: ["file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation"]
[16:41:51] Found root file from active editor: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:06] Root file changed: from undefined to c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:06] Start to find all dependencies.
[16:42:06] Root file languageId: latex
[16:42:06] [Server] Server successfully started: {"address":"127.0.0.1","family":"IPv4","port":56775}
[16:42:06] Reset file watcher.
[16:42:06] Parsing a file and its subfiles: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:06] Found .bib file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\references.bib
[16:42:06] Added to bib file watcher: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\references.bib
[16:42:06] Parsing .bib entries from c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\references.bib
[16:42:07] Added to file watcher: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:07] onDidSaveTextDocument triggered: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/src/paper/paper.tex
[16:42:07] Current workspace folders: ["file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation"]
[16:42:07] onDidSaveTextDocument triggered: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/src/paper/paper.tex
[16:42:07] Found root file from active editor: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:07] Keep using the same root file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:07] [Server] valdOrigin is http://127.0.0.1:56775
[16:42:07] Parsed 18 bib entries from c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\references.bib.
[16:42:07] Parse fls file.
[16:42:07] Fls file found: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\out\paper\paper.fls
[16:42:07] Parse aux file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\out\paper\paper.aux
[16:42:07] Current workspace folders: ["file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation"]
[16:42:07] The active document cannot be used as the root file: output:extension-output-valentjn.vscode-ltex-%231-LTeX Language Client
[16:42:08] The active document cannot be used as the root file: output:extension-output-valentjn.vscode-ltex-%231-LTeX Language Client
[16:42:08] Current workspaceRootDir: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation
[16:42:08] Snippet data loaded.
[16:42:09] Checking for duplicate labels: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex.
[16:42:09] Manager.fileWatcher.getWatched: {"c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\src\\paper":["paper.tex"],"c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\out\\figures":["equilibrium_nf.png"]}
[16:42:09] Manager.filesWatched: ["c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\src\\paper\\paper.tex","c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\out\\figures\\equilibrium_nf.png"]
[16:42:09] BibWatcher.bibWatcher.getWatched: {"c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\src\\paper":["references.bib"]}
[16:42:09] BibWatcher.bibsWatched: ["c:\\Users\\mstancs\\GDrive\\UZH\\research\\PlatformMarketPower\\ValueOfIntermediation\\src\\paper\\references.bib"]
[16:42:09] PdfWatcher.pdfWatcher.getWatched: {}
[16:42:09] PdfWatcher.pdfsWatched: []
[16:42:09] PdfWatcher.watchedPdfVirtualUris: []
[16:42:09] PdfWatcher.ignoredPdfUris: []
[16:42:09] Added to file watcher: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\out\figures\equilibrium_nf.png
[16:42:10] Fls file found: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\out\paper\paper.fls
[16:42:10] Found files that might be root, choose the first one: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:10] Keep using the same root file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:14] Current workspace folders: ["file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation"]
[16:42:14] Found root file from active editor: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:14] Keep using the same root file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:16] onDidSaveTextDocument triggered: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/src/paper/paper.tex
[16:42:16] File watcher - file changed: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:16] Parsing a file and its subfiles: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:16] Found .bib file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\references.bib
[16:42:18] Checking for duplicate labels: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex.
[16:42:18] Auto build started detecting the change of a file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:18] BUILD command invoked.
[16:42:18] The document of the active editor: file:///c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/src/paper/paper.tex
[16:42:18] The languageId of the document: latex
[16:42:18] Building root file: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:18] Build root file c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex
[16:42:18] outDir: c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/out/paper/
[16:42:18] Recipe step 1: latexmk
[16:42:18] Recipe step 1 args: ["--max-print-line=10000","-e","$pdflatex=q/pdflatex %O -synctex=1 -interaction=nonstopmode -file-line-error %S/","-outdir=c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/out/paper/","-pdf","-shell-escape","c:/Users/mstancs/GDrive/UZH/research/PlatformMarketPower/ValueOfIntermediation/src/paper/paper"]
[16:42:18] Recipe step env: undefined
[16:42:18] cwd: c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper
[16:42:18] LaTeX build process spawned. PID: 31608.
[16:42:21] Recipe of length 1 finished. PID: 31608.
[16:42:21] Successfully built c:\Users\mstancs\GDrive\UZH\research\PlatformMarketPower\ValueOfIntermediation\src\paper\paper.tex.

Desktop [Required]

Please write exact version numbers. Please don't write latest instead of exact numbers.

• OS: Windows 10 (21H1)
• VS Code version: [e.g. 1.71.0]
• Extension version: [e.g. 8.29.0]
• TeX distribution version: [MiKTeX 2.9.7338]

Additional questions

Are you using VSCodium?

No

Are you using the Snap or Flatpack versions of VS Code?

No

Are you using LaTeX Workshop with VS Code Remote?

No

[James-Yu]

I’ve checked the code and see this use case not covered. Can you give some word on the reason of moving to discussion? Thanks! @tamuratak

[tamuratak]

src/components/builder.ts is not maintainable. We must not add features to it.