diff options
| author | Nate Sesti <sestinj@gmail.com> | 2023-07-23 12:38:46 -0700 |
|---|---|---|
| committer | Nate Sesti <sestinj@gmail.com> | 2023-07-23 12:38:46 -0700 |
| commit | 986e3c57a0e3a9c71e6bff5488d1bcda80cbf4c6 (patch) | |
| tree | f8b178237a928c1a7af687636579a6dc0a6c48d7 /extension | |
| parent | 0ad32bd6dfaf96af0a2db82fb2b06c200e131e62 (diff) | |
| download | sncontinue-986e3c57a0e3a9c71e6bff5488d1bcda80cbf4c6.tar.gz sncontinue-986e3c57a0e3a9c71e6bff5488d1bcda80cbf4c6.tar.bz2 sncontinue-986e3c57a0e3a9c71e6bff5488d1bcda80cbf4c6.zip | |
documentation
Diffstat (limited to 'extension')
| -rw-r--r-- | extension/DEV_README.md | 13 | ||||
| -rw-r--r-- | extension/package.json | 2 |
2 files changed, 12 insertions, 3 deletions
diff --git a/extension/DEV_README.md b/extension/DEV_README.md index 87ed9334..72ea5c6a 100644 --- a/extension/DEV_README.md +++ b/extension/DEV_README.md @@ -6,8 +6,17 @@ 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). -4. Open Continue +## Setting up for development -# Notes +1. Clone this repo +2. `cd extension` +3. `npm run full-package` + + > 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. + +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. + +## Notes - We require vscode engine `^1.67.0` and use `@types/vscode` version `1.67.0` because this is the earliest version that doesn't break any of the APIs we are using. If you go back to `1.66.0`, then it will break `vscode.window.tabGroups`. diff --git a/extension/package.json b/extension/package.json index 08737ff4..6ab2d74a 100644 --- a/extension/package.json +++ b/extension/package.json @@ -227,7 +227,7 @@ "test": "node ./out/test/runTest.js", "jest": "jest --config ./jest.config.js", "package": "cp ./config/prod_config.json ./config/config.json && mkdir -p ./build && vsce package --out ./build && cp ./config/dev_config.json ./config/config.json", - "full-package": "cd ../continuedev && poetry build && cp ./dist/continuedev-0.1.2-py3-none-any.whl ../extension/server/continuedev-0.1.2-py3-none-any.whl && cd ../extension && npm install && npm run typegen && npm run clientgen && cd react-app && npm install && npm run build && cd .. && npm run package", + "full-package": "cd ../continuedev && poetry install && poetry build && cp ./dist/continuedev-0.1.2-py3-none-any.whl ../extension/server/continuedev-0.1.2-py3-none-any.whl && cd ../extension && npm install && npm run typegen && npm run clientgen && cd react-app && npm install && npm run build && cd .. && npm run package", "install-extension": "code --install-extension ./build/continue-0.0.8.vsix", "uninstall": "code --uninstall-extension .continue", "reinstall": "rm -rf ./build && npm run package && npm run uninstall && npm run install-extension" |