-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Export user preference settings to a json file #16896
Conversation
Thanks for making a pull request to jupyterlab! |
@jtpio @krassowski |
Thanks @Darshan808 for opening this PR, it looks promising! Also cc @bollwyvl who was commenting about this in previous issues, and may be interested. |
The current behavior of downloading the file looks good to me 👍 This gives more flexibility to the user as to what to do with this file. For example one could export an |
Yeah, there are a few places an overrides can go:
The other side of this would be Import Settings to accept an uploaded |
Are there any other places needing documentation for this? And are tests necessary for this ? |
A new Galata test would be great! We could check that clicking on the button triggers a download: https://playwright.dev/docs/downloads |
@jtpio |
Looks good @Darshan808, and CI is also passing, thanks! Maybe the test could check the downloaded |
Maybe we should use Download icon instead of Save icon in the toolbar, just to avoid user thinking that they need to click on the save icon to save settings? |
You're right. I've updated the icon accordingly. |
@Darshan808 I've sent an invite to the triage team so that you will be able to add the labels on PRs (and issues) :) |
Thank you so much for the invite! I'm super excited to contribute more and help out with the triage team! |
@krassowski |
Yes, that's good for issues. I think we don't have a guide on how to apply labels to PRs, but basically "feature" for big new features, "enhancement" for small improvements, "bug" for bug fixes, "maintenance" for things without user impact, "documentation" for docs updates (all others are handled by the auto-labeller). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Just tried with the latest changes and it works well 👍
Looks like we can get it in so it will be available in the first 4.4.0
pre-release. A follow-up could be look into importing settings from an overrides.json
, but this can be tracked in a separate issue.
* fix-format * commandlist-docs-update * settings-exporter-test-add * test-modification-to-match-content * icon-changed-from-save-to-download * fix-lint
References #16895
Overview
This pull request implements the functionality to export user preference settings from the JupyterLab Settings Editor to an
overrides.json
file.Changes Made
settingeditor:export
to handle the export action.overrides.json
file.Notes
This is not a complete PR. I want to discuss some things:
Snapshot
I'm also open to writing tests and updating docs after the feature is finalized.