LaTeX-Workshop/CONTRIBUTING.md

Contributing to LaTeX-Workshop

Prerequisites for building the extension

Make sure you have installed:

• node.js v10
• npm
• the eslint extension for VS Code (recommended)

Then run

npm install --no-optional

inside the extension workspace to download the node modules needed to build the extension.

Development

To lint changes, run

npm run lint

To compile, run

npm run compile

To build a release image, run

npm run release

Testing and debugging the extension

In VS Code, simply press <F5> (or run Debug: Start Debugging from the command palette) and a new window will pop up where you can test the extension.

Debugging PDF viewer

To debug the internal PDF viewer, select View LaTeX PDF > View in web browser, and view a PDF file in Google Chrome. You can debug the viewer with Chrome DevTools as a general web application.