Skip to content

Commit c222d4d

Browse files
committed
🧹 Clean project structure and improve .gitignore - Remove temporary files (.DS_Store, old exports, logs) - Enhance .gitignore with better macOS and Go support - Add proper ignore rules for exports/* and logs/* directories - Add .gitkeep files to maintain directory structure - Document exports/ and logs/ directories with README files - Improve repository cleanliness and prevent accidental commits of personal data
1 parent d98412a commit c222d4d

File tree

5 files changed

+90
-1
lines changed

5 files changed

+90
-1
lines changed

‎.gitignore‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ creds.js
3737

3838
# Mac/OSX
3939
.DS_Store
40+
.DS_Store?
41+
._*
42+
.Spotlight-V100
43+
.Trashes
44+
ehthumbs.db
45+
Thumbs.db
4046

4147
# Cursor
4248
.cursor/
@@ -51,6 +57,16 @@ TEMP/
5157
/backup/
5258
backup/
5359

60+
# Export files (keep directory structure but ignore content)
61+
exports/*
62+
!exports/.gitkeep
63+
!exports/README.md
64+
65+
# Log files (keep directory structure but ignore content)
66+
logs/*
67+
!logs/.gitkeep
68+
!logs/README.md
69+
5470
# Byte-compiled / optimized / DLL files
5571
__pycache__/
5672
*.py[cod]
@@ -189,7 +205,6 @@ dmypy.json
189205
# Cython debug symbols
190206
cython_debug/
191207
*.tar.gz
192-
/logs
193208

194209
test_run/
195210

@@ -202,4 +217,18 @@ test_prod/
202217
config/config.toml
203218
# But keep the example file
204219
!config/config.example.toml
220+
221+
# Go specific ignores
205222
export_trakt
223+
*.exe
224+
*.exe~
225+
*.dll
226+
*.so
227+
*.dylib
228+
229+
# Go test files
230+
*.test
231+
*.out
232+
233+
# Go workspace file
234+
go.work

‎exports/.gitkeep‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This file keeps the exports directory in git while ignoring all export files
2+
# Export files are generated dynamically and should not be committed

‎exports/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Exports Directory
2+
3+
This directory contains the exported data from Trakt.tv in Letterboxd-compatible format.
4+
5+
## Structure
6+
7+
Export files are automatically generated with timestamps:
8+
9+
- `export_YYYY-MM-DD_HH-MM/` - Timestamped export directories
10+
- Each export contains CSV files compatible with Letterboxd import
11+
12+
## Usage
13+
14+
Export files are created when running the application:
15+
16+
```bash
17+
./export_trakt --config ./config/config.toml
18+
```
19+
20+
## Note
21+
22+
Export files are automatically ignored by git as they contain personal data and are meant to be used locally or uploaded to Letterboxd manually.

‎logs/.gitkeep‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This file keeps the logs directory in git while ignoring all log files
2+
# Log files are generated at runtime and should not be committed

‎logs/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Logs Directory
2+
3+
This directory contains application log files generated during runtime.
4+
5+
## Log Files
6+
7+
The application generates several types of log files:
8+
9+
- `export.log` - Main application log
10+
- `app.log` - General application events
11+
- `cron.log` - Scheduled export logs
12+
- `Export_Trakt_4_Letterboxd_YYYY-MM-DD_HH-MM-SS.log` - Timestamped execution logs
13+
14+
## Log Levels
15+
16+
The application supports multiple log levels:
17+
18+
- `ERROR` - Error messages
19+
- `WARN` - Warning messages
20+
- `INFO` - Informational messages
21+
- `DEBUG` - Debug messages (verbose mode)
22+
23+
## Configuration
24+
25+
Log level can be configured in the `config.toml` file:
26+
27+
```toml
28+
[logging]
29+
level = "info"
30+
```
31+
32+
## Note
33+
34+
Log files are automatically ignored by git as they contain runtime information and can become large over time.

0 commit comments

Comments
 (0)