From c24b4aa31092d342a8e6e7779cb6cbb79b1df142 Mon Sep 17 00:00:00 2001 From: Ankur Oberoi Date: Fri, 8 Dec 2023 14:17:01 -0800 Subject: [PATCH 1/3] Clearer instructions for using VSCode, minor setting cleanup. * Moves workspace settings into .vscode directory, as is recommended for single root workspaces. * Removes dead setting * Updates recommended extension for a more helpful recommendation. * Adds detail to the README for placing the web client static files in the build output directory. --- .vscode/extensions.json | 2 +- .vscode/settings.json | 8 ++++++++ README.md | 10 +++++++--- jellyfin.code-workspace | 17 ----------------- 4 files changed, 16 insertions(+), 21 deletions(-) create mode 100644 .vscode/settings.json delete mode 100644 jellyfin.code-workspace diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 59d9452fed..bce772c180 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -4,7 +4,7 @@ // List of extensions which should be recommended for users of this workspace. "recommendations": [ - "ms-dotnettools.csharp", + "ms-dotnettools.csdevkit", "editorconfig.editorconfig" ], // List of extensions recommended by VS Code that should not be recommended for users of this workspace. diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000000..dfdcfa8807 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "files.eol": "\n", + "editor.renderWhitespace": "boundary", + "files.exclude": { + "*/jellyfin-web": true, + "**/obj": true + } +} diff --git a/README.md b/README.md index 15dd0ae679..8d53d5078d 100644 --- a/README.md +++ b/README.md @@ -116,11 +116,15 @@ To run the project with Visual Studio you can open the Solution (`.sln`) file an #### Running With Visual Studio Code -To run the project with Visual Studio Code you will first need to open the repository directory with Visual Studio Code using the `Open Folder...` option. +In Visual Studio Code, open the workspace by choosing `File` > `Open Folder...` and selecting the repository directory. -Second, you need to [install the recommended extensions for the workspace](https://code.visualstudio.com/docs/editor/extension-gallery#_recommended-extensions). Note that extension recommendations are classified as either "Workspace Recommendations" or "Other Recommendations", but only the "Workspace Recommendations" are required. +Next, [install the recommended extensions for the workspace](https://code.visualstudio.com/docs/editor/extension-gallery#_recommended-extensions). When you first open the workspace, Visual Studio Code may prompt you to install recommended extensions. Another way to find these is to navigate to `View` > `Extensions`, and then type `@recommended` in the filter. Note that extension recommendations are classified as either "Workspace Recommendations" or "Other Recommendations", but only the "Workspace Recommendations" are required. If you don't already have the [.NET SDK](https://dotnet.microsoft.com/en-us/download) installed, the extension setup will guide you through installing it. -After the required extensions are installed, you can run the server by pressing `F5`. +Build the project by choosing `Terminal` > `Run Build Task...`. The integrated terminal will appear and show the progress of the build. After it completes, press any key to close the terminal. + +Place the [web client static files](#installing-the-web-client) into the build output directory. The initial build will have created a directory in the repository at path `Jellyfin.Server/bin/Debug/net8.0` (or similar, based on your SDK version). Place the web client static files in a subdirectory called `jellyfin-web`. + +Run the server for debugging by pressing `F5`. #### Running From The Command Line diff --git a/jellyfin.code-workspace b/jellyfin.code-workspace deleted file mode 100644 index 7882b38219..0000000000 --- a/jellyfin.code-workspace +++ /dev/null @@ -1,17 +0,0 @@ -{ - "folders": [ - { - "path": "." - } - ], - "settings": { - "files.eol": "\n", - "editor.renderWhitespace": "boundary", - "files.exclude": { - "**/bin": true, - "**/jellyfin-web": true, - "**/obj": true - }, - "formatFiles.excludePattern": "**/node_modules,**/.vscode,**/dist/**,**/.chrome,ThirdParty,RSSDP,Mono.Nat,unRaid,debian" - } -} From 32bcd1b0577f4a6ece62f6bd291269118fbff1fc Mon Sep 17 00:00:00 2001 From: Ankur Oberoi Date: Mon, 18 Dec 2023 17:29:27 -0800 Subject: [PATCH 2/3] Mention --webdir option for locating web client static files. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d53d5078d..6cd8c6bedf 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ Next, [install the recommended extensions for the workspace](https://code.visual Build the project by choosing `Terminal` > `Run Build Task...`. The integrated terminal will appear and show the progress of the build. After it completes, press any key to close the terminal. -Place the [web client static files](#installing-the-web-client) into the build output directory. The initial build will have created a directory in the repository at path `Jellyfin.Server/bin/Debug/net8.0` (or similar, based on your SDK version). Place the web client static files in a subdirectory called `jellyfin-web`. +Lastly, you need to reference the [web client static files](#installing-the-web-client). The initial build will have created a directory in the repository at path `Jellyfin.Server/bin/Debug/net8.0` (or similar, based on your SDK version). You may place the web client static files in a subdirectory called `jellyfin-web`. Another option that you might prefer if you might need to clean your build directory often is to update the `.vscode/launch.json` config to add an argument in the `"args"` array that specifies where the web client static files can be found, i.e. `"--webdir some/path/to/webui"`. Run the server for debugging by pressing `F5`. From fd93b7019d305b916f2118a569e01a3370efe49a Mon Sep 17 00:00:00 2001 From: Ankur Oberoi Date: Mon, 18 Dec 2023 17:31:32 -0800 Subject: [PATCH 3/3] Small grammar/usage change. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cd8c6bedf..172071d427 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ Next, [install the recommended extensions for the workspace](https://code.visual Build the project by choosing `Terminal` > `Run Build Task...`. The integrated terminal will appear and show the progress of the build. After it completes, press any key to close the terminal. -Lastly, you need to reference the [web client static files](#installing-the-web-client). The initial build will have created a directory in the repository at path `Jellyfin.Server/bin/Debug/net8.0` (or similar, based on your SDK version). You may place the web client static files in a subdirectory called `jellyfin-web`. Another option that you might prefer if you might need to clean your build directory often is to update the `.vscode/launch.json` config to add an argument in the `"args"` array that specifies where the web client static files can be found, i.e. `"--webdir some/path/to/webui"`. +Lastly, you need to reference the [web client static files](#installing-the-web-client). The initial build will have created a directory in the repository at path `Jellyfin.Server/bin/Debug/net8.0` (or similar, based on your SDK version). You may place the web client static files in a subdirectory called `jellyfin-web`. Another option that you might prefer if you need to clean your build directory often is to update the `.vscode/launch.json` config to add an argument in the `"args"` array that specifies where the web client static files can be found, i.e. `"--webdir some/path/to/webui"`. Run the server for debugging by pressing `F5`.