From 1bc29a8a3ab2bf774a3f1dd7a8ac7edd0892f976 Mon Sep 17 00:00:00 2001 From: M Atif Ali Date: Fri, 28 Mar 2025 22:56:49 +0500 Subject: [PATCH 1/4] chore(README.md): fix formatting and add OpenVSX badge Also Closes #269 --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 38fcc104..f14bbe82 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Coder Remote [![Visual Studio Marketplace](https://vsmarketplacebadges.dev/version/coder.coder-remote.svg)](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote) +[![Open VSX Version](https://img.shields.io/open-vsx/v/coder/coder-remote)](https://open-vsx.org/extension/coder/coder-remote) [!["Join us on Discord"](https://badgen.net/discord/online-members/coder)](https://coder.com/chat?utm_source=github.com/coder/vscode-coder&utm_medium=github&utm_campaign=readme.md) @@ -13,11 +14,12 @@ workspaces with a single click. - Works in air-gapped or restricted networks. Just connect to your Coder deployment! - Supports multiple editors: VS Code, Cursor, and Windsurf. - > [!NOTE] - > The extension builds on VSCode provided implementations of SSH. Make sure - > you have the correct ssh extension installed for your editor - > (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for - > windsurf) + +> [!NOTE] +> The extension builds on VSCode provided implementations of SSH. Make sure +> you have the correct ssh extension installed for your editor +> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for +> windsurf) ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true) @@ -26,7 +28,7 @@ workspaces with a single click. Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter. -```text +```shell ext install coder.coder-remote ``` @@ -36,9 +38,9 @@ Alternatively, manually install the VSIX from the #### Variables Reference Coder uses -${userHome} from VS Code's +`${userHome}` from VS Code's [variables reference](https://code.visualstudio.com/docs/editor/variables-reference). -Use this when formatting paths in the Coder extension settings rather than ~ or -$HOME. +Use this when formatting paths in the Coder extension settings rather than `~` or +`$HOME`. Example: ${userHome}/foo/bar.baz From e09bd77804f636d0cc0331624eb19947ed2cb7e1 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Fri, 28 Mar 2025 18:41:11 +0000 Subject: [PATCH 2/4] lint --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f14bbe82..a8796088 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,10 @@ workspaces with a single click. deployment! - Supports multiple editors: VS Code, Cursor, and Windsurf. -> [!NOTE] -> The extension builds on VSCode provided implementations of SSH. Make sure -> you have the correct ssh extension installed for your editor -> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for -> windsurf) +> [!NOTE] +> The extension builds on VSCode provided implementations of SSH. Make sure you +> have the correct ssh extension installed for your editor +> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for windsurf) ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true) @@ -35,12 +34,11 @@ ext install coder.coder-remote Alternatively, manually install the VSIX from the [latest release](https://github.com/coder/vscode-coder/releases/latest). -#### Variables Reference +### Variables Reference -Coder uses -`${userHome}` from VS Code's +Coder uses `${userHome}` from VS Code's [variables reference](https://code.visualstudio.com/docs/editor/variables-reference). -Use this when formatting paths in the Coder extension settings rather than `~` or -`$HOME`. +Use this when formatting paths in the Coder extension settings rather than `~` +or `$HOME`. Example: ${userHome}/foo/bar.baz From 0aecad358d822ef2d38c43fed8bb4f930fecb4bb Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Fri, 28 Mar 2025 18:54:19 +0000 Subject: [PATCH 3/4] chore: update Prettier configuration to allow GFM style alerts --- .prettierrc | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.prettierrc b/.prettierrc index a4c096bf..85e451a5 100644 --- a/.prettierrc +++ b/.prettierrc @@ -9,7 +9,7 @@ ], "options": { "printWidth": 80, - "proseWrap": "always" + "proseWrap": "preserve" } } ] diff --git a/README.md b/README.md index a8796088..90b196e6 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ workspaces with a single click. - Supports multiple editors: VS Code, Cursor, and Windsurf. > [!NOTE] -> The extension builds on VSCode provided implementations of SSH. Make sure you -> have the correct ssh extension installed for your editor +> The extension builds on VSCode provided implementations of SSH. Make +> sure you have the correct ssh extension installed for your editor > (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for windsurf) ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true) From a19aeea74a22badd5685cc7ed0ec8095633431f6 Mon Sep 17 00:00:00 2001 From: M Atif Ali Date: Tue, 1 Apr 2025 21:14:24 +0500 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Edward Angert --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 90b196e6..b6bd81dd 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ workspaces with a single click. - Supports multiple editors: VS Code, Cursor, and Windsurf. > [!NOTE] -> The extension builds on VSCode provided implementations of SSH. Make -> sure you have the correct ssh extension installed for your editor -> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for windsurf) +> The extension builds on VS Code-provided implementations of SSH. Make +> sure you have the correct SSH extension installed for your editor +> (`ms-vscode-remote.remote-ssh` or `codeium.windsurf-remote-openssh` for Windsurf). ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)