Configuration Overview

Every project requires a melos.yaml project in the root. The below outlines all the configurable fields and their purpose.

`name`

The name of this project for display purposes within IO environments and IDEs.

name: My Awesome Project

`repository`

The URL of the git repository that contains the Melos workspace.

Supported hosts:

GitHub
GitLab (https://gitlab.com)

repository: https://github.com/invertase/melos

When using a self-hosted GitHub or GitLab instance, you can specify the repository location like this:

repository:
  type: gitlab
  origin: https://gitlab.example.dev
  owner: invertase
  name: melos

`sdkPath`

Path to the Dart/Flutter SDK that should be used.

Relative paths are resolved relative to the melos.yaml file.

To use the system-wide SDK, provide the special value "auto".

If the SDK path is specified though multiple mechanisms, the precedence from highest to lowest is:

--sdk-path global command line option
MELOS_SDK_PATH environment variable
sdkPath in melos.yaml

sdkPath: .fvm/flutter_sdk

`packages`

A list of paths to local packages that are included in the Melos workspace. Each entry can be a specific path or a glob pattern.

packages:
  # e.g. include all packages inside the `packages` directory at any level
  - packages/**
  # e.g. include all packages inside the `packages` directory that are direct children
  - packages/*
  # e.g. include the package in the workspace root
  - .

`ignore`

A list of paths to local packages that are excluded from the Melos workspace. Each entry can be a specific path or a glob pattern.

ignore:
  # e.g. ignore example apps
  - 'packages/**/example'

`ide`

Configuration for realting to IDE support.

`ide/intellij/enabled`

Whether to generate IntelliJ IDEA config files to improve the developer experience when working in a Melos workspace.

The default is true.

ide:
  intellij:
    enabled: false # set to false to override default and disable

`ide/intellij/moduleNamePrefix`

Used when generating IntelliJ project modules files. This value specifies a string to prepend to a package's IntelliJ module name. Use this to avoid name collisions with other IntelliJ modules you may already have in place.

The default is 'melos_'.

`scripts`

Define custom scripts that can be executed in the workspace via the melos run command.

Learn more about defining scripts here.

`command`

Configuration relating to specific Melos commands such as versioning.

`command/bootstrap`

Configuration for the bootstrap command.

`command/bootstrap/usePubspecOverrides`

Whether to use pubspec_overrides.yaml for overriding workspace dependencies during development.

Enabling this option requires Dart 2.17.0 or greater.

When this option is enabled, Melos will generate a pubspec_overrides.yaml file in the root of every package during bootstrapping. This file should not be tracked in version control and should be added to .gitignore.

This mechanism has the advantage that it does not conflict with other tooling such as the dart and flutter tools and IDE plugins, when compared to the original mechanism used to link local packages.

`command/bootstrap/runPubGetInParallel`

Whether to run pub get in parallel during bootstrapping.

The default is true.

`command/bootstrap/runPubGetOffline`

Whether to attempt to run pub get in offline mode during bootstrapping.

Useful in closed network environments with pre-populated pubcaches.

The default is false.

`command/version`

Configuration for the version command.

`command/version/message`

A template for the commit message, that is generated by melos version.

Templates must use mustache syntax and have the following variables available:

new_package_versions: A list of the versioned packages and their new versions.

The default is:

chore(release): publish packages

{new_package_versions}

command:
  version:
    message: |
      chore: cut package releases 🎉

      {new_package_versions}

`command/version/branch`

If specified, prevents melos version from being used inside branches other than the one specified.

command:
  version:
    branch: main

`command/version/includeScopes`

Whether to include conventional commit scopes in the generated CHANGELOG.md.

command:
  version:
    includeScopes: true

`command/version/includeCommitId`

Whether to add short commit ids to commits (no links) in the CHANGELOG.md that is generated by melos version.

command:
  version:
    includeCommitId: true

`command/version/linkToCommits`

Whether to add links to commits in the CHANGELOG.md that is generated by melos version.

Enabling this option, requires repository to be specified.

command:
  version:
    linkToCommits: true

`command/version/workspaceChangelog`

Whether to additionally build a CHANGELOG.md at the root of the workspace when running melos version.

command:
  version:
    workspaceChangelog: true

`command/version/changelogs`

Configure aggregate changelogs which document the changes made to multiple packages.

command:
  version:
    changelogs:
      - path: FOO_CHANGELOG.md
        description: |
          All notable changes to foo packages will be documented in this file.
        packageFilters:
          scope: foo_*

`command/version/changelogs/path`

The path to the changelog file relative to the workspace root.

`command/version/changelogs/packageFilters`

Package filters to match packages that should be included in the changelog.

See Filtering Packages for all available filters.

`command/version/changelogs/description`

A description to include at the top of the changelog.

If you change this value, you will need to manually update the changelog file to reflect the new description.

`command/version/updateGitTagRefs`

Whether to update package version tags in git dependencies of dependents when versioning packages.

See the automated releases documentation for more information.

command:
  version:
    updateGitTagRefs: true

`command/version/releaseUrl`

Whether to generate and print a link to the prefilled release creation page for each package after versioning. Defaults to false.

Configuration

Commands

Guides