mirror of
https://github.com/jellyfin/jellyfin.git
synced 2026-05-04 18:09:12 +03:00
VSCode tasks.json ease of use additions #6156
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @ItsAllAboutTheCode on GitHub (Jul 28, 2024).
For development purposes, I have a suggestion of updating the VSCode tasks.json file to have a task that can generate an updated
openapi.jsonthat can be used by developers with to generate an updated typescript API using the jellyfin-sdk-typescript repo.Currently there is not many documented steps for how a contributor can make an openapi change in the
jellyfinserver repo and then use that change in thejellyfin-webrepo without first waiting an update to the jellyfin SDK package and then an update to thejellyfin-webpackage.json to use that updated package.Looking through the three repos of
jellyfin,jellyfin-sdk-typescriptandjellyfin-webI found that the process involvesJellyfin.Server.Integration.Teststest from thejellyfinserver repoopenapi.jsonthat the test outputs in the<jellyfin-server-repo-folder>//tests/Jellyfin.Server.Integration.Tests/bin/Release/net8.0/to the<jellyfin-sdk-typescript-repo-folder>jellyfin-sdk-typescriptrepo to update the generated client code, thebuild:generated-clientandbuild:sdktask need to run using npm or yarn.npm packoryarn packcommand.jellyfin-webrepo root the package.json needs to be updated to use the locally built package using thenpm install --save <path-to-local-jellyfin-sdk-pkg>oryarn add file:<path-to-local-jellyfin-sdk-pkg>.At this point the local
jellyfin-webclient project can now run against the localjellyfinserver project openapi modifications.To make it easier for VS Code users to go through this process, I propose adding an
openapi-generationcommand that can perform steps 1 and 2 above to generate anopenapi.jsonfile using the current code and to copy it to a developer's localjellyfin-sdk-typescriptrepo.Below is a video showing how the task would run in VS Code
https://github.com/user-attachments/assets/d801f6b2-fd1a-4b1c-8b46-8602278cd0b7
@jellyfin-bot commented on GitHub (Nov 25, 2024):
This issue has gone 120 days without an update and will be closed within 21 days if there is no new activity. To prevent this issue from being closed, please confirm the issue has not already been fixed by providing updated examples or logs.
If you have any questions you can use one of several ways to contact us.
@ItsAllAboutTheCode commented on GitHub (Nov 25, 2024):
The fix for this issue is up for PR in #12348
@jellyfin-bot commented on GitHub (Mar 26, 2025):
This issue has gone 120 days without an update and will be closed within 21 days if there is no new activity. To prevent this issue from being closed, please confirm the issue has not already been fixed by providing updated examples or logs.
If you have any questions you can use one of several ways to contact us.
@jellyfin-bot commented on GitHub (Jul 25, 2025):
This issue has gone 120 days without an update and will be closed within 21 days if there is no new activity. To prevent this issue from being closed, please confirm the issue has not already been fixed by providing updated examples or logs.
If you have any questions you can use one of several ways to contact us.
@jellyfin-bot commented on GitHub (Aug 16, 2025):
This issue was closed due to inactivity.