@typinghare/wander
v2.0.0
Published
A modern solution for addressing settings files conflict
Downloads
8
Maintainers
Readme
Wander
This script addresses conflicts related to IDE settings folders. When collaborating on a project, team members often use the same IDE (e.g., VSCode, PyCharm, IntelliJ IDEA) but have different configurations. To avoid conflicts, we typically add the IDE settings directories (such as .vscode
, .idea
, and so on) to .gitignore
. However, switching devices can result in losing these settings.
To resolve this issue, Wander provides a solution by allowing you to save your IDE settings in a dedicated directory within .wander/<git-email>
. This directory, known as the user directory, stores each developer's IDE settings separately based on their Git email. When switching devices, you can easily restore your IDE settings from your user directory, ensuring a seamless transition.
Install
Ensure that you have installed Node.js, then run the following command:
sudo npm install -g @typinghare/wander
Check if Wander is installed successfully:
wander --version
Usage
# Display users and saved files/directories
wander list
# Save the target file/directory to Wander storage
wander save <target1> [<target2> ...]
# Restore the target file/directory from Wander storage
wander restore [<target1> <target2> ...]
# Note that if you do not specify target files to restore, Wander will restore all saved files to target files
wander restore
The following is a typical example:
# Save the .idea to the Wander storage
# It is saved to .wander/<you-git-email>/.idea.svd
# Where the extension ".svd" stands for "saved"
wander save .idea
# Restore the .idea files (and other saved files)
wander restore
# If you saved other files and you just want to restore .idea, run
wander restore .idea