Changelogd Automated Mark Down Annotation
Overview
The **Changelogd Automated Mark Down Annotation ** is a Visual Studio Code extension that monitors changes made to open files within the editor. It captures changes in real time and outputs them in a Markdown format, allowing developers to easily track modifications.
Features
- Real-Time File Monitoring: Automatically detects when files are opened and modified.
- Markdown Output: Changes are logged in a clear, formatted Markdown style for easy readability.
- Async Operations: Utilizes asynchronous functions for efficiency and potential future enhancements.
Installation
To install this extension, follow these steps:
Ensure you have Node.js installed on your system. You can download it from Node.js official website.
Clone the repository to your local machine:
git clone https://github.com/yourusername/real-time-file-change-notifier.git
Navigate to the project directory:
cd real-time-file-change-notifier
Install the necessary dependencies:
npm install
Open the extension in Visual Studio Code:
code .
Start the extension in a new Extension Development Host window by pressing F5.
Usage
Once the extension is activated, any changes made to an open document will be logged in the Debug Console in Markdown format. The output will include:
- The name of the file being modified.
- The text added or changed.
- The specific range of the changes in line and character format.
Example Output
When changes are made to a file, the output may look like this in the Debug Console:
### Changes in **myFile.txt**
#### Change 1
**Added Text:** `Hello`
**Range:** `[0, 0] to [0, 5]`
#### Change 2
**Added Text:** `World`
**Range:** `[1, 0] to [1, 5]`
Collaborators
This project is a collaborative effort by:
Contributing
If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix:
git checkout -b feature/YourFeature
- Make your changes and commit them:
git commit -m "Add your commit message"
- Push your changes to your forked repository:
git push origin feature/YourFeature
- Create a pull request to the main repository.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
For any inquiries or questions, please contact: