Added VSCode settings and extensions backup/reinstall, pip3 backup. #205

AlexanderProd · 2018-12-22T10:28:50Z

This should fix #45 on macOS and Linux. I haven't tested it but it should work. 😄

alichtman

First, thank you for the PR. This would be a great feature to have.

I haven't tested it but it should work.

For your own software development knowledge, it's horribly bad practice to put anything untested on master. Knowing that bugs slip through even when code is tested (you've even found some yourself) should hammer home the importance of testing everything before it goes on master, even if it's just a "simple" 6 line change.

Regardless, on to the code review.

Your solution should work, functionally. It's kind of like what I did with Sublime, but that was a quick and dirty fix. I'm not happy with my solution, and I don't really want to back up other IDEs in the same manner. I don't see a reason to back up the caches or <INSERT NON-CONFIGURATION FILE HERE>. The end goal is to have a minimum set of files to recreate the user's configuration at the end of a reinstall.

It's not as simple as just backing up the parent VSCode folder and calling it a day. (Sorry for not being more specific in #45.) We really only want to back up a list of the extensions that were installed, their settings, and the VSCode settings. From that, we can likely reconstruct the VSCode installation exactly as the user had it.

One way to approach this could be: Generate a list of the installed extensions instead of backing up the whole folder, and see if there is a tool to reinstall them. (Or see if you can interface with VSCode itself to reinstall them?) This should go in the packages backup section. Separately, we want to back up the VSCode settings and keymappings. Those can be found here: /Users/alichtman/Library/Application Support/Code/User/{settings.json | keymap.json}. From what I can tell, everything else in the Code directory is essentially trash.

Does this make sense?

alichtman · 2018-12-22T12:05:58Z

shallow_backup/config.py

@@ -47,7 +47,8 @@ def get_default_config():
 		],
 		"dotfolders"       : [
 			".ssh",
-			".vim"
+			".vim",
+			".vscode"


This folder doesn't actually hold any configuration files and doesn't really belong in this section, imo.

On my machine, it stores the downloaded extensions, and I'm not sure we should be backing up the actual source code for the extensions when we should be able to reinstall them.

See comment on PR for more details.

Note: I'm not thrilled with the Sublime backup solution I have at the moment. It backs up a ton of dead weight, and I don't want to establish that as the status quo. The initial goal of this project was to compress the backup size as much as possible. We should only back up the settings and extensions for VSCode / Sublime / Atom / etc.

AlexanderProd · 2018-12-22T13:09:44Z

Yeah you're totally right that I've tested it before submitting but my local Python environment isn't working and I given the small changes I wanted to put out the PR still. Yeah my bad. I've actually just replicated the backup process how you did it wit Sublime Text not knowing that this was just a quick and dirty fix that you didn't want to use anymore.

But I understand that you only want to backup as little as possible. I know there's a VSCode Extension out there that does practically the same, we can look how they did the extension backup and built it in similarly.

alichtman · 2018-12-22T14:56:13Z

my local Python environment isn't working

I've had these issues before. I understand your pain. :(

That VSCode Backup extension will definitely be helpful when putting this feature together. I glanced at it and noticed it was written in TypeScript. I'm hesitant to add it as a pseudo-dependency (installing it from within shallow-backup and using it from there), although that's definitely the least work. I'd much rather implement the functionality natively to minimize external dependencies and keep everything together in one package.

I'd look at how it creates the backup (both in terms of which files are important and how the backup is structured) and how they reinstallation process works. After you get a sense for that, we can talk about how it best fits into shallow-backup, or you can just give implementing it a shot and we'll go from there.

alichtman · 2019-01-01T19:55:31Z

@AlexanderProd any update on this PR?

AlexanderProd · 2019-01-02T14:19:52Z

Sorry, didn’t have time for it yet.

AlexanderProd · 2019-01-05T09:47:58Z

@alichtman Do I have to create a completely new backup when I added new paths in compatibility.py? Because I wanted to test my local changes but the new config paths weren't included in the backup.

Also I've noticed that Atom packages are still being backuped completely not just a reference to them, is this wanted behavior or subject to change?

alichtman · 2019-01-05T10:02:11Z

Do I have to create a completely new backup when I added new paths in compatibility.py?

No, just the config file needs to be updated.

Also I've noticed that Atom packages are still being backuped completely not just a reference to them, is this wanted behavior or subject to change?

This is not the wanted behavior. We just want package settings and general settings. I'll open an issue to make sure this isn't missed. (#210)

AlexanderProd · 2019-01-05T10:09:05Z

@alichtman

This is not the wanted behavior. We just want package settings and general settings.

I guess the only thing missing is settings of individual packages, since we're already creating a list of all atom packages right?

EDIT: got it working.

AlexanderProd · 2019-01-05T12:16:11Z

This PR contains VSCode config backup, Extensions aren't being backuped.
Also because only the required configs are being backuped the code for the paths got a little bit ugly.

vscode_path_1 = os.path.join(get_home(), "Library/Application Support/Code/User/settings.json")
vscode_path_2 = os.path.join(get_home(), "Library/Application Support/Code/User/Snippets")
vscode_path_3 = os.path.join(get_home(), "Library/Application Support/Code/User/keybindings.json")

If we want to backup extensions settings we probably have to backup the whole extensions folder since every extensions handles settings differently.

alichtman · 2019-01-05T18:51:53Z

I'll do a code review on this later tonight and see if we can get it in soon!

shallow_backup/compatibility.py

alichtman · 2019-01-05T20:38:15Z

Let's make the vscode backup all within a directory in the configs folder. I'm not a huge fan of leaving it like this:

It should look like this:

Additionally, some thought should be given about how to reinstall these. Do we want to throw that functionality into this PR?

AlexanderProd · 2019-01-05T21:10:46Z

Yeah a separate folder seems like a good idea and yeah I‘d make a separate PR for restoring the backup.

alichtman · 2019-01-05T21:25:10Z

I‘d make a separate PR for restoring the backup.

Sounds good. Let's open an issue to make sure it doesn't get lost in the mix.

shallow_backup/compatibility.py

AlexanderProd · 2019-01-05T22:04:49Z

Configs are now saved into a dedicated folder.

alichtman · 2019-01-05T22:05:08Z

It worked without having to create it explicitly? Awesome.

Same changes need to be made to the macOS configs.

AlexanderProd · 2019-01-05T22:07:00Z

Yeah tested on MacOS and it worked, can't test in on Linux but I assume it would work as well.

alichtman · 2019-01-05T22:13:42Z

Just tested. ~~Approved.~~

Note: This does not backup the extensions, and it should. Let's sort that out before I merge this in.

Nice work, @AlexanderProd

alichtman

We need to back up extensions as well.

AlexanderProd · 2019-01-05T22:31:54Z

I didn’t include extensions yet because they’re a bit tricky. If we only save a list of extensions we won’t get eventual extension settings. We probably had to backup the whole extension folder since there’s no uniform way extensions handle configs.

AlexanderProd · 2019-01-06T09:12:07Z

I've added simple list style backup for VSCode extensions.
It creates a .txt file inside of the packages folder that looks like this.

dbaeumer.vscode-eslint@1.7.2
file-icons.file-icons@1.0.16
icrawl.discord-vscode@3.2.1
kodetech.electron-debug@18.11.0
ms-python.python@2018.12.1
ms-vscode.atom-keybindings@3.0.4
msjsdiag.debugger-for-chrome@4.11.1
robinbentley.sass-indented@1.5.1
Shan.code-settings-sync@3.2.4
vsmobile.vscode-react-native@0.7.0
zhuangtongfa.Material-theme@2.18.1

I've also quickly included the pip3 fix. #211

shallow_backup/config.py

alichtman

Can we automate vscode reinstallation? That's the last thing I want to explore.

EDIT: Yes, we can. Run through the list of extensions saved and run code --install-extension <extension_id>. Should be pretty easy to implement.

Everything else looks good here (although we do lose VSCode Extension settings, but we can open a separate issue for that if you don't want to figure that out in this PR.)

AlexanderProd · 2019-01-07T09:31:25Z

VScode Extensions reinstallation is working now.

alichtman · 2019-01-07T18:46:01Z

Awesome. Looks good to me. Will merge next time I'm on a laptop.

AlexanderProd added 4 commits December 14, 2018 14:53

#200 added gitpython to setup.py

8d087b2

Merge branch 'master' of https://github.com/alichtman/shallow-backup

673b3a3

added ~./vscode folder for vscode extensions

b08c6c7

added vscode settings backup

34996d7

alichtman requested changes Dec 22, 2018

View reviewed changes

AlexanderProd added 2 commits January 5, 2019 13:10

Merge branch 'master' of https://github.com/alichtman/shallow-backup

cb37095

added vscode settings backup

0cbf207

AlexanderProd added 3 commits January 5, 2019 13:33

removed sync_local_settings from beeing backuped

ca4aa4d

removed .vscode folder from backup

cdd837c

removed .vscode folder from backup

9a2786f

alichtman reviewed Jan 5, 2019

View reviewed changes

shallow_backup/compatibility.py Outdated Show resolved Hide resolved

alichtman mentioned this pull request Jan 5, 2019

Reinstall VSCode backup #212

Closed

AlexanderProd and others added 3 commits January 5, 2019 22:47

Update compatibility.py

ef49f49

fixed indent

514b56e

fixed indent in compatibility.py

d7cb57e

alichtman reviewed Jan 5, 2019

View reviewed changes

shallow_backup/compatibility.py Outdated Show resolved Hide resolved

vscode configs are saved to dedicated folder

eea5012

vscode configs are saved to dedicated folder

99f9e94

alichtman approved these changes Jan 5, 2019

View reviewed changes

alichtman requested changes Jan 5, 2019

View reviewed changes

AlexanderProd added 4 commits January 6, 2019 09:26

added pip3 backup

b5242c2

added vscode extensions backup

af0532d

updated README for VSCode and pip3

049f273

removed trailing whitespace in backup.py

470577e

Repository owner deleted a comment Jan 6, 2019

added .DS_Store to gitignore

b5397bc

AlexanderProd mentioned this pull request Jan 6, 2019

Backup pip3 packages #211

Closed

added pip3 reinstall

ff83611

alichtman reviewed Jan 7, 2019

View reviewed changes

shallow_backup/config.py Show resolved Hide resolved

alichtman requested changes Jan 7, 2019

View reviewed changes

AlexanderProd added 2 commits January 7, 2019 10:29

changed vscode extensions file name

97b65f0

added vscode extensions restore

e799aed

Repository owner deleted a comment Jan 7, 2019

AlexanderProd mentioned this pull request Jan 7, 2019

Backup VSCode extension settings. #214

Open

alichtman changed the title ~~Added VSCode settings and extension backup.~~ Added VSCode settings and extensions backup/reinstall, pip3 backup. Jan 7, 2019

alichtman merged commit b907c83 into alichtman:master Jan 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added VSCode settings and extensions backup/reinstall, pip3 backup. #205

Added VSCode settings and extensions backup/reinstall, pip3 backup. #205

AlexanderProd commented Dec 22, 2018

alichtman left a comment •

edited

alichtman Dec 22, 2018

AlexanderProd commented Dec 22, 2018 •

edited

alichtman commented Dec 22, 2018 •

edited

alichtman commented Jan 1, 2019

AlexanderProd commented Jan 2, 2019 via email •

edited

AlexanderProd commented Jan 5, 2019 •

edited

alichtman commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019 •

edited

alichtman commented Jan 5, 2019

alichtman commented Jan 5, 2019

AlexanderProd commented Jan 5, 2019 via email

alichtman commented Jan 5, 2019

AlexanderProd commented Jan 5, 2019

alichtman commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019

alichtman commented Jan 5, 2019 •

edited

alichtman left a comment

AlexanderProd commented Jan 5, 2019 via email •

edited

AlexanderProd commented Jan 6, 2019 •

edited

alichtman left a comment •

edited

AlexanderProd commented Jan 7, 2019

alichtman commented Jan 7, 2019

Added VSCode settings and extensions backup/reinstall, pip3 backup. #205

Added VSCode settings and extensions backup/reinstall, pip3 backup. #205

Conversation

AlexanderProd commented Dec 22, 2018

alichtman left a comment • edited

Choose a reason for hiding this comment

alichtman Dec 22, 2018

Choose a reason for hiding this comment

AlexanderProd commented Dec 22, 2018 • edited

alichtman commented Dec 22, 2018 • edited

alichtman commented Jan 1, 2019

AlexanderProd commented Jan 2, 2019 via email • edited

AlexanderProd commented Jan 5, 2019 • edited

alichtman commented Jan 5, 2019 • edited

AlexanderProd commented Jan 5, 2019 • edited

AlexanderProd commented Jan 5, 2019 • edited

alichtman commented Jan 5, 2019

alichtman commented Jan 5, 2019

AlexanderProd commented Jan 5, 2019 via email

alichtman commented Jan 5, 2019

AlexanderProd commented Jan 5, 2019

alichtman commented Jan 5, 2019 • edited

AlexanderProd commented Jan 5, 2019

alichtman commented Jan 5, 2019 • edited

alichtman left a comment

Choose a reason for hiding this comment

AlexanderProd commented Jan 5, 2019 via email • edited

AlexanderProd commented Jan 6, 2019 • edited

alichtman left a comment • edited

Choose a reason for hiding this comment

AlexanderProd commented Jan 7, 2019

alichtman commented Jan 7, 2019

alichtman left a comment •

edited

AlexanderProd commented Dec 22, 2018 •

edited

alichtman commented Dec 22, 2018 •

edited

AlexanderProd commented Jan 2, 2019 via email •

edited

AlexanderProd commented Jan 5, 2019 •

edited

alichtman commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019 •

edited

alichtman commented Jan 5, 2019 •

edited

alichtman commented Jan 5, 2019 •

edited

AlexanderProd commented Jan 5, 2019 via email •

edited

AlexanderProd commented Jan 6, 2019 •

edited

alichtman left a comment •

edited