2019-04-16 17:37:06 +03:00
# Contributing to LaTeX-Workshop
2021-06-20 16:52:53 +03:00
Please notice that we can reject any kinds of pull requests. Especially, we will reject any requests for changes on default values of settings.
We also reject requests adding additional recipes to default settings.
2021-03-08 06:46:47 +03:00
2020-02-29 23:04:39 +03:00
## Quickstart
2019-12-15 09:12:20 +03:00
```bash
git clone https://github.com/James-Yu/LaTeX-Workshop.git
cd ./LaTeX-Workshop
2022-04-08 02:57:54 +03:00
cp ./dev/githooks/pre-commit .git/hooks/
2021-02-26 16:07:36 +03:00
npm ci
2020-02-29 23:04:39 +03:00
code -n .
2019-12-15 09:12:20 +03:00
```
2020-02-29 23:04:39 +03:00
2019-12-15 09:12:20 +03:00
Press < kbd > F5< / kbd > in vscode to start the development version in debug mode.
2019-04-16 17:37:06 +03:00
## Prerequisites for building the extension
Make sure you have installed:
2022-04-23 07:54:41 +03:00
- [`node.js` ](https://nodejs.org/ ) v16
2022-01-08 14:37:24 +03:00
- `npm` v8
2019-08-02 01:04:38 +03:00
- the [`eslint` ](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint ) extension for VS Code (recommended)
2019-04-16 17:37:06 +03:00
Then run
2021-02-26 16:07:36 +03:00
npm ci
2019-04-16 17:37:06 +03:00
inside the extension workspace to download the node modules needed to build the extension.
2019-09-14 05:33:34 +03:00
## Development
To lint changes, run
npm run lint
To compile, run
npm run compile
To build a release image, run
npm run release
2020-03-08 05:15:13 +03:00
To run tests, run
npm run test
To run a specific test, run
2020-03-15 12:17:12 +03:00
npm run test build/fixture001
2020-03-08 05:15:13 +03:00
2019-11-30 11:25:24 +03:00
## Testing and debugging the extension
2019-04-16 17:37:06 +03:00
2022-04-27 04:08:41 +03:00
In VS Code, run `Debug: Select and Start Debugging` from the Command Palette, and select `Run Extension` . A new window will pop up where you can test the extension.
2019-11-30 11:25:24 +03:00
2020-08-16 03:02:32 +03:00
## 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
2021-11-08 03:57:19 +03:00
- https://github.com/James-Yu/LaTeX-Workshop/blob/master/resources/snippetview/README.md
2020-08-16 03:02:32 +03:00
- 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