melos

This Mason brick bootstraps a Melos project structure, supporting both monorepos and poly-repositories. Use this brick to quickly set up a multi-package workspace for your Dart and Flutter projects.

Variables

Variable Details

• name: The name of your project.
• packages: An array specifying the directories for your packages. Common directories include "packages" for reusable packages and "apps" for end-user applications.
• isMono: Set this to true if creating a monorepo structure, or false for a poly-repository setup.

Usage

1. Install Mason (if you haven’t already):

   dart pub global activate mason_cli
   

2. Add the Brick:

   mason add melos -g
   

3. Generate the Project: Run the following command and follow the prompts to customize your project:

   mason make melos
   

Notes

• This brick is helpful for initializing Melos projects with a custom directory structure.
• You may want to customize the resulting workspace in melos.yaml based on your project’s requirements.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add melos

# Install globally
mason add -g melos

Usage 🚀

mason make melos

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.60 <0.1.0"

0.0.3+2

• FIX: package name for poly repo.

0.0.3+1

• DOCS: update README.md.

0.0.3

• FEAT: add support for non-mono repositories.

0.0.2

• FIX: add intellij files to .gitignore.
• FIX: add .gitignore file in root.
• FEAT: running melos bootstrap in post hook.
• FEAT: adding melos as dev dependency using hooks.

0.0.1+1

• Initial release

MIT License

Copyright (c) 2024 Albin PK

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.