https://github.com/wclr/yall

Yarn/npm for monorepos
https://github.com/wclr/yall

monorepo npm yarn

Last synced: about 1 month ago
JSON representation

Yarn/npm for monorepos

• Host: GitHub
• URL: https://github.com/wclr/yall
• Owner: wclr
• Created: 2017-05-01T19:27:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T05:04:08.000Z (over 3 years ago)
• Last Synced: 2023-10-20T23:46:29.864Z (about 1 year ago)
• Topics: monorepo, npm, yarn
• Language: TypeScript
• Homepage:
• Size: 204 KB
• Stars: 26
• Watchers: 2
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Yall

> Yarn workflow for monorepos (projects with multiple apps/packages within).

## Why

Because I didn't check yet how well [`workspaces`](https://yarnpkg.com/lang/en/docs/workspaces/) can work out (I see some issues with them). And there is need in good tool that would support container based dev workflow, including watching and running efficient installations in multiple nested locations.

## What

- `Yall` is like `yarn/npm` for multiple folders with `package.json`/`yarn.lock`. 

- It looks up for folders with `package.json/yarn.lock` in the project tree and runs there given command (by default in sequence, but may also concurrenlty).

- Can help to handle [`yarn` commands running concurrently](https://github.com/yarnpkg/yarn/issues/683).  

- It can watch manifest/lock files and run commands automatically on change, this is useful in container based scenarios.

- It can "keep state" and run installations only when lock files change (useful when you use `--force` installcations).

## Install

![npm (scoped)](https://img.shields.io/npm/v/@whitecolor/yall.svg?maxAge=86400) [![Build Status](https://travis-ci.org/whitecolor/yall.svg?branch=master)](https://travis-ci.org/whitecolor/yall)

```

  npm i @whitecolor/yall -g

```

*Work in progress. It is a pre-release.*

## Usage 

```

yall [yarn|npm command] [yarn|npm flags] [yall flags]

```

Additional `yall's` option flags:

- `concurrency` (`con`) - max count of tasks to run in parallel, by default disabled (value is 1)

- `fail-fast` - interupt process as soon as when the first error occures (by default process is not interupted if error happend in one of the folders, but when all tasks finished it exits with error code)

- `folders` - folders where to run (including nested), relative to cwd, wilcard not supported

- `force-local` - re-adds local (`file:` or `link:` ) dependencies.

- `force-local` - re-adds remote (`github:`, `git+ssh:`, etc ) dependencies.

- `dot-folders` - include (hidden) folders starting with dot

- `exclude-folders` - folders where not to run (including nested)

- `include-folders` - additional folders to include (for example: explit dot folders).

- `here` - will run only in current folder, if `folders` specified will run in those folders, but without nested

- `in` - shortcut for  `--include-folders [folder]` plus `--here`

- `link-files` - create symlinks for `file:` dependencies (will not touch [`yalc`](http://github.com/whitecolor/yalc) dependencies)

- `npm` - run `npm` command, alternativly to `yarn`

- `clean-up` - will clean-up/remove `node_modules` before command run

- `lock` - will create `.yall.lock` file (or file with specified name) while running commands and remove it after everything is done.

- `watch` - watch mode, will watch for changes of `yarn.lock` (`package.json` in case of `npm` or custom list of files specified) and run command in folder where file changed, it periodically rescans folders for new files

- `watch-content` - will check file content for change, not just all change events.

- `separate-cache-folder` (`sep-cache`) - will use separate cache folder for each installation (nested folder), this is string value, that will be used as a seed to get immutable unique path of cache folder (`yarn-cache-folder/uniqu-hash`).

- `debug` - some additional debug output

## Licence

WTF.