crash.log written into repo root on Linux (breaks Syncthing casing sync)

オープン 初心者向け
#3 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
desktop

調査の方向性

plotruler/main.py の _crash_log_path() から始め、Linux で LOCALAPPDATA と TEMP が未設定の場合に fallback がどのように動作するかを確認してください。リポジトリ内に大文字の PlotRuler ディレクトリを作成できない、プラットフォームに適した場所を選んで実装し、その後 crash.log が作業ツリーの外部に書き込まれることを確認してください。関連する .gitignore の提案も検討してください。

索引モデルが issue の本文から書いたものです。

説明

Summary

When run on Linux with LOCALAPPDATA/TEMP unset, _crash_log_path() falls back to ".", so the crash log is written to ./PlotRuler/crash.log inside the repository working tree.

Code

plotruler/__main__.py:

def _crash_log_path():
    base = os.environ.get("LOCALAPPDATA") or os.environ.get("TEMP") or "."
    return os.path.join(base, "PlotRuler", "crash.log")
  • Windows: LOCALAPPDATA is set → %LOCALAPPDATA%\PlotRuler\crash.log (fine).
  • Linux/macOS: neither var is set → logs to ./PlotRuler/crash.log.

Problem

The repo root already contains the lowercase package plotruler/. On case-insensitive filesystems (Windows/macOS) the two collide, and tools that sync the tree — e.g. Syncthing — report a casing conflict:

remote "Programming\GraphRuler\PlotRuler" uses different upper or lowercase characters than local "Programming\GraphRuler\plotruler"

so the items never sync until the stray PlotRuler/ dir is deleted manually.

Suggestion

Use a platform-appropriate XDG path on non-Windows, e.g.:

base = os.environ.get("LOCALAPPDATA") or os.environ.get("XDG_STATE_HOME", os.path.expanduser("~/.local/state"))

and/or log with the app name directly rather than a capital-cased dir that can shadow the lowercase package. Also consider ignoring the runtime dir in .gitignore as a belt-and-suspenders measure.

主要言語
Python
スター
1
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

endolith/plotruler のほかの issue

endolith/plotruler の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。