A utility for synchronization multiple packages, without any symlinks and any changes in source projects(package.json, etc.).
It is a simple application to watching and copying files from project to another project using CLI.
npm install -g @piotar/pkg-syncIn some cases, we can not use symbolic links for dependencies. The solution is to copy build files to our project and test it locally.
We have a main project (App) and 2 dependencies (Ui and Store) with difference locations (this is not monorepository).
~
├── projects
│ └── App
│ ├── node_modules
│ ├── package.json
│ └── etc...
└── external
├── Ui
│ ├── node_modules
│ ├── package.json
│ └── etc...
└── Store
├── node_modules
├── package.json
└── etc...
First of all, we need to add dependencies to pkg-sync.
- Go to directories
~/external/Uiand~/external/Store. - Run command
pkg-sync add .with each directory. - Go to
~/projects/Appdirectory. - Run command
pkg-sync sync .. This will copy dependency files and start watching for changes.
That's it... Points 1-2 are only necessary for the first run.
Usage: pkg-sync add [options] [path]
Add package to sync
Arguments:
path Path to package (path not set will be set to closest package.json)
Options:
-n, --name <package> Package name (override name from package.json)
-f, --force Override package
-d, --dir [dirs...] Directory to watch (override default values)
-h, --help display help for command
Usage: pkg-sync remove|rm [options] [packages...]
Remove package from sync
Arguments:
packages Package name (name set as "." will be set from closest package.json)
Options:
-i, --interactive Interactive mode (default: false)
-a, --all Remove all stored packages (default: false)
-h, --help display help for command
Usage: pkg-sync list|ls [options]
Show all stored packages
Options:
-h, --help display help for command
Usage: pkg-sync validate [options] [path]
Show coverage packages from project
Arguments:
path Path to package (path not set will be set to closest package.json)
Options:
-d, --depth [number] Deep search of dependencies (default: 2, preset: 2)
-h, --help display help for command
Usage: pkg-sync sync [options] [path] [packages...]
Sync and watch packages in project
Arguments:
path Path to package (path not set will be set to closest package.json)
packages Package name to sync
Options:
--no-watch Disable watch files after sync
-i, --interactive Interactive mode (default: false)
-d, --depth [number] Deep search of dependencies (default: 2, preset: 2)
-h, --help display help for command
Usage: pkg-sync update-check [options]
Check version of 'pkg-sync'
Options:
-h, --help display help for command
Usage: pkg-sync config [options] [command]
Config
Options:
-h, --help display help for command
Commands:
set <key> <value> Set config
get [key] Get config
restore Restore config to default
help [command] display help for command