KCodeFlow - VSCode Extension

📑 About the project

The project is a VSCode extension, that tracks your keystrokes, while coding. Do you really need it? Probably not. Is it fun to have? Definitely! 🤓 You can download it on the VSCode-Marketplace. Happy typing!

(back to top)

⚙️ Commands

• KCodeFlow: Show Count-Analytics - Shows the analytics of your keystrokes
• KCodeFlow: Show most often pressed keys - Shows the most often pressed keys

🔥 Features

📊 Keep track of your total keystrokes and wpm

📊 Show analytics

(back to top)

🐛 Known Issues

• Sometimes a test randomly fails. This is probably due to minimal timing changes while testing the wpm calculations.
• When selecting something from IntelliSense, then the selected text is counted as the keystroke.

🔢 Getting started

1. Clone the repository

   git clone https://github.com/MhouneyLH/KCodeFlow.git

2. Install the npm packages

   npm install

3. Run tests. (Optional)

   npm run test

(back to top)

👨🏻‍💼 Contributing

Contributions are always welcome! Please look at following commit-conventions, while contributing: https://www.conventionalcommits.org/en/v1.0.0/#summary 😃

1. Fork the project.
2. Pick or create an issue you want to work on.
3. Create your Feature-Branch. (git checkout -b feat/best_feature)
4. Commit your changes. (git commit -m 'feat: add some cool feature')
5. Push to the branch. (git push origin feat/best_feature)
6. Open a Pull-Request into the Develop-Branch.

(back to top)