Files
location-mqtt-tracker-app/package.json
Joachim Hummel 17aaf130a8 Add automatic documentation synchronization system
Implements Option C (Hybrid) solution to prevent outdated documentation:

New Features:
- Pre-commit git hook that validates documentation before every commit
- npm run docs:check - Validates README against current project state
- npm run docs:sync - Automatically updates NPM Scripts section in README

What gets checked:
- NPM Scripts in package.json vs README
- API routes in app/api/* vs README
- App structure (directories in app/) vs README
- Components vs README
- Scripts vs README

Workflow:
1. Make code changes
2. git commit triggers pre-commit hook
3. Hook warns if documentation is outdated
4. Run docs:sync to auto-update or edit manually
5. Commit with updated README

Benefits:
- No more forgetting to update README
- Non-blocking (can use --no-verify if needed)
- Automatic NPM scripts synchronization
- Clear warnings show exactly what needs updating

Scripts added:
- scripts/check-docs.js - Validation script
- scripts/sync-docs.js - Synchronization script
- .git/hooks/pre-commit - Git hook (not tracked)

Documentation:
- Added complete workflow section in README
- Examples and usage tips included

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 12:27:52 +00:00

60 lines
2.0 KiB
JSON

{
"name": "location-tracker-app",
"version": "1.0.0",
"description": "Location Tracking Application with Next.js, SQLite and OwnTracks integration",
"main": "index.js",
"scripts": {
"dev": "next dev",
"build": "next build",
"start": "next start",
"lint": "next lint",
"db:init": "node scripts/init-database.js && node scripts/init-locations-db.js && node scripts/init-geofence-db.js",
"db:init:app": "node scripts/init-database.js",
"db:init:locations": "node scripts/init-locations-db.js",
"db:init:geofence": "node scripts/init-geofence-db.js",
"db:cleanup": "node scripts/cleanup-old-locations.js",
"db:cleanup:7d": "node scripts/cleanup-old-locations.js 168",
"db:cleanup:30d": "node scripts/cleanup-old-locations.js 720",
"test:location": "node scripts/add-test-location.js",
"test:geofence": "node scripts/test-geofence.js",
"test:geofence:email": "node scripts/test-geofence-notification.js",
"test:geofence:mqtt": "node scripts/test-mqtt-geofence.js",
"docs:check": "node scripts/check-docs.js",
"docs:sync": "node scripts/sync-docs.js",
"email:dev": "email dev"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@react-email/components": "^0.5.7",
"@tailwindcss/postcss": "^4.1.17",
"@types/bcryptjs": "^2.4.6",
"@types/leaflet": "^1.9.21",
"@types/node": "^24.10.1",
"@types/react": "^19.2.4",
"@types/react-dom": "^19.2.3",
"bcryptjs": "^3.0.3",
"better-sqlite3": "^12.4.1",
"leaflet": "^1.9.4",
"mqtt": "^5.14.1",
"next": "^16.0.7",
"next-auth": "^5.0.0-beta.30",
"nodemailer": "^7.0.10",
"react": "^19.2.1",
"react-dom": "^19.2.1",
"react-email": "^4.3.2",
"react-leaflet": "^5.0.0",
"typescript": "^5.9.3",
"uuid": "^10.0.0"
},
"devDependencies": {
"@types/better-sqlite3": "^7.6.13",
"@types/nodemailer": "^7.0.3",
"@types/uuid": "^10.0.0",
"autoprefixer": "^10.4.22",
"postcss": "^8.5.6",
"tailwindcss": "^4.1.17"
}
}