Polyman NPM | npm.io

Polyman

Run a polyrepo like a monorepo

WARNING

This is an early proof of concept with BASIC functionality. Do not use this package except to play around.

Install

Polyman depends on yarn v1.x. If yarn is not installed: npm install -g yarn

yarn global add polyman

Description

Polyman is a polyrepo dependency management system that allows you to use multiple git repositories instead of combining all packages into a monorepo.

Why?

Monorepos are great in concept, but a hassle in practice. Git is not designed to share build, test, and deploy across multiple semi-independent packages atomically. Hacks exist to stop git from running tests that are unneccessary, to only clone parts of the monorepo, etc.

However, polyrepos can be unwieldy. Code is spread across multiple systems, linking between packages during local development is a nightmare, there's no "source of truth" that knows which packages are part of an organization/project and which are not. Where polyrepos excel: atomiticity and efficient deploy.

Polyman is the best of both worlds, allowing git's design to handle deployment independently while dependencies across repositories.

Setup

Create a directory you want to use as the root of your polyrepo.

mkdir my-polyrepo

Create a file repository.poly and add the following:

{
  "name": "my-polyrepo",
  "projects": {}
}

Usage

Polyman is a wrapper around yarn. Everytime you would call yarn, call poly

Init a new polyman project

poly init creates a new polyman project in the given directory.

mkdir my-project
cd my-project
poly init

Polyman will prompt choices about project setup. For now, polyman only supports Javascript projects.

Note: Polyman automatically inits a git repository and adds dependencies to enforce Conventional Commits. TODO: Options around this.

poly install (--production)

Calls yarn install (with --prodction if flag given).

poly add dependency(ies)...

Adds dependencies to the current project.

poly remove dependency(ies)...

Removes dependencies.

poly local add/remove

Adds/removes a project in this polyrepo as a dependency of the current project. If the project is locally available, it will be added as a file: dependency and yarn will symlink. If the project is not locally available, polyman will fallback to the git_repository url (TODO: this doesn't work yet). Dependency added scoped as @/.

Options: --dev add as dev dependency --build add as build dependency. Build dependencies tell polyman to execute relink/build during bootstrap BEFORE relink/build of the bootstrapping project so the bootstrapping project can build correctly. DO NOT ADD THE PROJECT AS A BUILD DEPENDENCY IF THE PROJECT IS ALREADY A REGULAR DEPENDENCY.

poly build

Calls the build command if the directory has new content and packs the project into a tarball at .poly/build/ for export and a different tarball at the repository level that is used by polyman for local linking.

poly bootstrap

Runs through every local polyman project and relinks/builds all local project dependencies.

poly relink

Relinks all local dependiencies without attempting to build each local project.

poly clone

Clones a non-local project of the repository into a local folder. Does not updated local projects to reference the new local project.

poly node cmd...

Executes node in the environment of your app. If config.poly includes "babel": true, the command will be executed with babel-node. This works for debugging as well.