LaTeX-Workshop/package.json

{
  "name": "latex-workshop",
  "displayName": "LaTeX Workshop",
  "description": "Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.",
  "icon": "icon.png",
  "version": "5.0.4",
  "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.21.0"
  },
  "categories": [
    "Languages",
    "Snippets"
  ],
  "keywords": [
    "latex",
    "tex",
    "compile",
    "preview",
    "hint"
  ],
  "activationEvents": [
    "onLanguage:tex",
    "onLanguage:latex",
    "onLanguage:doctex",
    "onCommand:latex-workshop.build",
    "onCommand:latex-workshop.recipes",
    "onCommand:latex-workshop.view",
    "onCommand:latex-workshop.tab",
    "onCommand:latex-workshop.pdf",
    "onCommand:latex-workshop.synctex",
    "onCommand:latex-workshop.clean",
    "onCommand:latex-workshop.citation",
    "onCommand:latex-workshop.wordcount",
    "onCommand:latex-workshop.compilerlog",
    "onCommand:latex-workshop.log",
    "onCommand:latex-workshop.actions"
  ],
  "main": "./out/src/main",
  "contributes": {
    "languages": [
      {
        "id": "tex",
        "aliases": [
          "TeX",
          "tex"
        ],
        "extensions": [
          ".sty",
          ".cls",
          ".bbx",
          ".cbx"
        ],
        "configuration": "./syntax/syntax.json"
      },
      {
        "id": "doctex",
        "aliases": [
          "DocTeX",
          "doctex"
        ],
        "extensions": [
          ".dtx"
        ],
        "configuration": "./syntax/syntax-doctex.json"
      },
      {
        "id": "latex",
        "aliases": [
          "LaTeX",
          "latex"
        ],
        "extensions": [
          ".tex"
        ],
        "configuration": "./syntax/syntax.json"
      },
      {
        "id": "bibtex",
        "aliases": [
          "BibTeX",
          "bibtex"
        ],
        "extensions": [
          ".bib"
        ]
      },
      {
        "id": "latex-memoir",
        "aliases": [
          "LaTeX Memoir"
        ],
        "configuration": "./syntax/syntax.json"
      },
      {
        "id": "latex-expl3",
        "aliases": [
          "LaTeX Expl3"
        ],
        "configuration": "./syntax/syntax.json"
      },
      {
        "id": "pdf",
        "aliases": [
          "Plain Text (PDF)",
          "pdf"
        ],
        "extensions": [
          ".pdf"
        ]
      }
    ],
    "grammars": [
      {
        "language": "tex",
        "scopeName": "text.tex",
        "path": "./syntax/TeX.plist"
      },
      {
        "language": "doctex",
        "scopeName": "text.tex.doctex",
        "path": "./syntax/DocTeX.plist"
      },
      {
        "language": "latex",
        "scopeName": "text.tex.latex",
        "path": "./syntax/LaTeX.plist"
      },
      {
        "language": "bibtex",
        "scopeName": "text.bibtex",
        "path": "./syntax/Bibtex.plist"
      },
      {
        "language": "latex-expl3",
        "scopeName": "text.tex.latex.expl3",
        "path": "./syntax/LaTeX Expl3.plist"
      },
      {
        "language": "latex-memoir",
        "scopeName": "text.tex.latex.memoir",
        "path": "./syntax/LaTeX Memoir.plist"
      }
    ],
    "commands": [
      {
        "command": "latex-workshop.build",
        "title": "Build LaTeX project",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.recipes",
        "title": "Build with recipe",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.view",
        "title": "View LaTeX PDF file",
        "category": "LaTeX Workshop",
        "icon": {
          "light": "icons/view-pdf-light.svg",
          "dark": "icons/view-pdf-dark.svg"
        }
      },
      {
        "command": "latex-workshop.pdf",
        "title": "View PDF file",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.synctex",
        "title": "SyncTeX from cursor",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.clean",
        "title": "Clean up auxiliary files",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.citation",
        "title": "Open citation browser",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.addtexroot",
        "title": "Insert %!TeX root magic command",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.wordcount",
        "title": "Count words in LaTeX document",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.compilerlog",
        "title": "Show LaTeX compiler log",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.log",
        "title": "Show LaTeX Workshop messages",
        "category": "LaTeX Workshop"
      },
      {
        "command": "latex-workshop.actions",
        "title": "LaTeX Workshop: All actions"
      }
    ],
    "keybindings": [
      {
        "command": "latex-workshop.build",
        "key": "ctrl+alt+b",
        "when": "editorTextFocus"
      },
      {
        "command": "latex-workshop.view",
        "key": "ctrl+alt+v",
        "when": "editorTextFocus"
      }
    ],
    "configuration": {
      "type": "object",
      "title": "LaTeX Workshop configuration",
      "properties": {
        "latex-workshop.latex.recipes": {
          "type": "array",
          "default": [
            {
              "name": "latexmk",
              "tools": [
                "latexmk"
              ]
            },
            {
              "name": "pdflatex -> bibtex -> pdflatex*2",
              "tools": [
                "pdflatex",
                "bibtex",
                "pdflatex",
                "pdflatex"
              ]
            }
          ],
          "description": "Define LaTeX compiling recipes.\nEach recipe in the list is an object declares 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#recipe."
        },
        "latex-workshop.latex.tools": {
          "type": "array",
          "default": [
            {
              "name": "latexmk",
              "command": "latexmk",
              "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "%DOC%"
              ]
            },
            {
              "name": "pdflatex",
              "command": "pdflatex",
              "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "%DOC%"
              ]
            },
            {
              "name": "bibtex",
              "command": "bibtex",
              "args": [
                "%DOCFILE%"
              ]
            }
          ],
          "description": "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`. Typically no spaces should appear in each argument unless in paths.\nPlaceholder `%DOC%`, `%DOCFILE`, and `%DIR%` is available. For details, please visit https://github.com/James-Yu/LaTeX-Workshop#recipe."
        },
        "latex-workshop.latex.magic.args": {
          "type": "array",
          "default": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "%DOC%"
          ],
          "description": "Define the arguments to be input to magic command executable."
        },
        "latex-workshop.latex.magic.bib.args": {
          "type": "array",
          "default": [
            "%DOCFILE%"
          ],
          "description": "Define the arguments to be input to BIB magic command executable."
        },
        "latex-workshop.latex.outputDir": {
          "type": "string",
          "default": "./",
          "description": "The directory where the extension tries to find project files (e.g., PDF and SyncTeX files) are located.\nBoth relative and absolute pathes are supported. Relative path start from the root file location, so beware if it is located in sub-directory.\nThe LaTeX toolchain should output files to this path."
        },
        "latex-workshop.latex.additionalBib": {
          "type": "array",
          "default": [],
          "description": "Addition bibliography files to watch.\nBoth relative and absolute paths/globs are supported, but absolute ones are suggested. Relative path start from the root file location, so be ware if it is located in sub-directory."
        },
        "latex-workshop.latex.autoBuild.onSave.enabled": {
          "type": "boolean",
          "default": true,
          "description": "Build LaTeX after saving LaTeX source file.\nThis property defines whether LaTeX Workshop will execute the LaTeX toolchain command(s) to build the project after new LaTeX contents are saved."
        },
        "latex-workshop.latex.autoBuild.onTexChange.enabled": {
          "type": "boolean",
          "default": false,
          "description": "Build LaTeX after a LaTeX source file has changed in the workspace.\nThis property defines whether LaTeX Workshop will execute the LaTeX toolchain command(s) to build the project after any LaTeX file in the workspace is saved on the disk which is not open in the active editor window."
        },
        "latex-workshop.latex.autoBuild.cleanAndRetry.enabled": {
          "type": "boolean",
          "default": true,
          "description": "Delete LaTeX auxillary 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.clean.enabled": {
          "type": "boolean",
          "default": false,
          "description": "Delete LaTeX auxillary files after building project.\nThis property defines whether LaTeX Workshop will clean up all unnecessary files after building the project."
        },
        "latex-workshop.latex.clean.fileTypes": {
          "type": "array",
          "default": [
            "*.aux",
            "*.bbl",
            "*.blg",
            "*.idx",
            "*.ind",
            "*.lof",
            "*.lot",
            "*.out",
            "*.toc",
            "*.acn",
            "*.acr",
            "*.alg",
            "*.glg",
            "*.glo",
            "*.gls",
            "*.ist",
            "*.fls",
            "*.log",
            "*.fdb_latexmk"
          ],
          "description": "Files to clean.\nThis property must be an array of strings. File globs such as *.removeme, something?.aux can be used."
        },
        "latex-workshop.view.outline.sections": {
          "type": "array",
          "default": [
            "chapter",
            "section",
            "subsection",
            "subsubsection"
          ],
          "description": "The section names of LaTeX outline hierarchy.\nThis property is an array of case-sensitive strings in the order of document structure hierarchy. For multiple tags in the same level, seperate the tags with `|` as delimiters, e.g., `section|alternative`."
        },
        "latex-workshop.view.pdf.viewer": {
          "type": "string",
          "default": "none",
          "enum": [
            "none",
            "browser",
            "tab",
            "external"
          ],
          "description": "The default PDF viewer."
        },
        "latex-workshop.view.pdf.external.command": {
          "type": "object",
          "default": {
            "command": "SumatraPDF.exe",
            "args": [
              "%PDF%"
            ]
          },
          "description": "The command to execute when using external viewer.\nThis function is not officially supported. %PDF% is the placeholder for the absolute path to the generated PDF file."
        },
        "latex-workshop.view.pdf.zoom": {
          "type": "string",
          "default": "auto",
          "description": "The default zoom level of the PDF viewer.\nThis default value will be passed to the viewer upon opening. Possible values are `auto`, `page-actual`, `page-fit`, `page-width`, and one-based scale values (e.g., 0.5 for 50%, 2.0 for 200%)."
        },
        "latex-workshop.view.pdf.hand": {
          "type": "boolean",
          "default": false,
          "description": "Define if the hand tool is enabled by default in the PDF viewer."
        },
        "latex-workshop.view.pdf.invert": {
          "type": "number",
          "default": 0,
          "description": "Define the CSS invert filter level of the PDF viewer.\nThis config can invert the color of PDF. Possible values are from 0 to 1."
        },
        "latex-workshop.synctex.path": {
          "type": "string",
          "default": "synctex",
          "description": "Define the location of SyncTeX executive file.\nAdditional arguments, e.g., synctex modes and position of click, will be appended to this command."
        },
        "latex-workshop.chktex.enabled": {
          "type": "boolean",
          "default": false,
          "description": "Enable linting LaTeX with ChkTeX.\nThe active document will be linted when no document changes for a defined period of time.\nThe full project will be linted from the root on file save."
        },
        "latex-workshop.chktex.path": {
          "type": "string",
          "default": "chktex",
          "description": "Define the location of ChkTeX executive file.\nThis command will be joint with `latex-workshop.chktex.args.*` and required arguments to form a complete command of ChkTeX."
        },
        "latex-workshop.chktex.args.active": {
          "type": "array",
          "default": [
            "-wall",
            "-n22",
            "-n30",
            "-e16",
            "-q"
          ],
          "description": "Linter arguments to check LaTeX syntax of the current file state in real time with ChkTeX.\nArguments must be in separate strings in the array. Additional arguments, i.e., `-I0 -f%f:%l:%c:%d:%k:%n:%m\\n` will be appended when constructing the command. Current file contents will be piped to the command through stdin."
        },
        "latex-workshop.chktex.args.root": {
          "type": "array",
          "default": [
            "-wall",
            "-n22",
            "-n30",
            "-e16",
            "-q"
          ],
          "description": "Linter arguments to check LaTeX syntax of the entire project from the root file with ChkTeX.\nArguments must be in separate strings in the array. Additional arguments, i.e., `-f%f:%l:%c:%d:%k:%n:%m\\n %DOC%` will be appended when constructing the command."
        },
        "latex-workshop.chktex.interval": {
          "type": "number",
          "default": 300,
          "description": "Defines the time interval in milliseconds between invoking LaTeX linter on the active file."
        },
        "latex-workshop.texcount.path": {
          "type": "string",
          "default": "texcount",
          "description": "Define the location of TeXCount executive file/script.\nThis command will be joint with `latex-workshop.texcount.args` and required arguments to form a complete command of TeXCount."
        },
        "latex-workshop.texcount.args": {
          "type": "array",
          "default": [],
          "description": "TeXCount arguments to count words in LaTeX document of the entire project from the root file, or the currect document.\nArguments must be in separate strings in the array. Additional arguments, i.e., `-merge %DOC%` for the project and the current document path for counting current file will be appended when constructing the command."
        },
        "latex-workshop.intellisense.citation.type": {
          "type": "string",
          "enum": [
            "inline",
            "browser"
          ],
          "default": "inline",
          "description": "Defines which type of hint to show when intellisense provides citation suggestions."
        },
        "latex-workshop.intellisense.citation.label": {
          "type": "string",
          "enum": [
            "bibtex key",
            "title",
            "authors"
          ],
          "default": "bibtex key",
          "description": "Defines what to show as suggestion labels when intellisense provides citation suggestions."
        },
        "latex-workshop.intellisense.surroundCommand.enabled": {
          "type": "boolean",
          "default": false,
          "description": "When `\\` is typed with text selected, surround the selection with LaTeX command."
        },
        "latex-workshop.message.information.show": {
          "type": "boolean",
          "default": false,
          "description": "Display information messages in popup notifications."
        },
        "latex-workshop.message.warning.show": {
          "type": "boolean",
          "default": true,
          "description": "Display warning messages in popup notifications."
        },
        "latex-workshop.message.error.show": {
          "type": "boolean",
          "default": true,
          "description": "Display error messages in popup notifications."
        },
        "latex-workshop.message.update.show": {
          "type": "boolean",
          "default": true,
          "description": "Display LaTeX Workshop update message on new versions."
        },
        "latex-workshop.message.log.show": {
          "type": "boolean",
          "default": true,
          "description": "Display LaTeX Workshop debug log in output panel.\nThis property defines whether LaTeX Workshop will output its debug log to the log panel."
        },
        "latex-workshop.latexindent.path": {
          "type": "string",
          "default": "latexindent",
          "description": "Define the location of the latexindent executable file."
        },
        "latex-workshop.latexindent.args": {
          "type": "array",
          "default": [
            "-c",
            "%DIR%/",
            "%TMPFILE%",
            "-y=\"defaultIndent: '%INDENT%'\""
          ],
          "description": "Define the command line arguments for latexindent. Available placeholders:\n- %DOC%, %DOCFILE%, %DIR%: same as latex-workshop.latex.toolchain args.\n- %TMPFILE%: would be replaced with the path of file which contains raw TeX source to be formatted. At this moment you need to use it as an input file of `latexindent`.\n- %INDENT%: would be replaced with the string which represents indent of the target document.\n\nNote: At this moment -c option requires trailing slash."
        }
      }
    },
    "menus": {
      "explorer/context": [
        {
          "when": "resourceLangId == pdf",
          "command": "latex-workshop.pdf",
          "group": "navigation"
        }
      ],
      "editor/context": [
        {
          "when": "resourceLangId == latex",
          "command": "latex-workshop.build",
          "group": "navigation@100"
        },
        {
          "when": "resourceLangId == latex",
          "command": "latex-workshop.synctex",
          "group": "navigation@101"
        },
        {
          "when": "resourceLangId == latex",
          "command": "latex-workshop.actions",
          "group": "navigation@102"
        }
      ],
      "editor/title": [
        {
          "when": "editorLangId == latex",
          "command": "latex-workshop.view",
          "group": "navigation"
        }
      ]
    },
    "views": {
      "explorer": [
        {
          "id": "latex-outline",
          "name": "LaTeX Outline",
          "when": "resourceLangId == latex"
        }
      ]
    }
  },
  "scripts": {
    "vscode:prepublish": "tsc -p ./",
    "compile": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install"
  },
  "capabilities": {
    "completionProvider": {
      "resolveProvider": "true"
    },
    "hoverProvider": "true",
    "definitionProvider": "true",
    "documentSymbolProvider": "true",
    "workspaceSymbolProvider": "true"
  },
  "dependencies": {
    "chokidar": "^2.0.3",
    "fs-extra": "^5.0.0",
    "glob": "^7.1.1",
    "pdfjs-dist": "^1.8.609",
    "ws": "^5.1.1"
  },
  "devDependencies": {
    "@types/chokidar": "^1.6.0",
    "@types/fs-extra": "^5.0.0",
    "@types/glob": "^5.0.30",
    "@types/ws": "^4.0.2",
    "@types/node": "^7.0.59",
    "tslint": "^5.0.0",
    "typescript": "^2.0.3",
    "vscode": "^1.1.14",
    "webpack": "^2.7.0"
  }
}