Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laurenhamel/frau
A pluggable build system for monorepos using Yarn workspaces
https://github.com/laurenhamel/frau
Last synced: 6 days ago
JSON representation
A pluggable build system for monorepos using Yarn workspaces
- Host: GitHub
- URL: https://github.com/laurenhamel/frau
- Owner: laurenhamel
- License: mit
- Created: 2023-12-17T16:05:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2023-12-17T17:10:52.000Z (11 months ago)
- Last Synced: 2024-04-15T04:24:16.455Z (7 months ago)
- Language: TypeScript
- Size: 34.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Frau
> A pluggable build system for monorepos using Yarn workspaces
## Overview
A lighter alternative to full-fledged build systems, such as [Lerna](https://lerna.js.org/), [Nx](https://nx.dev), and [Bit](https://bit.dev/), and monorepo management tools like [oao](https://github.com/guigrpa/oao), [Frau]() aims to be a simple drop-in solution for extending the functionality of [`yarn workspaces`](https://yarnpkg.com/features/workspaces).
## Installation
```sh
# yarn
yarn add -D frau
# npm
npm installl --save-dev frau
```
## Usage
To see all CLI options, run `frau --help`:
```sh
Usage: frau [options] [command]
A pluggable build system for monorepos using Yarn workspaces
Options:
-V, --version output the version number
-P, --plugins A directory of workspace-specific plugins
-h, --help display help for command
Commands:
add|+ [options] [workspaces...] Add one or more dependencies to one or more workspaces
configure|c [options] Convert an arbitrary configuration file to command-line arguments
remove|- [options] [workspaces...] Remove one or more dependencies from one or more workspaces
run|r [options] [workspaces...] Run a script in one or more workspaces
help [command] display help for command
```
## Extensibility
To extend the functionality of `frau`, define your own [commands](src/commands) in a directory (e.g., `.frau`), then pass the directory path into the CLI using the `--plugins`/`-P` option.