VSCode is an extensible editor with great customization and flexibility. However, this can cause issues when the editor falls into a corrupted state due to extension modifications, user settings, or even version upgrades.
This repo provides a VSCode imager that will make an image of your VSCode settings so that you can always restore back to a previous working state.
It is recommended that you first setup VSCode to be working prior to using this imager. Once you image your working VSCode state, you can use the image to restore it back to this working state in the future.
Requires python >=3.10.
pip install poetry # install poetry if you don't have it
poetry install # regular install
poetry install --with=dev # development install
poetry update # update existing modules to latestThe Command Line Interface (CLI) can be access via:
python src/main.py -hTo create a new image simply type:
python src/main.py create-image # will create a new image tagged by month/day/yearTo restore your VsCode image simply type:
python src/main.py restore-image <image_path> # will restore an image tagged by pathSeveral CI tools have been included with this codex:
- coverage: provides code coverage analysis
- pdoc: automatic documentation software
- scalene: profiler for evaluating performance
The noxfile.py provides an example of how to run each of these. The src/ci folder contains common CI modules. For an explaination on how to properly setup multiple versions of Python to run with Nox see here.
Documentation of the code is provided via pdoc which hosts a website and provides a search engine. To display the website:
nox -r -s autodocYou cannot have VSCode open when attempting to create an image because there are certain files that the program opens and locks. If VSCode is open while using this imager you will likely see an error that states:
"[Errno 102] Operation not supported on socket: '.../Library/Application Support/Code/1.84-main.sock'"
The recommended way to use this CLI is through a terminal.