From de3f5b3bacc0708a5686b20ffb669069234c3e3c Mon Sep 17 00:00:00 2001 From: Karol Harezlak Date: Tue, 7 Feb 2023 16:40:15 -0800 Subject: [PATCH 1/3] The docs update, mostly related to how to package the extension and how to install it. --- .vscodeignore | 12 ++++++++++++ README.md | 18 ++++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 .vscodeignore diff --git a/.vscodeignore b/.vscodeignore new file mode 100644 index 0000000..6ad1103 --- /dev/null +++ b/.vscodeignore @@ -0,0 +1,12 @@ +.github +.idea +.vscode +.vscode-test +src +.eslintrc.cjs +.gitignore +.vscodeignore +package.json +package-lock.json +pre-commit.sh +tsconfig.json diff --git a/README.md b/README.md index f6c4d02..9411cb7 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,17 @@ To debug the tests, in the Activity Bar select "Run and Debug" and make sure the The Pyrsia extension is not available in the VS Code store yet, it's necessary to manually install the extension as described below. -### Package and Install (side-load extension) +### Install extension (side-load extension) + +- Download the latest version of the extension (vsix file) from the [project release page](https://github.com/pyrsia/pyrsia-vscode-extension/releases). + +- Close the IDE and install the extension using the `vsix` file downloaded in the previous step. + + ```sh + code --install-extension + ``` + +### Build package and install extension from the local repository (side-load extension) - Install [Visual Studio Code Extensions](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#vsce) with the following command. @@ -55,7 +65,7 @@ The Pyrsia extension is not available in the VS Code store yet, it's necessary t - In the extension repository folder package the extension as follows. ```sh - vsce package + vsce package --allow-star-activation --ignoreFile .vscodeignore --pre-release ``` - If the packaging was successful the last line of the VSCE logs should contain the `vsix` file path, for example: @@ -64,12 +74,12 @@ The Pyrsia extension is not available in the VS Code store yet, it's necessary t DONE Packaged: /home/joed/repositories/pyrsia-vscode-extension/pyrsia-integration-0.0.1.vsix (960 files, 2.2MB) ``` -- Copy the `vsix` file path and install the extension as follows. +- Close the IDE and install the extension using the `vsix` file path from the previous step. ```sh code --install-extension ``` - + ### Uninstall (side-load) - Find the extension in the list of the extensions (look for "pyrsia", for example `undefined_publisher.pyrsia-integration`). From ced238e30ca71b273dfc38d392caf37d10d105a3 Mon Sep 17 00:00:00 2001 From: Karol Harezlak <76980800+karolh2000@users.noreply.github.com> Date: Thu, 9 Feb 2023 11:00:33 -0800 Subject: [PATCH 2/3] Update README.md Co-authored-by: Manas Kumar Das --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9411cb7..1a9967a 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ To debug the tests, in the Activity Bar select "Run and Debug" and make sure the ## How to package, install and uninstall Pyrsia extension in the IDE -The Pyrsia extension is not available in the VS Code store yet, it's necessary to manually install the extension as described below. +The Pyrsia extension is not yet listed in the VS Code marketplace. For now it can still be installed manually following the instructions outlined below. ### Install extension (side-load extension) From b42f132319c649cf486dfd20dea1e10d258c9baf Mon Sep 17 00:00:00 2001 From: Karol Harezlak <76980800+karolh2000@users.noreply.github.com> Date: Thu, 9 Feb 2023 11:00:54 -0800 Subject: [PATCH 3/3] Update README.md Co-authored-by: Manas Kumar Das --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a9967a..b39f0a0 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ The Pyrsia extension is not yet listed in the VS Code marketplace. For now it ca npm install -g @vscode/vsce ``` -- In the extension repository folder package the extension as follows. +- Package the extension in the extension repository folder as follows. ```sh vsce package --allow-star-activation --ignoreFile .vscodeignore --pre-release