Workflow.md

Как работать над проектом

Окружение

Для удобства работы над проектом используются инструменты из Node.js и npm. Все необходимые настройки произведены. Убедитесь, что на рабочем компьютере установлен актуальный LTS релиз Node.js**. Актуальная версия Node.js указана в файле package.json в поле node. Затем, в терминале, перейдите в директорию с проектом и единожды запустите команду:

npm install

Команда запустит процесс установки зависимостей проекта из npm.

Сценарии

В package.json предопределено несколько сценариев.

Скомпилировать проект

npm run compile

Создаст директорию dist и скомпилирует проект.

Удалить скомпилированный проект

npm run clean

Удаляет директорию dist. Используется перед компиляцией.

Собрать проект

npm run build

Выполняет сборку проекта: удаляет ранее скомпилированный проект и компилирует заново.

Проверить линтером

npm run lint

Запуск проверки проекта статическим анализатором кода ESLint.

Линтер проверяет файлы только внутри директории src.

Обратите внимание, при запуске данной команды, ошибки выводятся в терминал.

Запустить ts-модуль без компиляции

npm run ts -- <Путь к модулю с ts-кодом>

Пакет ts-node позволяет выполнить TS-код в Node.js без предварительной компиляции. Используется только на этапе разработки.

Запустить проект

npm start

В процессе запуска проекта будет выполнен процесс «Сборки проекта» и запуска результирующего кода.

Структура проекта

Директория src

Исходный код проекта: компоненты, модули и так далее. Структура директории src может быть произвольной.

Файл Readme.md

Инструкции по работе с учебным репозиторием.

Файл Contributing.md

Советы и инструкции по внесению изменений в учебный репозиторий.

Остальное

Все остальные файлы в проекте являются служебными. Пожалуйста, не удаляйте и не изменяйте их самовольно. Только если того требует задание или наставник.