CONTRIBUTING.md

Contributing to LaTeX-Workshop

Please notice that we can reject any kinds of pull requests.

Quickstart

git clone https://github.com/James-Yu/LaTeX-Workshop.git
cd ./LaTeX-Workshop
npm ci
code -n .

Press F5 in vscode to start the development version in debug mode.

Prerequisites for building the extension

Make sure you have installed:

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

Then run

npm ci

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

To run tests, run

npm run test

To run a specific test, run

npm run test build/fixture001

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.

Documents

You can refer to:

• https://github.com/James-Yu/LaTeX-Workshop/wiki
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/src/README.md
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/viewer/README.md
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/data/README.md
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/resources/snippetpanel/README.md
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/test/README.md
• https://github.com/James-Yu/LaTeX-Workshop/blob/master/.github/workflows/README.md