Skip to content

README.md

Latest commit

 

History

History
41 lines (29 loc) · 1.2 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.2 KB

Monorepo Installer

Component of lifespikes/lifespikes

This is a composer plugin primarily for use in monorepo environments. As of right now this plugin is mostly meant to work hand-in-hand with Symplify's symplify/monorepo-plugin package.

What does it do?

M.I. primarily does two things:

  • Discourages require statements not originating from a package.
    • Prompts developer to choose a package to install package in.
  • Provides a simple command to create new packages.
    • composer workspace:create [package-name]
  • Runs vendor/bin/monorepo-builder merge upon a package installation.

Installation

To install, just run composer require lifespikes/monorepo-cli. You'll be able to use the plugin once it's activated on your composer file.

Configuration

You can configure the plugin by using your composer.json extra section. Here are the options you can configure:

'monorepo-cli' => [
   'owner'             => 'myOrganization',
   
   'ignore-packages'   =>  ['laravel-bare', 'monorepo-cli'],
   'package_dir'       =>  'packages',
   
   'binaries'          =>  [
       'monorepo-builder'  =>  'vendor/bin/monorepo-builder',
       'composer'          =>  'composer',
   ]
]