https://github.com/hydrovolter/ext-vscode-presence
VS Code extension that fetches workspace presence and sends it to an API
https://github.com/hydrovolter/ext-vscode-presence
activity api extension presence vscode vscode-extension
Last synced: 7 months ago
JSON representation
VS Code extension that fetches workspace presence and sends it to an API
- Host: GitHub
- URL: https://github.com/hydrovolter/ext-vscode-presence
- Owner: Hydrovolter
- License: mit
- Created: 2025-03-27T20:25:38.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-27T22:52:21.000Z (7 months ago)
- Last Synced: 2025-03-27T23:29:02.746Z (7 months ago)
- Topics: activity, api, extension, presence, vscode, vscode-extension
- Language: JavaScript
- Homepage:
- Size: 1.14 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# VS Code Presence Extension
A Visual Studio Code extension that fetches workspace information and sends it to a public API. Designed to integrate with external services by providing real-time updates about your current workspace (for example, [my portfolio](https://hydrovolter.com))
## Features
- Fetches workspace details such as:
- Current file name
- Workspace folder name
- Active programming language
- Sends the collected data to a configurable public API endpoint.
- Lightweight and easy to configure.
## Development
1. Clone this repository:
```bash
git clone https://github.com/hydrovolter/ext-vscode-presence.git
```
2. Install dependencies:
```bash
npm install
```
3. Open the folder in Visual Studio Code.
4. Run the extension in the Extension Development Host:
- Press `F5` or go to `Run > Start Debugging`.
## Installation
1. Clone this repository:
```bash
git clone https://github.com/hydrovolter/ext-vscode-presence.git
```
2. Install dependencies:
```bash
npm install
```
3. Open the folder in Visual Studio Code.
4. Compile the extension:
```bash
vsce package
```
You will need to have your own API. I personally use Cloudflare Workers. A simple example API for Cloudflare Workers is provided in the example.workers.js file. (I use a variation of this one!)
## Usage
1. Configure the API endpoint in the extension settings:
- Go to `File > Preferences > Settings` (or `Code > Preferences > Settings` on macOS).
- Search for `API URL` and set the URL of your public API.
2. Open a workspace in VS Code. The extension will automatically fetch workspace information and send it to the configured API.
## Configuration
The extension provides the following settings:
- **API URL**: The API URL to send workspace data.
- **Sync Interval**: Interval in milliseconds between API syncs (minimum 1000ms)
## Development
To contribute or modify the extension:
1. Install dependencies:
```bash
npm install
```
2. Make your changes and test them in the Extension Development Host.
## License
This project is licensed under the [MIT License](LICENSE).
Made by Hydrovolter