Newer
Older
TIASjudge / docs / 02_ENV / ENV_04_開発コマンド.md

開発コマンド (Development Commands)

日常の開発で使うコマンド一覧.コマンドを実行する前に必ず本ファイルを参照する(推測でコマンドを試さない). コマンドが新しく確定・変更されたときは本ファイルを更新する.

前提: ENV_02_環境構築手順.md のセットアップが済んでいること. すべてリポジトリ直下(pyproject.toml のある場所)で実行する.OS(Windows / macOS)による差は無い.

環境 (Environment)

目的コマンド
依存パッケージを同期(初回・uv.lock 更新時)uv sync
依存パッケージを追加uv add <パッケージ>
開発用(テスト・lint 等)の依存を追加uv add --dev <パッケージ>
依存パッケージを削除uv remove <パッケージ>
インストール済みパッケージを確認uv pip list

※ pip install は使わない(ENV_02「環境再現性のルール」).

起動 (Run)

目的コマンド
アプリを起動(メイン画面)uv run python -m tiasjudge
コンソールスクリプトで起動uv run tiasjudge
起動可能性のみ確認(画面を出さずに終了)uv run python -m tiasjudge --check

※ 結果画面は PLAN_02 ステップ 7 で実装する.それまで診断結果は暫定のダイアログで表示される. ※ ヘッドレス環境(画面の無い CI 等)では QT_QPA_PLATFORM=offscreen を付けて --check を実行する.

テスト (Test)

目的コマンド
全テストを実行uv run pytest
特定ファイルを実行uv run pytest tests/core/test_color.py
特定テストを実行uv run pytest tests/core/test_color.py::test_xyz_to_lab
失敗時に詳細を表示uv run pytest -vv
最初の失敗で中断uv run pytest -x

※ テストが 1 件も収集されない場合,pytest は終了コード 5 で終わる.テスト対象の指定ミスを疑うこと.

lint・フォーマット (Lint & Format)

目的コマンド
lint チェックuv run ruff check .
lint の自動修正uv run ruff check --fix .
フォーマット実行uv run ruff format .
フォーマット差分の確認のみuv run ruff format --check .

コミット前の確認 (Pre-commit Checks)

以下の 3 つがすべて通ることを確認してからコミットする.

uv run ruff check .
uv run ruff format --check .
uv run pytest

同梱データ (Bundled Data)

ファイル内容
data/data.csvSVM 学習データ(旧実装の data.csv を UTF-8 に変換して同梱.SPEC_02 参照)

※ 変換行列 CSV・舌画像は実行時にユーザーが選択するためリポジトリに含めない.