js

An exploration of using a monorepo for developing a collection of (at most loosely) related NPM packages.

This is an experiment aimed at exploring the trade-offs involved in moving a bunch of small NPM modules into a single repo to reduce the overhead of managing many individual repos. Unlike some well-known monorepo examples (Babel, Jest, React and so on) which all form cohesive projects, the only thing the packages in this repo have in common is their authorship.

Advantages

No need to create mirrors at git.wincent.dev, github.com, gitlab.com and bitbucket.org every time I want to extract a tiny package containing a handful of lines of functionalitly.
Shared development dependencies provide a single place to keep Babel, ESLint, Flow, Jest, Prettier, TypeScript etc configured and up-to-date.
Using scoped package names makes it easy to allocate names that are both unique and descriptive.
Colocation of packages makes some types of cross-package verification easy (a couple of early examples: missing dependency check, mismatched version check, unwanted dev dependency check).

Disadvantages

No separate issue tracker per package (will use labels instead).
Packages don't have a strong connection that ties them together into a cohesive whole.
May be some kinks to iron out with respect to using Flow, Jest, TypeScript and other tools that may not expect to be in monorepo (example: module resolution tweaks).

Package listing

Package	Description
@wincent/clamp	Clamps a numerical value between a minimum and a maximum
@wincent/debounce	Simple debounce implementation
@wincent/dedent	Dedenting utility
@wincent/delay	A function that returns a promise that resolves after a delay
@wincent/escape-html	Escapes unsafe characters in HTML
@wincent/event-emitter	Simple event emitter
@wincent/frozen-set	ES6 Set stand-in for programming in an immutable style
@wincent/indent	Indenting utility
@wincent/invariant	Enforces an invariant
@wincent/babel-plugin-invariant-transform	Transforms invariant() calls for development and production
@wincent/is-object	Determines whether a value is an object
@wincent/nullthrows	Fail fast in the face of an unexpected null value
@wincent/stable-stringify	Like `JSON.stringify` but produces stable output regardless of insertion order
@wincent/throttle	Simple throttle
@wincent/workspace-scripts	Helper scripts for working within Yarn workspaces

This table may not necessarily stay up to date, so please check the packages directory.

Installation

# Clone the repo:
git clone https://github.com/wincent/js.git
cd js

# Install dependencies:
yarn

# Perform first-time-only set-up:
yarn bootstrap

# Build:
yarn build

Publishing

# For example, publishing a new version of @wincent/clamp:
cd packages/clamp
vim CHANGELOG.md
git add -p
yarn version --minor # or --major, or --patch

# From the top-level:
cd ../..
yarn run publish clamp

Creating a new package

scripts/new.sh some-package
cd packages/some-package
git add -N .

Edit "description" field in "package.json".
Define implementation.
Add tests.
Declare Flow types.
Update package CHANGELOG.md.
Add table row to top-level README.md.

git add --patch
yarn version --patch

# From the top-level:
cd ../..
yarn run publish some-package

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

wincent / js

js