Need to see if your shared folder is taking up space on your dropbox 👨‍💻? Find out how to check here.

Forum Discussion

sebastian_'s avatar
sebastian_
Collaborator | Level 8
6 years ago
Solved

How to make Dropbox ignore node_modules folder with symbolic links (aliases)

PROBLEM
 
Dropbox does not currently provide an ignore file/folder feature that enables a locally-unique instance to exist on each machine. One important use of this is the “node_moduels" folder used for node javascript development. The node_modules folder sees thousands of file changes during the development cycle. If this folder is allowed to sync, the important files you need (outside of it), are so far down in the sync queue that you never have the important files when you need them on your other systems.
 
SOLUTION
 
A better way to sync projects with Dropbox while ignoring the node_modules folder is to use a “properly” formed symlink (alias). At this time npm and yarn support a property formed symlink. HOWEVER, IT IS CRITICAL THAT THE LINK (ALIAS) AND TARGET HAVE THE SAME NAME!
 
From shell prompt (terminal):
 
  1. cd YOUR_PROJECT_NAME
  2. mkdir -p ~/Downloads/node_modules_for_YOUR_PROJECT_NAME
  3. mv node_modules ~/Downloads/node_modules_for_YOUR_PROJECT_NAME
  4. ln -s ~/Downloads/node_modules_for_YOUR_PROJECT_NAME/node_modules

 

Now create the same target node_moduels folder on each of your other systems **AFTER** Dropbox syncs the ENTIRE project direcotry. The old node_modules folder should be removed and the symlink (alias) added before running these steps.

 
  1. cd YOUR_PROJECT_NAME
  2. mkdir -p ~/Downloads/node_modules_for_YOUR_PROJECT_NAME/node_modules
  3. yarn install
 
 
SUCCESS
 
Dropbox WILL sync the symlink/alias file itself, but NOT the contents it points to. This seems to work well for file syncing across several of your own development systems, and then use git to push to the repo for others on the team.
 
CAVEAT
 
The tiny symlink (alias) file itself IS sync’d on all systems, but will point to a non-existent / empty folder on the other systems. This is most applicable for a single user, but can also be useful for teams if an individual variant of the ignored data is appropriate, such as for node_moduels.
 
Hope this helps.
 

🙂

..sebastian

  • sebastian_'s avatar
    sebastian_
    6 years ago

    NOTE: The Initial Post on this thread IS the Solution. While the technique specifically targets the node_modules folder in Javascript / TypeScript projects, it can also be applied to any "folders" that need to be ignored (see bottom of this post for a drag-n-drop technique).

     

    HOW IT WORKS

    Because Dropbox does not synchronize folders referened by symlinks (aliases), you can move those folders into a NON-DROPBOX path (outside of dropbox), then create a symlink (alias) in the original Dropbox location.

    RESULT

    The ignored folder in Dropbox looks and behaves as normal folder, but in reality the data lives in a non-synchronized location on the storage device.

    HOW TO IGNORE ANY FOLDER (THE DRAG-N-DROP WAY)

    1. Move the folder to ignore "Outside of Dropbox" into another location (e.g. ~/Documents)
    2. In Finder (Mac OS), Command+Option Drag the folder back into Dropbox to create an alias. The cursor should turn into a little curved arrow while dragging if you have the right keys pressed. Once dropped, an alias will be created in the original Dropbox location pointing to the moved folder.

    NOTE: Using symlinks/aliases on Windows and Linux should behave the same way, but I have not verified it. Also, I've updated the original post to state that the tiny symlink (alias) file itself "IS" copied to all systems, but not the content of the folder.

    ..sebastian

19 Replies

Replies have been turned off for this discussion
  • fernandorojo's avatar
    fernandorojo
    New member | Level 2
    6 years ago

    Any shot you could upload a video showing how you did this? Slightly hard to follow with your usage of the Downloads folder. Thanks!

  • devinrhode2's avatar
    devinrhode2
    New member | Level 2
    6 years ago

    Symlinks are probably the best general solution. For developers using Git, you have another option. If you are fanatic about creating great git history/commit log for your changes, then you should try using `git worktree add ../projectA-dupe` which will create a duplicate folder that's a sibling to your current git repo. It's actually another "working directory" in proper git terms. It's the same git repo, all the same branches, same stashes, all the git info is the same. Actually the .git dir for "projectA-dupe" basically just points to your original git repo's .git folder. The advantage here, the workflow, is to have your main working directory outside of dropbox entirely, and then add another "working directory" or "worktree" inside your dropbox folder, which will sync. Or, vice versa. You could have the main git repo be inside dropbox, but, setup an npm pre-install hook to fail installation if it sees "Dropbox" is in your current folder path. All developers are instructed to cd to the main git repo inside Dropbox, and then run `git worktree add ../../path/to/your/projectA`. Furthermore, you could have everyone keep their worktree inside dropbox, which means they could all collaborate without ever doing a git push/pull/fetch, by simply allowing dropbox to sync all the git objects. One developer could help another simply by cd'ing to their worktree inside of dropbox. They see the exact same thing, no need to stash changes, commit anything, etc. The symlink might as well be committed into the git repo, and point to a globally reliable path, like ~/universal_node_modules/projectA. Better than all that, probably use yarn v2, and inside .yarnrc.yml set cacheDirectory to be something like ~/Dropbox/.yarn-cache/projectA, so all worktree's can share the same cache. 

  • sp1thas's avatar
    sp1thas
    Helpful | Level 5
    5 years ago

    I've recently implemented dropboxignore which is a simple shell script which facilitates you to generate .dropboxignore files based on your file patterns or even based on existing .gitignore files and ignore matched files from dropbox. Hope to find it useful for your case. Any feedback is more than welcome. dropboxignore is currently available only for Mac OS and Linux.

  • Riderpaul's avatar
    Riderpaul
    New member | Level 2
    5 years ago

    This is just dumb. No system should ever back up node_modules. This makes me want to rethink my Dropbox subscription.

  • pdepedo's avatar
    pdepedo
    New member | Level 2
    5 years ago

    It's 2021 and Dropbox still has no ignore functionality. I'm wondering how difficult would that be, really. Just before you sync a folder, check for existence of a .dropboxignore file, and then make sure you don't sync the files listed there. Like, seriously. How long can this take to implement? A week? A month? What the f are you waiting for? 

  • rvvincelli's avatar
    rvvincelli
    New member | Level 2
    4 years ago

    Thank you so much! After so much time wasted fiddling with xattr andthe Dropbox selective sync!!

  • Josh W.14's avatar
    Josh W.14
    Helpful | Level 5
    4 years ago

    I've fought with dropbox syncing node_modules, .git/, etc for years hoping the team would release a fix. I set up sym links, fs watchers to auto-set the ignore attribute for new folders, etc. To get it all working I have to turn off sync on all my computers, delete node_modules from dropbox.com, re-add the folder on each computer, re-add the ignore attribute, then re-enable syncing. Same for .git repos. If I ever need to blow away node_modules, I run `rm -rf node_modules/*`, otherwise I've got to redo the entire process. I've always loved Dropbox and always recommend it to family & colleagues, but last week I ran out of patience because all the Dropbox node_modules thrashing was destroying my IDE. I killed Dropbox & installed mega.io. It lets you setup a global ignore list where I added node_modules, .git, .idea, etc. It just works. I'll still recommend Dropbox for family, but for tech friends Dropbox is a nightmare. 

  • Spl221's avatar
    Spl221
    New member | Level 2
    4 years ago

    I agree that if dropbox team does not support the users with must-have features for ages, I would rather cancel my subscription and use a better service. Could anyone recommend something that is aware about ignore patterns and has an UI for Linux/Windows machines?

About View, download, and export

Node avatar for View, download, and export
Need support with viewing, downloading, and exporting files and folders from your Dropbox account? Find help from the Dropbox Community.

The Dropbox Community team is active from Monday to Friday. We try to respond to you as soon as we can, usually within 2 hours.

If you need more help you can view your support options (expected response time for an email or ticket is 24 hours), or contact us on X, Facebook or Instagram.

For more info on available support options for your Dropbox plan, see this article.

If you found the answer to your question in this Community thread, please 'like' the post to say thanks and to let us know it was useful!