JS: Move the binderhub API client to its own npm package #1689
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Many projects want / need to connect to the BinderHub API: - [thebe](https://thebe.readthedocs.io) - [prototype UI for connecting to a private binderhub from profile_list](https://github.com/yuvipanda/prototype-kubespawner-dynamic-building-ui) These all need to recreate a JS client interface to the BinderHub API. This PR splits out the *existing* client API we have in the BinderHub JS codebase into its own package, and refers to that from the existing codebase. This has several advantages: - Multiple projects can re-use this client code easily, without having to copy-paste. - Separation of concerns allows us to eventually do wonderful things like **add unit tests** for the JS code. - By using the npm [workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces?v=true) feature, extra complexity overhead is very minimal. Note how small this PR actually is. As added incentive, I've added doc strings for the methods in `BinderImage`. I will work on refactoring the JS code in there as well, but as a separate PR.
4 tasks
|
#1373 is related, and in some ways I guess it's me picking up the work I was doing there :) |
manics
approved these changes
May 3, 2023
consideRatio
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
May 3, 2023
jupyterhub/binderhub#1689 Merge pull request #1689 from yuvipanda/split-image
|
AAAAND published! https://www.npmjs.com/package/@jupyterhub/binderhub-client |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many projects want / need to connect to the BinderHub API:
These all need to recreate a JS client interface to the BinderHub API.
This PR splits out the existing client API we have in the BinderHub JS codebase into its own package, and refers to that from the existing codebase. This has several advantages:
As added incentive, I've added doc strings for the methods in
BinderImage. I will work on refactoring the JS code in there as well, but as a separate PR.