Перейти до основного вмісту

Налаштування

Цей посібник охоплює налаштування вашого середовища розробки для Rayforge.

Linux​

Вимоги​

Див. Посібник з встановлення для інструкцій з встановлення Pixi.

Pre-commit хуки (Опціонально)​

Щоб автоматично форматувати та лінтувати ваш код перед кожним комітом, ви можете встановити pre-commit хуки:

pixi run pre-commit-install

Корисні команди​

Всі команди виконуються через pixi run:

  • pixi run rayforge: Запустити додаток.
    • Додайте --loglevel=DEBUG для більш детального виводу.
  • pixi run test: Запустити повний набір тестів з pytest.
  • pixi run format: Форматувати весь код використовуючи ruff.
  • pixi run lint: Запустити всі лінтери (flake8, pyflakes, pyright).

Windows​

Вимоги​

Див. Посібник з встановлення для детальних інструкцій з налаштування розробки MSYS2.

Швидкий старт​

Завдання розробки на Windows керуються через скрипт run.bat, який є обгорткою для shell MSYS2.

Після клонування репозиторію та завершення налаштування MSYS2 ви можете використовувати ці команди зі стандартного командного рядка Windows або PowerShell:

.\run.bat setup

Це виконує scripts/win/win_setup.sh щоб встановити всі необхідні системні та Python пакети у ваше середовище MSYS2/MinGW64.

Pre-commit хуки (Опціонально)​

Щоб автоматично форматувати та лінтувати ваш код перед кожним комітом, виконайте це з оболонки MSYS2 MINGW64:

bash scripts/win/win_setup_dev.sh
примітка

Pre-commit хуки вимагають запуску команд git всередині оболонки MSYS2 MINGW64, а не з PowerShell або командного рядка.

Корисні команди​

Всі команди виконуються через скрипт run.bat:

  • run app: Запустити додаток з вихідних кодів.
    • Додайте --loglevel=DEBUG для більш детального виводу.
  • run test: Запустити повний набір тестів використовуючи pytest.
  • run lint: Запустити всі лінтери (flake8, pyflakes, pyright).
  • run format: Форматувати та автоматично виправляти код використовуючи ruff.
  • run build: Зібрати фінальний виконуваний файл Windows (.exe).

Альтернативно, ви можете запускати скрипти безпосередньо з оболонки MSYS2 MINGW64:

  • bash scripts/win/win_run.sh: Запустити додаток.
  • bash scripts/win/win_test.sh: Запустити набір тестів.
  • bash scripts/win/win_lint.sh: Запустити всі лінтери.
  • bash scripts/win/win_format.sh: Форматувати та автоматично виправляти код.
  • bash scripts/win/win_build.sh: Зібрати виконуваний файл Windows.