84 lines
6.4 KiB
Markdown
84 lines
6.4 KiB
Markdown
# Настройка VS Code
|
|
|
|
## Открывайте папку целиком
|
|
|
|
Настройки проекта работают только при открытии корневой папки. В левой панели должны быть видны `main.typ`, `chapters/`, `assets/` и `docs/`.
|
|
|
|
## Рекомендации расширений
|
|
|
|
VS Code читает `.vscode/extensions.json` и предлагает командные расширения. Откройте Extensions (`Ctrl+Shift+X`), введите `@recommended` и установите рекомендации рабочей области.
|
|
|
|
Typst Typewriter и Zotst являются внутренними расширениями. Получите их `.vsix` у сопровождающего, затем выполните `Ctrl+Shift+P` → **Extensions: Install from VSIX**.
|
|
|
|
| Расширение | Для чего нужно | Ссылка или ID |
|
|
|------------|----------------|---------------|
|
|
| Bookmarks | Пометки и быстрые переходы по большому документу | [Marketplace](https://marketplace.visualstudio.com/items?itemName=alefragnani.Bookmarks) |
|
|
| Code Spell Checker | Проверка орфографии | [Marketplace](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) |
|
|
| Russian — Code Spell Checker | Русский словарь для проверки | [Marketplace](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker-russian) |
|
|
| Russian Language Pack | Русский интерфейс VS Code | [Marketplace](https://marketplace.visualstudio.com/items?itemName=MS-CEINTL.vscode-language-pack-ru) |
|
|
| Tinymist Typst | Подсказки, диагностика и живой предпросмотр | [Marketplace](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist) |
|
|
| TODO Highlight | Выделение `TODO`, `FIXME`, `ПРОВЕРИТЬ`, `ВАЖНО` | [Marketplace](https://marketplace.visualstudio.com/items?itemName=wayou.vscode-todo-highlight) |
|
|
| Todo Tree | Общий список пометок по всем главам | [Marketplace](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.todo-tree) |
|
|
| Git Graph | Наглядная история коммитов, веток и merge | [Marketplace](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) |
|
|
| Typst Typewriter | Внутренняя панель автора | `local.typst-typewriter` |
|
|
| Zotst — Zotero for Typst | Поиск в Zotero и вставка библиографических ссылок | `zotst.zotst` |
|
|
|
|
Полезные команды:
|
|
|
|
- `Typst Typewriter: Open Sidebar` — открыть панель автора;
|
|
- `Zotst: Set References File for This Project` — выбрать `assets/references.bib`;
|
|
- `Zotst: Insert Citation from Zotero` — найти источник и вставить ссылку;
|
|
- `Git Graph: View Git Graph` — открыть граф истории документа.
|
|
|
|
## Автосохранение и предпросмотр
|
|
|
|
Проект задаёт:
|
|
|
|
```json
|
|
"files.autoSave": "afterDelay",
|
|
"files.autoSaveDelay": 700
|
|
```
|
|
|
|
Изменения сохраняются через 700 мс. Для живого просмотра откройте `main.typ` и запустите команду, содержащую `Typst Preview`. Пока окно предпросмотра открыто, Tinymist следит за зависимыми главами и обновляет результат.
|
|
|
|
Если нужен готовый файл, нажмите `Ctrl+Shift+B`. Режим `final`, `draft` или `clean-copy` выбирается в начале единственного `main.typ`.
|
|
|
|
## Задачи проекта
|
|
|
|
Откройте `Ctrl+Shift+P` → **Tasks: Run Task**:
|
|
|
|
| Задача | Результат |
|
|
|--------|-----------|
|
|
| `Scientia: собрать PDF` | Собирает текущий `main.typ` в `document.pdf` |
|
|
| `Scientia: выбрать тип документа` | Устанавливает пример отчёта, письма, ТКП или договора |
|
|
| `Scientia: собрать учебный пример` | Собирает выбранный пример из `docs/examples/` |
|
|
|
|
Та же задача сборки используется и с приватными изображениями. Скопируйте `.private`, включите `use-private-assets = true` в `main.typ` и запускайте обычный предпросмотр или `Ctrl+Shift+B`.
|
|
|
|
## Проверка орфографии
|
|
|
|
Code Spell Checker настроен на русский и английский для Typst, Markdown и BibTeX. Неизвестное корректное слово добавляйте через лампочку → **Add Word to Workspace Settings**, только если оно действительно должно использоваться всей командой.
|
|
|
|
## Пометки в тексте
|
|
|
|
Используйте комментарии:
|
|
|
|
```typst
|
|
// TODO: добавить источник
|
|
// ПРОВЕРИТЬ: согласовать значение с заказчиком
|
|
// ВАЖНО: не выпускать без рецензирования
|
|
```
|
|
|
|
TODO Highlight выделит строку, а Todo Tree соберёт все пометки в одной панели.
|
|
|
|
## Скрытые каталоги
|
|
|
|
`.template/`, `.private/` и `.vscode/` скрыты настройкой `files.exclude`. Публичный каталог `docs/` остаётся видимым. Обычно `.private` достаточно целиком скопировать с заменой. Чтобы изменить смещение подписи вручную, откройте Settings, найдите `files.exclude`, временно отключите скрытие `.private` на уровне Workspace и после работы включите его обратно.
|
|
|
|
## Дополнительные материалы
|
|
|
|
- [Workspace recommendations](https://code.visualstudio.com/docs/configure/extensions/extension-marketplace#_workspace-recommended-extensions)
|
|
- [Настройки VS Code](https://code.visualstudio.com/docs/configure/settings)
|
|
- [Auto Save](https://code.visualstudio.com/docs/editing/codebasics#_save-auto-save)
|
|
- [Tinymist](https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist)
|