melos.yaml

name: Flame
repository: https://github.com/flame-engine/flame

packages:
  - packages/**
  - examples/**
  - tutorials/**
  - doc/**

command:
  bootstrap:
    # Uses the pubspec_overrides.yaml instead of having Melos modifying the lock file.
    usePubspecOverrides: true

  version:
    # Generate commit links in package changelogs.
    linkToCommits: true
    # Only allow versioning to happen on main branch.
    branch: main
    # Additionally build a changelog at the root of the workspace.
    workspaceChangelog: true

scripts:
  lint:all:
    run: melos run analyze && melos run format
    description: Run all static analysis checks.

  analyze:
    run: |
      melos exec -c 10 -- \
        flutter analyze --fatal-infos
    description: Run `flutter analyze` for all packages.

  format:
    run: melos exec flutter format . --fix
    description: Run `flutter format` for all packages.

  format-check:
    run: melos exec flutter format . --set-exit-if-changed
    description: Run `flutter format` checks for all packages.

  markdown-check:
    run: markdownlint . --ignore-path .markdownlintignore --config .markdownlint.yaml
    description: Runs the markdown linting check.

  markdown-fix:
    run: markdownlint . --fix --ignore-path .markdownlintignore --config .markdownlint.yaml
    description: Fixes the markdown linting errors.

  dartdoc:
    run: melos exec flutter pub run dartdoc
    description: Run dartdoc checks for all packages.

  doc-build:
    run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make html
    description: Create the sphinx html docs.

  doc-serve:
    run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make livehtml
    description: Recompiles the docs enerytime there is a change in them and opens your browser.

  doc-clean:
    run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make clean
    description: Removes all Sphinx's cached generated files.

  doc-linkcheck:
    run: cd "$MELOS_ROOT_PATH/doc/_sphinx" && make linkcheck
    description: Checks whether there are any broken links in the docs.

  test:select:
    run: melos exec -- flutter test
    select-package:
      dir-exists:
        - test
    description: Run `flutter test` for selected packages.

  test:
    run: melos run test:select --no-select
    description: Run all Flutter tests in this project.

  coverage:
    run: |
      melos exec -- flutter test --coverage &&
      melos exec -- genhtml coverage/lcov.info --output-directory=coverage/
    select-package:
      dir-exists: test
    description: Generate coverage for the selected package.

  update-goldens:
    run: melos exec -- flutter test --update-goldens
    select-package:
      dir-exists: test
    description: Re-generate all golden test files