crash.log written into repo root on Linux (breaks Syncthing casing sync)
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 0
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
## 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`:
```python
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.:
```python
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Inizia in plotruler/__main__.py, da _crash_log_path(), e analizza il comportamento del fallback quando LOCALAPPDATA e TEMP non sono impostate su Linux. Scegli e implementa una posizione appropriata per la piattaforma che non possa creare una directory PlotRuler nel repository, quindi verifica che crash.log venga scritto al di fuori dell’albero di lavoro; considera la relativa proposta per .gitignore.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- desktop
- Tipo di issue
- Bug
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Attiva
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 78/100