diff options
| -rw-r--r-- | extension/DEV_README.md | 23 | ||||
| -rw-r--r-- | extension/src/README.md | 59 |
2 files changed, 16 insertions, 66 deletions
diff --git a/extension/DEV_README.md b/extension/DEV_README.md index 8e244bc3..3ad9cf68 100644 --- a/extension/DEV_README.md +++ b/extension/DEV_README.md @@ -6,16 +6,25 @@ This is the Continue VS Code Extension. Its primary jobs are 2. Open the Continue React app in a side panel. The React app's source code lives in the `react-app` directory. The panel is opened by the `continue.openContinueGUI` command, as defined in `src/commands.ts`. 3. Run a Continue server in the background, which connects to both the IDE protocol and the React app. The server is launched in `src/activation/environmentSetup.ts` by calling Python code that lives in `server/` (unless extension settings define a server URL other than localhost:65432, in which case the extension will just connect to that). -## Setting up for development +## How to debug the VS Code Extension -1. Clone this repo -2. `cd extension` -3. `npm run package` +1. Clone the Continue repo - > If NPM is not installed, you can use `brew install node` on Mac, or see the [installation page](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) for other platforms, or more detailed instructions. +2. Open a VS Code window with the `continue` directory as your workspace -4. Open a VS Code window with `/extension` as the workspace root (_this is important, development mode will not work otherwise_) -5. Open any `.ts` file in the workspace, then press F5 and select "VS Code Extension Development" to begin debugging. +3. Package and then start the FastAPI server by following instructions outlined in the `Continue Server` section of the `continuedev/README.md` + +4. Open a VS Code window with the `extension` directory as your workspace + +5. Run `npm run package` + +6. Open `src/activation/activate.ts` file (or any TypeScript file) + +7. Press `F5` on your keyboard to start `Run and Debug` mode + +8. `cmd+shift+p` to look at developer console and select Continue commands + +9. Every time you make changes to the code, you need to run `npm run esbuild` unless you make changes inside of `react-app` and then you need to run `npm run build` from there ## Notes diff --git a/extension/src/README.md b/extension/src/README.md deleted file mode 100644 index ef90c31b..00000000 --- a/extension/src/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# Continue VS Code Extension README - -## How to debug the VS Code Extension - -1. Clone the Continue repo - -2. Open a VS Code window with the `continue` directory as your workspace - -3. Package and then start the FastAPI server by following instructions outlined in the `Continue Server` section of the `continuedev/README.md` - -4. Open a VS Code window with the `extension` directory as your workspace - -5. From `continue/extension`, run `npm install` - -6. Run `npm run package` - -7. Open `src/activation/activate.ts` file (or any TypeScript file) - -8. Press `F5` on your keyboard to start `Run and Debug` mode - -9. `cmd+shift+p` to look at developer console and select Continue commands - -10. Every time you make changes to the code, you need to run `npm run esbuild` unless you make changes inside of `react-app` and then you need to run `npm run build` from there - -## Alternative: Install from source - -Update: directions to root README - -## Background - -- `src/bridge.ts`: connects this VS Code Extension to our Python backend that interacts with GPT-3 -- `src/debugPanel.ts`: contains the HTML for the full window on the right (used for investigation) -- `src/DebugViewProvider.ts`: contains the HTML for the bottom left panel -- `src/extension.ts`: entry point into the extension, where all of the commands / views are registered (activate function is what happens when you start extension) -- `media/main.js`: handles messages sent from the extension to the webview (bottom left) -- `media/debugPanel.js`: loaded by right window - -## Features - -- `List 10 things that might be wrong` button -- `Write a unit test to reproduce bug` button -- Highlight a code range + `Find Suspicious Code` button -- `Suggest Fix` button -- A fix suggestion shown to you + `Make Edit` button -- Write a docstring for the current function -- Ask a question about your codebase -- Move up / down to the closest suggestion - -## Commands - -- "Write a docstring for the current function" command (windows: `ctrl+alt+l`, mac: `shift+cmd+l`) -- "Open Continue GUI" command -- "Ask a question from input box" command (windows: `ctrl+alt+j`, mac: `shift+cmd+j`) -- "Open Captured Terminal" command -- "Ask a question from webview" command (what context is it given?) -- "Create Terminal" command ??? -- "Suggestion Down" command (windows: `shift+ctrl+down`, mac: `shift+ctrl+down`) -- "Suggestion Up" command (windows: `shift+ctrl+up`, mac: `shift+ctrl+up`) -- "Accept Suggestion" command (windows: `shift+ctrl+enter`, mac: `shift+ctrl+enter`) |