wlink

0.1.1 • Public • Published
wlink logo

Tangible symlinks Wlink is based on wml project which is not maintained. Wlink listens to changes in some folder (using Watchman) and copies changed files into another folder.

Why?

Let's face it, sometimes symbolic links just aren't enough. Github has more than 10K issues with the words "support for symlinks" in them.

Two examples I've encountered so far were: React Native's packager lack of support for them and Webpack's inability to find linked modules dependencies (working around this has issues of its own). A lot of people resolve to working directly from the node_modules folder in these cases, but a. if your package is required by two projects on which you are working simultaneously, you're screwed, and b. it just feels wrong.

Wlink makes use of Facebook's ultra-fast Watchman to watch for changes in your source folder and copy them (and only them) into your destination folder.

Wlink is a CLI tool that works pretty much like ln -s. You first set up your links by using the wlink add command and then run the wlink service (wlink start) to start listening. That's it!

Note that since Wlink is based on Watchman it does not support symlinks. lol.

Install

npm install -g wlink

or

npm global add wlink

Usage

# add the link to wlink using `wlink add <src> <dest>` 
wlink add ~/my-package ~/main-project/node_modules/my-package
# start watching all links added 
wlink start

Commands

add

wlink add <src> <dest> (or wlink a)

Adds a link.

wlink will not start listening to changes until you start it by running wlink start.

Each link is given an unique id, you can see all links and their ids by running wlink list. Links are saved to src/links.json in your wlink install directory, meaning that your configuration is specific to that wlink install.

rm

wlink rm <linkId>

Removes a link. Passing all as linkId removes all links.

start

wlink start (or wlink s)

Starts wlink.

It first copies all watched files from source to destination folder and then waits for new changes to happen.

list

wlink list (or wlink ls)

Lists all links.

Shows each link's id, state and source/destination folders.

enable

wlink enable [linkId] (or wlink en)

Enables a link. Passing all as linkId enables all links.

If you don't specify a linkId wlink will open in interactive mode.

disable

wlink disable [linkId] (or wlink d)

Disables a link. Passing all as linkId disabled all links.

If you don't specify a linkId wlink will open in interactive mode.

Great for re-using old links without having to type them over and over again.

Miscellaneous

Ignored folders

When adding a new link Wlink will try to detect if your source folder is a git repository or an npm package, it will then offer to ignore the ".git" and "node_modules" folders for you.

If you want to add more folders to your ignored folders first create a file named .watchmanconfig in your source folder, this file should contain Watchman's configuration for this folder. See example below to learn how populate it or check out the Watchman docs to learn more about Watchman configurations.

In the following example we are ignoring the ".git" and "node_modules" folders:

{
    "ignore_dirs": [
        ".git",
        "node_modules"
    ]
}

Contributing

See the Contributing page.

License

Copyright (c) 2016 Wix. Licensed under the MIT license.

Readme

Keywords

none

Package Sidebar

Install

npm i wlink

Weekly Downloads

0

Version

0.1.1

License

MIT

Unpacked Size

50.5 kB

Total Files

26

Last publish

Collaborators

  • najeal