Skip to content

Mefisto04/dev-tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dev Tracker 🚀

npm version License: MIT GitHub stars

Dev Tracker is a developer productivity tool that monitors file changes in your project directory. It tracks additions, deletions, and modifications, providing detailed insights into your coding activity. Perfect for developers who want to analyze their workflow or keep track of changes in real-time.


Features ✨

  • Real-Time File Monitoring: Tracks file changes (additions, modifications, deletions) in your project.
  • Detailed Reports: Generates a summary of file changes, including additions, deletions, and time spent.
  • Top Modified Files: Highlights the most frequently modified files.
  • Dependency Tracking: Lists all dependencies used in the project.
  • Language Statistics: Shows the top 3 most used languages in your project.
  • Easy to Use: Just run the command and start tracking!

Installation 📦

To install Dev Tracker globally, run:

npm install -g dev-tracker

Usage 🛠️

  1. Navigate to your project directory:

    cd path/to/your/project
  2. Start tracking:

    dev-tracker
  3. Make changes to your files (create, modify, or delete files).

  4. Press Ctrl+C to stop tracking and generate a report.


Example Report 📊

When you stop the tracker, it will generate a report like this:

Project Summary
┌───────────────────────┬────────────────────────────────────────────┐
│ Metric                │ Value                                      │
├───────────────────────┼────────────────────────────────────────────┤
│ Total Time            │ 2 hours                                    │
│ Files Tracked         │ 15                                         │
│ Total Additions       │ +120                                       │
│ Total Deletions       │ -45                                        │
│ Top Languages         │ JavaScript (10 files), CSS (3 files), JSON │
└───────────────────────┴────────────────────────────────────────────┘

Top Modified Files
┌──────────────────────────────────────┬────────────┬────────────┬─────────┬─────────────────────┐
│ File                                 │ Additions  │ Deletions  │ Changes │ Last Modified       │
├──────────────────────────────────────┼────────────┼────────────┼─────────┼─────────────────────┤
│ src/index.js                         │ +25        │ -10        │ 5       │ 2023-10-15 14:30    │
│ src/reporter.js                      │ +15        │ -5         │ 3       │ 2023-10-15 14:25    │
└──────────────────────────────────────┴────────────┴────────────┴─────────┴─────────────────────┘

Project Dependencies
┌──────────────────────────────────────────────────────────────────────┐
│ Dependencies                                                         │
├──────────────────────────────────────────────────────────────────────┤
│ chalk                                                                │
│ chokidar                                                             │
│ cli-table3                                                           │
└──────────────────────────────────────────────────────────────────────┘
Total dependencies: 7

Configuration ⚙️

By default, Dev Tracker ignores the following directories and files:

  • node_modules
  • .git
  • .devtracker (internal snapshot directory)
  • package-lock.json

To customize ignored paths, modify the ignored array in the FileTracker class.


Contributing 🤝

Contributions are welcome! If you'd like to contribute to Dev Tracker, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Open a pull request.

License 📄

This project is licensed under the MIT License. See the LICENSE file for details.


Support 💬

If you encounter any issues or have questions, feel free to open an issue on GitHub.


Author 👨‍💻

Developed by mefisto04.

Releases

No releases published

Packages

No packages published