From 0930f7048c9fcf5836cbee92e37a95f45693ded8 Mon Sep 17 00:00:00 2001 From: Ty Dunn Date: Mon, 5 Jun 2023 08:53:48 +0200 Subject: outcomes of work session --- extension/src/README.md | 42 +++++++++------------------- extension/src/activation/environmentSetup.ts | 2 +- 2 files changed, 14 insertions(+), 30 deletions(-) (limited to 'extension/src') diff --git a/extension/src/README.md b/extension/src/README.md index 76b96ea0..126a094a 100644 --- a/extension/src/README.md +++ b/extension/src/README.md @@ -2,47 +2,31 @@ ## How to get started with development -1. Clone the `continue` repo +1. Clone the Continue repo -2. Open a VS Code window with 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 `package/server/README.md` +3. Package and then start the FastAPI server by following instructions outlined in the `Continue Server` section of the `continuedev/README.md` -4. Open the `extension` sub-directory of the repo in a second VS Code window +4. Open a VS Code window with the `extension` directory as your workspace -5. Run `npm install` +5. From `continue/extension`, run `npm install` -6. Run `npm run clientgen` +6. Run `npm run full-package` -7. Run `cd react-app` +7. Open `src/activation/activate.ts` file (or any TypeScript file) -8. Run `npm run build` +8. Press `F5` on your keyboard to start `Run and Debug` mode -9. Run `cd ..` to return to `extension` directory +9. `cmd+shift+p` to look at developer console and select Continue commands -10. Then run `npm run compile` +10. Every time you make changes to the code, you need to run `npm run compile` -11. Open `src/activate.ts` file (or any TypeScript file) +11. If you run into a "command not found" error, try running `npm run rebuild` and then `npm run compile` -12. Press `F5` on your keyboard to start `Run and Debug` mode +## Alternative: Install from source -13. `cmd+shift+p` to look at developer console and select Continue commands - -14. Every time you make changes to the code, you need to run `npm run compile` - -15. If you run into a "command not found" error, try running `npm run rebuild` and then `npm run compile` - -## Alternative: Install a packaged version - -You should always have a packaged version installed in VS Code, because when Continue is broken you'll want a stable version to help you debug. There are four key commands in the `package.json`: - -1. `npm run package` will create a .vsix file in the `build/` folder that can then be installed. It is this same file that you can share with others who want to try the extension. - -2. `npm run install-extension` will install the extension to VS Code. You should then see it in your installed extensions in the VS Code sidebar. - -3. `npm run uninstall` will uninstall the extension. You don't always have to do this thanks to the reinstall command, but can be useful when you want to do so manually. - -4. `npm run reinstall` will go through the entire process of uninstalling the existing installed extension, rebuilding, and then installing the new version. You shouldn't be doing this every time you make a change to the extension, but rather when there is some significant update that you would like to make available to yourself (or if you happen to be debugging something which is specific to the packaged extension). +Update: directions to root README ## Background diff --git a/extension/src/activation/environmentSetup.ts b/extension/src/activation/environmentSetup.ts index 170426e1..21f867b1 100644 --- a/extension/src/activation/environmentSetup.ts +++ b/extension/src/activation/environmentSetup.ts @@ -88,7 +88,7 @@ async function setupPythonEnv() { const createEnvCommand = [ `cd ${path.join(getExtensionUri().fsPath, "scripts")}`, `${pythonCmd} -m venv env`, - ].join(" && "); + ].join(" ; "); // Repeat until it is successfully created (sometimes it fails to generate the bin, need to try again) while (true) { -- cgit v1.2.3-70-g09d2 From f61f8a6523e6f238e67dbe5600d6546642e2b7bf Mon Sep 17 00:00:00 2001 From: Ty Dunn Date: Mon, 5 Jun 2023 09:26:40 +0200 Subject: README changes --- README.md | 23 +++++------------------ extension/src/README.md | 2 +- 2 files changed, 6 insertions(+), 19 deletions(-) (limited to 'extension/src') diff --git a/README.md b/README.md index 92570126..6429c715 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,9 @@ Learn how to try the GitHub Codespaces Demo [here](https://continue.dev/docs/get Learn how to install locally in VS Code [here](https://continue.dev/docs/install) -## Walkthroughs - -- [Use the GUI](https://continue.dev/docs/walkthroughs/use-the-gui.md) -- [Use a recipe](https://continue.dev/docs/walkthroughs/use-a-recipe.md) -- [Create a recipe](https://continue.dev/docs/walkthroughs/create-a-recipe.md) -- [Share a recipe](https://continue.dev/docs/walkthroughs/share-a-recipe.md) - ## How to contribute -### Option 1: Create a recipe and share it with the community - -Follow [these steps](https://continue.dev/docs/walkthroughs/share-a-recipe.md) to share a recipe you have created :) - -### Option 2: Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues) - -Let us know what you would like to contribute and we will help you make it happen! +Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues). Let us know what you would like to contribute there, and we will help you make it happen! ## Install from source @@ -68,13 +55,13 @@ cd continue/extension/scripts && python3 install_from_source.py # Understanding the codebase -- [Continue Server README](./continuedev): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/) -- [VS Code Extension README](./extension/src): learn about the capabilities of our extension—the first implementation of Continue's IDE Protocol—which makes it possible to use use Continue in VS Code and GitHub Codespaces +- [Continue Server README](./continuedev/README.md): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/) +- [VS Code Extension README](./extension/README.md): learn about the capabilities of our extension—the first implementation of Continue's IDE Protocol—which makes it possible to use use Continue in VS Code and GitHub Codespaces - [Continue GUI README](./extension/react-app/): learn about the React app that lets users interact with the server and is placed adjacent to the text editor in any suppported IDE - [Schema README](./schema): learn about the JSON Schema types generated from Pydantic models, which we use across the `continuedev/` and `extension/` directories - [Continue Docs README](./docs): learn how our [docs](https://continue.dev/docs) are written and built -- Add steps for development README mention here +- [How to debug the VS Code Extension README](./extension/src/README.md): learn how to set up the VS Code extension, so you can debug it # License -[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE) +[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE) \ No newline at end of file diff --git a/extension/src/README.md b/extension/src/README.md index 126a094a..8523ec86 100644 --- a/extension/src/README.md +++ b/extension/src/README.md @@ -1,6 +1,6 @@ # Continue VS Code Extension README -## How to get started with development +## How to debug the VS Code Extension 1. Clone the Continue repo -- cgit v1.2.3-70-g09d2