sip_cli 0.0.9

Manage mono-repos with `sip`, run scripts and get dependencies concurrently.

SIP

A command-line tool to handle mono-repos in dart/flutter

Installation

dart pub global activate sip

Usage

sip --help

Script Execution Commands

Regardless of your current working directory, the script will always be executed from the same directory as the scripts.yaml file.

RUN

The sip run command will run a script defined within the scripts.yaml file.

build_runner:
    build: dart run build_runner build --delete-conflicting-outputs

$ sip run build_runner build

- dart run build_runner build --delete-conflicting-outputs
...

RUN-MANY

The sip run-many command will run a script defined within the scripts.yaml file concurrently.

pub:
    get:
        - cd packages/core && dart pub get
        - cd packages/data && dart pub get
        - cd packages/ui && flutter pub get

$: sip run-many pub get

- Running "cd packages/core && dart pub get"
- Running "cd packages/data && dart pub get"
- Running "cd packages/ui && flutter pub get"

Pub Commands

PUB GET

sip pub get runs pub get in the closest parent directory containing a pubspec.yaml file.

# Current working directory: packages/core/lib
$ sip pub get

- Running pub get

- (dart)    ./..

Sip can determine if flutter is being used within the project, so it will run flutter pub get instead of dart pub get.

# Current working directory: packages/ui/lib
$ sip pub get

- Running pub get

- (flutter) ./..

Recursively

sip pub get --recursive runs pub get in all children directories containing a pubspec.yaml file, concurrently.

Note: A pubspec.yaml file does not need to be present in the current working directory.

# Current working directory: packages
$ sip pub get --recursive

- Running pub get

- (dart)    ./core
- (dart)    ./data
- (flutter) ./ui

PUB UPGRADE

sip pub upgrade runs pub upgrade. It performs and functions the same as sip pub get but will upgrade all dependencies to the latest version.

Script.yaml configuration

# scripts.yaml

(variables):
    flutter: fvm flutter

# The name of the script
build_runner:

    # The command to run
    build: dart run build_runner build --delete-conflicting-outputs

    watch:
        # The description of the script
        (description): Run build_runner in watch mode

        # The alternative way to define the command
        (command): dart run build_runner watch --delete-conflicting-outputs

        # The aliases for the script
        (aliases):
            - w

test:
    # {--coverage} is an optional argument, if it is provided, it will be passed into the command, otherwise it will be ignored
    (command): '{flutter} test {--coverage}'

    # {$test} references the defined script `test`. The flag `--coverage=coverage` will activate the coverage flag found in`test`, passing it (--coverage) and it's value (=coverage) to the `test` command
    # Supported flag formats:
    #    e.g. --flag  |  --flag=value  |  --flag value1 value2
    # Supports multiple flags
    #    e.g. --flag1 --flag2=value2 --flag3 value3 value4
    coverage: "{$test} --coverage=coverage"

echo:
    dirs:
        - echo "{packageRoot}" # The directory that the pubspec.yaml file is in
        - echo "{scriptsRoot}" # The directory that the scripts.yaml file is in
        - echo "{cwd}" # The current directory that you are in

Nesting scripts

You can nest scripts within other scripts. This helps with reusability and organization.

# scripts.yaml

format:
    ui: cd packages/ui && {$format}
    core: cd packages/core && {$format}

If you would like to define a script to run and nest other scripts, you can use the (command) key.

# scripts.yaml

format:
    (command): dart format .
    ui: cd packages/ui && dart format .
    core: cd packages/core && dart format .

Bail

Bailing on a script means that the moment a command fails, the script will stop running, even if there are other commands to run.

You can bail a script if you pass the --bail flag when running the script.

$ sip run test --bail

...
✖ Script dart run test failed with exit code unknown: 1 

✖ Bailing...

Optionally, you can always set a script to fail by using the (bail): key in the scripts.yaml file.

# scripts.yaml

test:
    (bail): # leave blank, or set to: true, yes, y
    (command): dart test

$ sip run test

...
✖ Script dart run test failed with exit code unknown: 1 

✖ Bailing...

Referencing other scripts

You can reference other scripts within the scripts.yaml file by using the $ symbol. When referencing a script, the command defined for that referenced script will be used.

# scripts.yaml

pub_get: dart pub get

pub_get_ui: cd packages/ui && {$pub_get}

$ sip run pub_get

- cd packages/ui && dart pub get

If there is a nested script, the (command) key is omitted.

# scripts.yaml

pub:
    (command): dart pub
    get: '{$pub} get'
    ui: cd packages/ui && {$pub:get}

$ sip run pub get ui

- cd packages/ui && dart pub get

Flags

By default, anything passed after the script is ignored.

# scripts.yaml

test: dart test

$ sip run test --coverage

- dart test

If you would like to pass flags to the script, you can use the {-*} symbol. Any and all values passed after the flag will be passed to the script.

These flags will remain optional, and can be omitted when running the script.

# scripts.yaml

test: dart test {--coverage}

other: other {--flag} {--verbose}

$ sip run test --coverage=coverage

- dart test --coverage=coverage

$ sip run other --flag value1 value2

- other --flag value1 value2

$ sip run other --verbose

- other --verbose

Private keys

Private keys cannot be invoked from the command line, but can be used as references in the scripts.yaml file.

To define a private key, prepend the key with the _ symbol.

# scripts.yaml

format:
    _command: dart format .
    (command): cd packages/ui && {$format:_command}

Always run commands concurrently

Sometimes you may want to run a command concurrently, regardless of whether run or run-many is used. You can use the concurrent key (+) to achieve this.

The commands will be grouped together and run concurrently. Meaning that you can have concurrent and non-concurrent commands mixed together. The commands will always run in the order they are defined.

Note:

• The concurrent key must be followed by a whitespace.
• The concurrent key must always be the first character in the command string.

# scripts.yaml

format:
    (command):
        - echo "Running format"
        # ---- start concurrent commands
        - (+) cd packages/ui && dart format .
        - (+) cd packages/core && dart format .
        # ---- end concurrent commands
        - echo "Finished running format"

Variables

A variable is a placeholder for a value that is to be provided when the script is run. Variables cannot be invoked from the command line, but can be used in the scripts.yaml file.

Variables do not use the $ symbol.

Sip provides a few variables that can be used within the scripts.yaml file

• {packageRoot}: The directory that the pubspec.yaml file is in
• {scriptsRoot}: The directory that the scripts.yaml file is in
• {cwd}: The current directory that you are in

If you need to create your own variable, you can define them under the (variables) key

# scripts.yaml
(variables):
    # Check if flutter is installed and that the project is a flutter project
    dartOrFlutter: if [ -n "$(which flutter)" ] && grep -q flutter pubspec.lock; then COMMAND="flutter"; else COMMAND="dart"; fi; $COMMAND

deps: cd packages/ui && {dartOrFlutter} pub get

$ sip run deps

- cd packages/ui && if [ -n "$(which flutter)" ] && grep -q flutter pubspec.lock; then COMMAND="flutter"; else COMMAND="dart"; fi; $COMMAND pub get

^^^ This will run flutter pub get since the ui project is a flutter project.