Skip to content
Snippets Groups Projects
package.json 67.8 KiB
Newer Older
James-Yu's avatar
James-Yu committed
{
James-Yu's avatar
James-Yu committed
  "name": "latex-workshop",
  "displayName": "LaTeX Workshop",
James-Yu's avatar
James-Yu committed
  "description": "Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.",
James-Yu's avatar
James-Yu committed
  "icon": "icons/icon.png",
James-Yu's avatar
James-Yu committed
  "version": "8.9.0",
James-Yu's avatar
James-Yu committed
  "publisher": "James-Yu",
  "license": "MIT",
  "homepage": "https://github.com/James-Yu/LaTeX-Workshop",
  "repository": {
    "type": "git",
    "url": "https://github.com/James-Yu/LaTeX-Workshop.git"
  },
  "engines": {
    "vscode": "^1.38.0"
James-Yu's avatar
James-Yu committed
  },
  "categories": [
    "Programming Languages",
James-Yu's avatar
James-Yu committed
    "Snippets"
  ],
  "keywords": [
    "latex",
    "tex",
    "compile",
    "preview",
    "hint"
  ],
  "activationEvents": [
    "onLanguage:latex-expl3",
Jerome Lelong's avatar
Jerome Lelong committed
    "onLanguage:doctex",
    "onLanguage:rsweave",
James-Yu's avatar
James-Yu committed
    "onLanguage:pdf",
    "onLanguage:bibtex",
    "onCommand:latex-workshop.recipes",
    "onCommand:latex-workshop.view",
    "onCommand:latex-workshop.tab",
    "onCommand:latex-workshop.synctex",
    "onCommand:latex-workshop.clean",
    "onCommand:latex-workshop.citation",
    "onCommand:latex-workshop.compilerlog",
    "onCommand:latex-workshop.log",
    "onCommand:latex-workshop.actions",
    "onCommand:latex-workshop.bibsort",
    "onCommand:latex-workshop.bibalign",
    "onCommand:latex-workshop.bibalignsort",
    "onWebviewPanel:latex-workshop-pdf"
James-Yu's avatar
James-Yu committed
  ],
  "main": "./out/src/main.js",
James-Yu's avatar
James-Yu committed
  "contributes": {
    "languages": [
James-Yu's avatar
James-Yu committed
        "aliases": [
          "TeX",
          "tex"
        ],
        "extensions": [
          ".sty",
          ".cls",
          ".bbx",
James-Yu's avatar
James-Yu committed
        ],
        "configuration": "./syntax/syntax.json"
      },
Jerome Lelong's avatar
Jerome Lelong committed
        "id": "doctex",
        "aliases": [
Jerome Lelong's avatar
Jerome Lelong committed
          "DocTeX",
          "doctex"
        ],
        "extensions": [
Jerome Lelong's avatar
Jerome Lelong committed
        "configuration": "./syntax/syntax-doctex.json"
James-Yu's avatar
James-Yu committed
      {
James-Yu's avatar
James-Yu committed
        "aliases": [
          "LaTeX",
          "latex"
        ],
        "extensions": [
James-Yu's avatar
James-Yu committed
        ],
James-Yu's avatar
James-Yu committed
        "configuration": "./syntax/syntax.json"
James-Yu's avatar
James-Yu committed
        "aliases": [
          "BibTeX",
          "bibtex"
        ],
        "extensions": [
          ".bib"
        ]
      },
Zeping Lee's avatar
Zeping Lee committed
      {
        "id": "bibtex-style",
        "aliases": [
          "BibTeX style"
        ],
        "extensions": [
          ".bst"
        ]
      },
James-Yu's avatar
James-Yu committed
      {
        "id": "latex-expl3",
        "aliases": [
James-Yu's avatar
James-Yu committed
        ],
        "configuration": "./syntax/syntax-expl3.json"
James-Yu's avatar
James-Yu committed
      },
      {
        "id": "pdf",
        "aliases": [
          "Plain Text (PDF)",
          "pdf"
        ],
        "extensions": [
          ".pdf"
        ]
      },
      {
        "id": "rsweave",
        "aliases": [
          "R Sweave"
        ],
        "extensions": [
          ".rnw",
          ".Rnw",
          ".Rtex",
        ],
        "configuration": "./syntax/syntax-rsweave.json"
James-Yu's avatar
James-Yu committed
      }
James-Yu's avatar
James-Yu committed
    ],
James-Yu's avatar
James-Yu committed
    "grammars": [
James-Yu's avatar
James-Yu committed
      {
James-Yu's avatar
James-Yu committed
        "scopeName": "text.tex",
        "path": "./syntax/TeX.tmLanguage.json"
James-Yu's avatar
James-Yu committed
      },
Jerome Lelong's avatar
Jerome Lelong committed
        "language": "doctex",
        "scopeName": "text.tex.doctex",
        "path": "./syntax/DocTeX.tmLanguage.json"
James-Yu's avatar
James-Yu committed
      {
        "language": "latex",
James-Yu's avatar
James-Yu committed
        "scopeName": "text.tex.latex",
        "path": "./syntax/LaTeX.tmLanguage.json",
        "embeddedLanguages": {
          "source.asymptote": "asymptote",
          "source.cpp": "cpp",
          "source.css": "css",
          "source.dot": "dot",
          "source.gnuplot": "gnuplot",
          "text.html": "html",
          "source.java": "java",
          "source.js": "javascript",
          "source.lua": "lua",
          "source.python": "python",
          "source.ruby": "ruby",
          "source.scala": "scala",
          "source.ts": "typescript",
          "text.xtml": "xtml",
          "source.yaml": "yaml"
James-Yu's avatar
James-Yu committed
      },
      {
        "language": "bibtex",
James-Yu's avatar
James-Yu committed
        "scopeName": "text.bibtex",
        "path": "./syntax/Bibtex.tmLanguage.json"
James-Yu's avatar
James-Yu committed
      },
Zeping Lee's avatar
Zeping Lee committed
      {
        "language": "bibtex-style",
        "scopeName": "source.bst",
        "path": "./syntax/BibTeX-style.tmLanguage.json"
Zeping Lee's avatar
Zeping Lee committed
      },
James-Yu's avatar
James-Yu committed
      {
        "language": "latex-expl3",
        "scopeName": "text.tex.latex.expl3",
        "path": "./syntax/LaTeX-Expl3.tmLanguage.json"
      },
      {
        "scopeName": "markdown.latex.codeblock",
        "path": "./syntax/latexblock.json",
        "injectTo": [
          "text.html.markdown"
        ],
        "embeddedLanguages": {
          "meta.embedded.block.latex": "latex"
        }
      },
      {
        "language": "cpp",
        "scopeName": "source.cpp.embedded.latex",
        "path": "./syntax/cpp-grammar-bailout.tmLanguage.json",
        "embeddedLanguages": {
          "meta.embedded.assembly.cpp": "asm"
        }
      },
      {
        "language": "rsweave",
        "scopeName": "text.tex.latex.rsweave",
        "path": "./syntax/RSweave.tmLanguage.json",
        "embeddedLanguages": {
James-Yu's avatar
James-Yu committed
          "source.r": "r"
James-Yu's avatar
James-Yu committed
      }
James-Yu's avatar
James-Yu committed
    ],
    "snippets": [
      {
        "language": "latex",
        "path": "./snippets/latex.json"
      },
      {
        "language": "rsweave",
        "path": "./snippets/latex.json"
      },
      {
        "language": "latex-expl3",
        "path": "./snippets/latex.json"
James-Yu's avatar
James-Yu committed
    "commands": [
      {
        "command": "latex-workshop.navigate-envpair",
        "title": "Navigate to matching begin/end",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.select-envname",
        "title": "Select the current environment name",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.multicursor-envname",
        "title": "Add a multicursor to the current environment name",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.wrap-env",
        "title": "Surround selection with \\begin{}...\\end{}",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.close-env",
        "title": "Close current environment",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.toggle-equation-envname",
        "title": "Toggle between \\[...\\] and \\begin{}...\\end{}",
        "category": "LaTeX Workshop"
      {
        "command": "latex-workshop.saveWithoutBuilding",
        "title": "Save without Building",
        "category": "LaTeX Workshop"
      },
James-Yu's avatar
James-Yu committed
      {
        "command": "latex-workshop.build",
        "title": "Build LaTeX project",
        "category": "LaTeX Workshop"
James-Yu's avatar
James-Yu committed
      },
      {
        "command": "latex-workshop.recipes",
        "title": "Build with recipe",
        "category": "LaTeX Workshop"
      },
James-Yu's avatar
James-Yu committed
      {
        "command": "latex-workshop.view",
        "title": "View LaTeX PDF file",
        "category": "LaTeX Workshop",
James-Yu's avatar
James-Yu committed
        "icon": {
          "light": "icons/view-pdf-light.svg",
          "dark": "icons/view-pdf-dark.svg"
        "command": "latex-workshop.tab",
        "title": "View LaTeX PDF file in VSCode tab",
        "category": "LaTeX Workshop"
      },
        "command": "latex-workshop.refresh-viewer",
        "title": "Refresh all LaTeX PDF viewers",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.kill",
        "title": "Kill LaTeX compiler process",
        "category": "LaTeX Workshop"
      },
James-Yu's avatar
James-Yu committed
      {
        "command": "latex-workshop.synctex",
        "title": "SyncTeX from cursor",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.clean",
James-Yu's avatar
James-Yu committed
        "title": "Clean up auxiliary files",
        "category": "LaTeX Workshop"
      {
        "command": "latex-workshop.citation",
        "title": "Open citation browser",
        "category": "LaTeX Workshop"
      },
        "command": "latex-workshop.addtexroot",
James-Yu's avatar
James-Yu committed
        "title": "Insert %!TeX root magic comment",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.log",
        "title": "Show LaTeX Workshop messages",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.actions",
        "title": "LaTeX actions",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop-dev.parselog",
        "title": "Parse current document as LaTeX logs",
        "category": "LaTeX Workshop DevTools"
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop-dev.parsetex",
        "title": "Parse current file as LaTeX AST",
        "category": "LaTeX Workshop DevTools"
      },
      {
        "command": "latex-workshop-dev.parsebib",
        "title": "Parse current file as BibTeX AST",
James-Yu's avatar
James-Yu committed
        "category": "LaTeX Workshop DevTools"
      },
      {
        "command": "latex-workshop.texdoc",
        "title": "Show package documentation",
        "category": "LaTeX Workshop"
      {
        "command": "latex-workshop.texdocUsepackages",
        "title": "Show package documentation actually used",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.promote-sectioning",
        "title": "Promote all the section levels used in the selection",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.demote-sectioning",
        "title": "Demote all the section levels used in the selection",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.showCompilationPanel",
        "title": "Show LaTeX Compilation Info",
        "category": "LaTeX Workshop"
      {
        "command": "latex-structure.toggle-follow-cursor",
        "title": "Toggle follow cursor",
        "category": "LaTeX Workshop"
tecosaur's avatar
tecosaur committed
      {
        "command": "latex-workshop.showSnippetPanel",
        "title": "Show Snippet Panel",
tecosaur's avatar
tecosaur committed
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.bibsort",
        "title": "Sort BibTeX file",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.bibalign",
        "title": "Align BibTeX file",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.bibalignsort",
        "title": "Sort and align BibTeX file",
        "category": "LaTeX Workshop"
James-Yu's avatar
James-Yu committed
      }
James-Yu's avatar
James-Yu committed
    ],
James-Yu's avatar
James-Yu committed
    "keybindings": [
      {
        "key": "ctrl+l alt+b",
        "mac": "cmd+l alt+b",
        "when": "editorLangId =~ /latex|rsweave/ && config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+l alt+c",
        "mac": "cmd+l alt+c",
        "when": "editorLangId =~ /latex|rsweave/ && config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+l alt+v",
        "mac": "cmd+l alt+v",
        "when": "editorLangId =~ /latex|rsweave/ && config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+l alt+j",
        "mac": "cmd+l alt+j",
        "when": "editorTextFocus && editorLangId == 'latex' && config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+l alt+x",
        "mac": "cmd+l alt+x",
        "command": "workbench.view.extension.latex",
        "when": "config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+alt+b",
        "mac": "cmd+alt+b",
        "command": "latex-workshop.build",
        "when": "editorLangId =~ /latex|rsweave/ && !config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+alt+c",
        "mac": "cmd+alt+c",
        "command": "latex-workshop.clean",
        "when": "editorLangId =~ /latex|rsweave/ && !config.latex-workshop.bind.altKeymap.enabled"
      },
      {
        "key": "ctrl+alt+v",
        "mac": "cmd+alt+v",
        "command": "latex-workshop.view",
        "when": "editorLangId =~ /latex|rsweave/ && !config.latex-workshop.bind.altKeymap.enabled"
      },
      {
        "key": "ctrl+alt+j",
        "mac": "cmd+alt+j",
        "command": "latex-workshop.synctex",
        "when": "editorTextFocus && editorLangId == 'latex' && !config.latex-workshop.bind.altKeymap.enabled"
      },
      {
        "key": "ctrl+alt+x",
        "mac": "cmd+alt+x",
        "command": "workbench.view.extension.latex",
        "when": "!config.latex-workshop.bind.altKeymap.enabled"
        "key": "ctrl+l [",
        "mac": "cmd+l [",
        "when": "config.latex-workshop.bind.altKeymap.enabled && editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
        "command": "latex-workshop.promote-sectioning"
        "when": "config.latex-workshop.bind.altKeymap.enabled && editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
        "command": "latex-workshop.demote-sectioning"
      },
      {
        "key": "ctrl+alt+[",
        "mac": "cmd+alt+[",
        "when": "!config.latex-workshop.bind.altKeymap.enabled && editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
        "command": "latex-workshop.promote-sectioning"
      },
      {
        "key": "ctrl+alt+]",
        "mac": "cmd+alt+]",
        "when": "!config.latex-workshop.bind.altKeymap.enabled && editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
        "command": "latex-workshop.demote-sectioning"
        "key": "ctrl+l ctrl+enter",
        "mac": "cmd+l cmd+enter",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.item"
      },
      {
        "key": "ctrl+l ctrl+b",
        "mac": "cmd+l cmd+b",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textbf"
        "key": "ctrl+l ctrl+i",
        "mac": "cmd+l cmd+i",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textit"
        "key": "ctrl+l ctrl+u",
        "mac": "cmd+l cmd+u",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.underline"
        "key": "ctrl+l ctrl+e",
        "mac": "cmd+l cmd+e",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
        "command": "latex-workshop.shortcut.emph"
        "key": "ctrl+l ctrl+r",
        "mac": "cmd+l cmd+r",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textrm"
        "key": "ctrl+l ctrl+t",
        "mac": "cmd+l cmd+t",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.texttt"
        "key": "ctrl+l ctrl+s",
        "mac": "cmd+l cmd+s",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textsl"
        "key": "ctrl+l ctrl+c",
        "mac": "cmd+l cmd+c",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textsc"
        "key": "ctrl+l ctrl+n",
        "mac": "cmd+l cmd+n",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textnormal"
        "key": "ctrl+l ctrl+6",
        "mac": "cmd+l cmd+6",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textsuperscript"
        "key": "ctrl+l ctrl+oem_minus",
        "mac": "cmd+l cmd+oem_minus",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.textsubscript"
        "key": "ctrl+m ctrl+b",
        "mac": "cmd+m cmd+b",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathbf"
        "key": "ctrl+m ctrl+i",
        "mac": "cmd+m cmd+i",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathit"
        "key": "ctrl+m ctrl+r",
        "mac": "cmd+m cmd+r",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathrm"
        "key": "ctrl+m ctrl+t",
        "mac": "cmd+m cmd+t",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathtt"
        "key": "ctrl+m ctrl+s",
        "mac": "cmd+m cmd+s",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathsf"
        "key": "ctrl+m ctrl+shift+b",
        "mac": "cmd+m cmd+shift+b",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
James-Yu's avatar
James-Yu committed
        "command": "latex-workshop.shortcut.mathbb"
        "key": "ctrl+m ctrl+c",
        "mac": "cmd+m cmd+c",
        "when": "editorTextFocus && !editorReadonly && editorLangId =~ /latex|rsweave/",
tecosaur's avatar
tecosaur committed
        "command": "latex-workshop.shortcut.mathcal"
      {
        "command": "expandLineSelection",
        "key": "ctrl+l ctrl+l",
        "mac": "cmd+l cmd+l",
        "when": "textInputFocus && editorLangId =~ /latex|rsweave/"
      },
      {
        "command": "editor.action.toggleTabFocusMode",
        "key": "ctrl+l ctrl+m",
        "mac": "cmd+l cmd+m",
        "when": "textInputFocus && editorLangId =~ /latex|rsweave/"
Jerome Lelong's avatar
Jerome Lelong committed
      {
        "key": "ctrl+l ctrl+w",
        "mac": "cmd+l cmd+w",
        "when": "editorTextFocus && !editorReadonly && editorHasSelection && editorLangId =~ /latex|rsweave/",
Jerome Lelong's avatar
Jerome Lelong committed
        "command": "latex-workshop.surround"
      },
        "command": "latex-workshop.onEnterKey",
        "key": "enter",
        "when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible &&  vim.active && vim.mode == 'Insert'"
      },
      {
        "command": "latex-workshop.onEnterKey",
        "key": "enter",
        "when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible &&  !vim.active"
        "command": "latex-workshop.onAltEnterKey",
        "key": "alt+enter",
        "when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible"
James-Yu's avatar
James-Yu committed
    ],
Jerome Lelong's avatar
Jerome Lelong committed
      "[latex]": {
        "editor.formatOnPaste": false,
        "editor.suggestSelection": "recentlyUsedByPrefix"
      }
James-Yu's avatar
James-Yu committed
    "configuration": {
      "type": "object",
James-Yu's avatar
James-Yu committed
      "properties": {
        "latex-workshop.latex.recipes": {
James-Yu's avatar
James-Yu committed
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "tools": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
          "default": [
            {
              "name": "latexmk 🔃",
              "tools": [
                "latexmk"
              ]
            },
            {
              "name": "latexmk (latexmkrc)",
              "tools": [
                "latexmk_rconly"
              ]
            },
            {
              "name": "latexmk (lualatex)",
              "tools": [
                "lualatexmk"
              ]
            },
              "name": "pdflatex ➞ bibtex ➞ pdflatex × 2",
              "tools": [
                "pdflatex",
                "bibtex",
                "pdflatex",
                "pdflatex"
              ]
Jerome Lelong's avatar
Jerome Lelong committed
            },
            {
              "name": "Compile Rnw files",
              "tools": [
                "rnw2tex",
                "latexmk"
          "markdownDescription": "Define LaTeX compiling recipes.\nEach recipe in the list is an object containing its name and the names of tools to be used sequentially, which are defined in `latex-workshop.latex.tools`.\nBy default, the first recipe is used to compile the project. For details, please visit https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipe."
        "latex-workshop.latex.recipe.default": {
          "type": "string",
          "default": "first",
          "markdownDescription": "Define which recipe is used by `latex-workshop.build`. It also applies to auto build. Recipes are refered to by their names as defined in `latex-workshop.latex.recipes`. Note there are two particular values: \n- `first` means to use the first recipe in `latex-workshop.latex.recipes`;\n- `lastUsed` means to use the last run recipe."
James-Yu's avatar
James-Yu committed
        "latex-workshop.latex.tools": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "command": {
                "type": "string"
              },
              "args": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "env": {
                "type": "object"
              }
          "default": [
            {
              "name": "latexmk",
              "command": "latexmk",
              "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "-outdir=%OUTDIR%",
                "%DOC%"
              ],
              "env": {}
            },
            {
              "name": "lualatexmk",
              "command": "latexmk",
              "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-lualatex",
Tom Z?hner's avatar
Tom Z?hner committed
                "-outdir=%OUTDIR%",
                "%DOC%"
James-Yu's avatar
James-Yu committed
              "env": {}
            {
              "name": "latexmk_rconly",
              "command": "latexmk",
              "args": [
                "%DOC%"
              ],
              "env": {}
            },
            {
              "name": "pdflatex",
              "command": "pdflatex",
              "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "%DOC%"
James-Yu's avatar
James-Yu committed
              "env": {}
            },
            {
              "name": "bibtex",
              "command": "bibtex",
              "args": [
                "%DOCFILE%"
James-Yu's avatar
James-Yu committed
              "env": {}
              "name": "rnw2tex",
Jerome Lelong's avatar
Jerome Lelong committed
              "command": "Rscript",
              "args": [
                "-e",
                "knitr::opts_knit$set(concordance = TRUE); knitr::knit('%DOCFILE_EXT%')"
Jerome Lelong's avatar
Jerome Lelong committed
              ],
              "env": {}
          "markdownDescription": "Define LaTeX compiling tools to be used in recipes.\nEach tool is labeled by its `name`. When invoked, `command` is spawned with arguments defined in `args` and environment variables defined in `env`. Typically no spaces should appear in each argument unless in paths.\nPlaceholders `%DOC%`, `%DOC_W32%, %DOC_EXT%`, `%DOC_EXT_W32%`, `%DOCFILE%`, `%DOCFILE_EXT%`, `%DIR%`, `%DIR_W32%`, `%TMPDIR%` and `%OUTDIR%`, `%OUTDIR_W32%` are available. For more details, please visit https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#placeholders."
        "latex-workshop.latex.magic.args": {
James-Yu's avatar
James-Yu committed
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "%DOC%"
Trevor Gunn's avatar
Trevor Gunn committed
          "markdownDescription": "Define the arguments to be input to magic command executable. This can be overridden by using \"% !TeX options\"."
James-Yu's avatar
James-Yu committed
        },
Álan Crístoffer's avatar
Álan Crístoffer committed
        "latex-workshop.latex.magic.bib.args": {
          "type": "array",
          "items": {
            "type": "string"
          },
Álan Crístoffer's avatar
Álan Crístoffer committed
          "default": [
            "%DOCFILE%"
          ],
Trevor Gunn's avatar
Trevor Gunn committed
          "markdownDescription": "Define the arguments to be input to BIB magic command executable. This can be overridden by using \"% !BIB options\"."
Álan Crístoffer's avatar
Álan Crístoffer committed
        },
        "latex-workshop.latex.external.build.command": {
          "type": "string",
          "default": "",
          "markdownDescription": "The external command to execute when calling latex-workshop.build.\nThis is useful when compiling relies on a Makefile or a bespoke script. When defined, it completely bypasses the recipes and root file detection mechanism."
        },
        "latex-workshop.latex.external.build.args": {
          "type": "array",
          "items": {
            "type": "string"
          "default": [],
          "markdownDescription": "The arguments of `latex-workshop.latex.external.build.command` when calling latex-workshop.build."
        "latex-workshop.latex.build.forceRecipeUsage": {
          "type": "boolean",
          "default": false,
          "markdownDescription": "Force the use the recipe mechanism even if some magic comments are present."
        },
          "markdownDescription": "The directory where the extension tries to find project files (e.g., PDF and SyncTeX files) are located.\nBoth relative and absolute paths are supported. Relative path start from the root file location, so beware if it is located in sub-directory. The path must not contain a trailing slash.\nThe LaTeX toolchain should output files to this path.\nFor a list of supported placeholders, please visit https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#placeholders."
        "latex-workshop.latex.texDirs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "markdownDescription": "List of directories where to look for extra input `.tex` files. \nAbsolute paths are required. You may also need to set the environment variable `TEXINPUTS` properly for the LaTeX compiler to find the `.tex` files, see the `env` parameter of [recipes](https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipes)."
        "latex-workshop.latex.bibDirs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [],
          "markdownDescription": "List of directories where to look for `.bib` files.\nAbsolute paths are required. This setting is only used by the intellisense feature, you may also need to set the environment variable `BIBINPUTS` properly for the LaTeX compiler to find the `.bib` files."
        "latex-workshop.latex.search.rootFiles.include": {
          "type": "array",
          "items": {
            "type": "string"
          },
James-Yu's avatar
James-Yu committed
          "default": [
            "**/*.tex",
            "**/*.rnw",
            "**/*.Rnw"
James-Yu's avatar
James-Yu committed
          ],
          "markdownDescription": "Patterns of files to consider for the root detection mechanism.\nRelative paths are computed from the workspace folder. To detect the root file and the tex file tree, we parse all the `.tex` listed here.\nIf you want to specify all `.tex` files inside directory, say `foo`, and all its subdirectories recursively, you need to use `**/foo/**/*.tex`. If you only want to match `.tex` files at the top level of the workspace, use `*.tex`. For more details the [wiki](https://github.com/James-Yu/LaTeX-Workshop/wiki/Multi-File-Projects)."
        },
        "latex-workshop.latex.search.rootFiles.exclude": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [],
          "markdownDescription": "Patterns of files to exclude from the root detection mechanism.\nSee also `latex-workshop.latex.search.rootFiles.include`. For more details the [wiki](https://github.com/James-Yu/LaTeX-Workshop/wiki/Multi-File-Projects)."
        },
        "latex-workshop.latex.rootFile.useSubFile": {
          "type": "boolean",
          "default": true,
          "markdownDescription": "When the `subfile` package is used, either the main file or any subfile containing `\\documentclass[main.tex]{subfile}` can be LaTeXing. When set to `true`, the extension uses the subfile as the rootFile for the `autobuild`, `clean` and `synctex` commands."
        },
        "latex-workshop.latex.rootFile.doNotPrompt": {
          "type": "boolean",
          "default": false,
          "markdownDescription": "When the `subfile` package is used, either the main file or any subfile containing `\\documentclass[main.tex]{subfile}` can be LaTeXing. When set to `false`, the `build` and `view` commands  ask the user's choice first. When set to `true`, the subfile is used when `latex-workshop.latex.rootFile.useSubFile` is also `true`, otherwise the rootFile is used."
        "latex-workshop.latex.watch.usePolling": {
          "type": "boolean",
          "default": false,
          "markdownDescription": "When set to true, polling is used to watch changes on files. When TeX files are placed on network drives or OneDrive, this option should be turned on. Setting this option to true might lead to high CPU utilization. You must reload VSCode to take into account a change in this configuration."
        },
        "latex-workshop.latex.watch.interval": {
          "type": "number",
          "default": 300,
          "markdownDescription": "Interval of polling, in milliseconds. You must reload VSCode to take into account a change in this configuration."
        "latex-workshop.latex.watch.delay": {
          "type": "number",
          "default": 250,
          "markdownDescription": "Delay before starting builds, in milliseconds. You must reload VSCode to take into account a change in this configuration."
        },
        "latex-workshop.latex.pdfWatch.delay": {
          "type": "number",
          "default": 250,
          "markdownDescription": "Delay before reloading a PDF file after last change, in milliseconds. You must reload VSCode to take into account a change in this configuration."
        "latex-workshop.latex.watch.files.ignore": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [
            "**/*.bbx",
Jerome Lelong's avatar
Jerome Lelong committed
            "**/*.bbl",
            "**/*.cbx",
            "**/*.cfg",
            "**/*.clo",
            "**/*.cnf",
            "**/*.def",
            "**/*.dfu",
            "**/*.enc",
            "**/*.fd",
            "**/*.fmt",
            "**/*.lbx",
            "**/*.map",
            "**/*.mkii",
            "**/*.code.tex",
            "**.*.sty",
            "**/texmf-{dist,var}/**",
            "**/Local/MiKTeX/**",
            "**/Local/Programs/MiKTeX/**",
            "**/Roaming/MiKTeX/**",
            "**/Program*/MiKTeX*/**",
            "**/.miktex/texmfs/**",
            "/var/cache/miktex-texmf/**",
            "/usr/local/share/miktex-texmf/**",
            "**/Library/Application Support/MiKTeX/texmfs/**",
            "/dev/null"
          "markdownDescription": "Files to ignore from the watching mechanism used for triggering autobuild.\nThis property must be an array of glob patterns. The patterns are matched against the absolute file path. To ignore everything inside the `texmf` tree, `**/texmf/**` can be used."
        "latex-workshop.latex.autoBuild.run": {
          "type": "string",
          "enum": [
            "never",
            "onFileChange"
          ],
          "enumDescriptions": [
            "Never run auto build",
            "Auto build whenever a dependency file changes on disk"
          ],
          "default": "onFileChange",
          "markdownDescription": "When the extension shall auto build LaTeX project using the default (first) recipe.\n `onFileChange` builds the project upon detecting a file change in any of the dependencies, even modified by other applications."
        "latex-workshop.latex.autoBuild.interval": {
          "type": "integer",
          "default": 1000,
          "markdownDescription": "The minimal time interval between two consecutive auto builds in millisecond."
        },
        "latex-workshop.latex.autoBuild.cleanAndRetry.enabled": {
          "type": "boolean",
          "default": true,
          "markdownDescription": "Delete LaTeX auxiliary files when errors occur during build and retry.\nThis property defines whether LaTeX Workshop will try to clean and build the project once again after errors happen in the build toolchain."
        "latex-workshop.latex.build.clearLog.everyRecipeStep.enabled": {
          "type": "boolean",
          "default": true,
          "markdownDescription": "Clear the LaTeX Compiler logs before every step of a recipe.\nSet this property to false to keep the logs of all tools in a recipe."
        },
        "latex-workshop.latex.autoClean.run": {
          "enum": [
            "never",
            "onFailed",
            "onBuilt"
          ],
          "enumDescriptions": [
            "Never clean the project",
            "Clean compilation fails",
            "Clean after build, be it successful or not"
          ],
          "markdownDescription": "When LaTeX auxiliary files should be deleted.\nThe folder to be cleaned is defined in `latex-workshop.latex.outDir`.\n`onFailed` cleans the project when compilation fails. `onBuilt` cleans the project when compilation is terminated, whether successful or failed."
        },
        "latex-workshop.latex.clean.subfolder.enabled": {
          "type": "boolean",
          "default": false,
          "markdownDescription": "Delete LaTeX auxiliary files recursively in sub-folders of `latex-workshop.latex.outDir`."
        "latex-workshop.latex.clean.fileTypes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "default": [