Elgato_dark/void
1
0
Fork 0
mirror of https://github.com/voideditor/void synced 2026-05-23 17:38:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' of https://github.com/voideditor/void

Browse source
This commit is contained in:
Andrew 2024-09-17 14:43:20 -07:00
commit fa977d7c9a
4 changed files with 26 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
CONTRIBUTING.md
View file

@ -12,8 +12,9 @@ There are two main ways to contribute:
See the [Roadmap](#roadmap) section for a list of the most important features to build, or feel free to build your own features.
We use a [VSCode extension](https://code.visualstudio.com/api/get-started/your-first-extension) to implement most of Void's functionality. Scroll down to see 1. How to contribute to the Extension, or 2. How to contribute to the full IDE (for more native changes).
We use a [VSCode extension](https://code.visualstudio.com/api/get-started/your-first-extension) to implement most of Void's functionality. Scroll down to see 1. How to build/contribute to the Extension, or 2. How to build/contribute to the full IDE (for more native changes).
For some useful links we've compiled see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md).
@ -21,6 +22,11 @@ We use a [VSCode extension](https://code.visualstudio.com/api/get-started/your-f
Here are the most important topics on our Roadmap. More ⭐'s = more important.
## ⭐⭐⭐ Improve diffs.
We define a "diff" as a single green/red pair that denotes a change. Here are improvements to make:
@ -47,6 +53,13 @@ Right now, the model outputs entire files. Instead, we should change the prompt
We have an Ollama integration coded up in the extension, but it breaks. This is because Ollama has Node.js dependencies like 'path' and 'os' which cannot run in extensions (extensions have to be able to run in the browser). To fix this, we need to migrate Void's extension so that it runs natively into the VS Code editor so that we can access Node.js.
## ⭐⭐⭐ Creative.
Feel free to build AI features beyond the standard Cursor ones. For example, creating better code search, or supporting AI agents that can edit across files and make multiple LLM calls.
Eventually, we want to build a convenient API for creating AI tools. The API will provide methods for creating the UI (showing an autocomplete suggestion, or creating a new diff), detecting event changes (like `onKeystroke` or `onFileOpen`), and modifying the user's file-system (storing indexes associated with each file), making it much easier to make your own AI plugin. We plan on building these features further along in timeline, but we wanted to list them for completeness.
## ⭐ One-stars.
⭐ When user presses ctrl+L it should clear the sidebar's state.
@ -57,17 +70,9 @@ We have an Ollama integration coded up in the extension, but it breaks. This is
⭐ Allow user to X out of their current selection.
## ⭐⭐⭐⭐ Four-stars (creative).
Feel free to build AI features beyond the standard Cursor ones. For example, creating better code search, or supporting AI agents that can edit across files and make multiple LLM calls.
Eventually, we want to build a convenient API for creating AI tools. The API will provide methods for creating the UI of your tool (showing an autocomplete suggestion, or creating a new diff), detecting event changes (like `onKeystroke` or `onFileOpen`), and modifying the user's file-system (storing indexes associated with each file), making it much easier to make your own AI plugin.
## 1. Contributing to the Extension
Here's how you can start contributing to the Extension:
## 1. Building the Extension
Here's how you can start contributing to and building the Extension:
1. Clone the repository
@ -91,9 +96,9 @@ Press <kbd>F5</kbd>. This will start a new instance of VS Code with the extensio
If you would like to use AI features, you need to provide an API key. You can do that by going to Settings (<kbd>Ctrl+,</kbd>) and modifying `void > "Anthropic Api Key"`. The "Which API" environment variable controls the provider and defaults to "anthropic".
## 2. Contributing to the full IDE
## 2. Building the full IDE
Beyond the extension, we sometimes edit the IDE when we need to access more functionality. If you want to make a change to the IDE, please follow the steps below, or see VS Code's full [how to contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page.
Beyond the extension, we sometimes edit the IDE when we need to access more functionality. If you want to build the full IDE after making a change, please follow the steps below, or see VS Code's full [how to contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page.
1. Install all dependencies by running `yarn`.

9
README.md
View file

@ -3,13 +3,13 @@
Void is the open-source Cursor alternative. It's a fork of the of [vscode](https://github.com/microsoft/vscode) repository.
This repo contains the full sourcecode for Void. We have a [waitlist](https://voideditor.com/email) for downloading the official release, but you can build and develop Void right now.
## Contributing
To contribute, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md).
To build and run Void, see [`CONTRIBUTING.md`](https://github.com/voideditor/void/blob/main/CONTRIBUTING.md).
We're in early stages and building quickly. We welcome all new contributions!
We welcome all new contributions!
## Reference
For some useful links we've compiled see [`VOID_USEFUL_LINKS.md`](https://github.com/voideditor/void/blob/main/VOID_USEFUL_LINKS.md).
@ -17,4 +17,5 @@ For some useful links we've compiled see [`VOID_USEFUL_LINKS.md`](https://github
## Anything else
Feel free to reach out in our Discord or contact us via email.
## Support
Discord: https://discord.gg/PspNkKG5wt

4
VOID_USEFUL_LINKS.md
View file

@ -26,8 +26,8 @@ Void is mainly an extension right now, and these links were very useful for us t
- ["Contributes" Guide](https://code.visualstudio.com/api/references/contribution-points) - the `"contributes"` part of `package.json` is how an extension mounts.
- [Activation events](https://code.visualstudio.com/api/references/activation-events) you can define in `package.json`.
- [The Full VSCode Extension API](https://code.visualstudio.com/api/references/vscode-api) - look on the right side for organization. The [bottom](https://code.visualstudio.com/api/references/vscode-api#api-patterns) of the page is easy to miss but is useful - cancellation tokens, events, disposables.
- [Activation events](https://code.visualstudio.com/api/references/activation-events) you can define in `package.json` (not the most useful)

2
src/main.js
View file

@ -320,7 +320,7 @@ function configureCommandlineSwitchesSync(cliArgs) {
app.commandLine.appendSwitch('disable-features', featuresToDisable);
// Blink features to configure.
// `FontMatchingCTMigration` - Siwtch font matching on macOS to Appkit (Refs https://github.com/microsoft/vscode/issues/224496#issuecomment-2270418470).
// `FontMatchingCTMigration` - Switch font matching on macOS to Appkit (Refs https://github.com/microsoft/vscode/issues/224496#issuecomment-2270418470).
const blinkFeaturesToDisable =
`FontMatchingCTMigration,${app.commandLine.getSwitchValue('disable-blink-features')}`;
app.commandLine.appendSwitch('disable-blink-features', blinkFeaturesToDisable);