Skip to content

Latest commit

 

History

History
623 lines (465 loc) · 9.58 KB

maskfile.md

File metadata and controls

623 lines (465 loc) · 9.58 KB
Raw

Scuffle Tasks

build

Build the project

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

$MASK build rust
$MASK build website

rust

Build all rust code

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

target=$(rustup show active-toolchain | cut -d '-' -f2- | cut -d ' ' -f1)

cargo build --release --target=$target --bins --workspace

website

Build the frontend website

OPTIONS

  • no_gql_prepare
    • flags: --no-gql-prepare
    • desc: Don't prepare the GraphQL schema
  • no_player
    • flags: --no-player
    • desc: Don't build the player
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_gql_prepare" != "true" ]; then
    $MASK gql prepare
    export SCHEMA_URL=$(realpath frontend/website/schema.graphql)
fi

if [ "$no_player" != "true" ]; then
    $MASK build player
fi

pnpm --filter website build

player

Build the player

OPTIONS

  • dev
    • flags: --dev
    • desc: Build the player in dev mode
  • no_demo
    • flags: --no-demo
    • desc: Do not build the demo
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$dev" == "true" ]; then
    pnpm --filter @scuffle/player build:dev
else
    pnpm --filter @scuffle/player build
fi

clean

Clean the project

OPTIONS

  • all

    • flags: --all
    • desc: Removes everything that isn't tracked by git (use with caution, this is irreversible)

  • node_modules

    • flags: --node-modules
    • desc: Removes node_modules

  • env

    • flags: --env
    • desc: Removes .env
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [[ "$all" == "true" ]]; then
    git clean -xfd
fi

cargo clean
pnpm --recursive --parallel --stream run clean

if [ "$node_modules" == "true" ]; then
    rm -rf node_modules
fi

if [ "$env" == "true" ]; then
    rm -rf .env
fi

format

Format the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust formatting
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS formatting
  • no_terraform
    • flags: --no-terraform
    • type: bool
    • desc: Disables Terraform formatting
  • no_proto
    • flags: --no-proto
    • type: bool
    • desc: Disables Protobuf formatting
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_js" != "true" ]; then
    pnpm --recursive --parallel --stream run format
fi

if [ "$no_terraform" != "true" ]; then
    terraform fmt -recursive
fi

if [ "$no_proto" != "true" ]; then
    find . -name '*.proto' -exec clang-format -i {} \;
fi

if [ "$no_rust" != "true" ]; then
    cargo fmt --all
    cargo clippy --fix --allow-dirty --allow-staged
fi

lint

Lint the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust linting
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS linting
  • no_terraform
    • flags: --no-terraform
    • type: bool
    • desc: Disables Terraform linting
  • no_proto
    • flags: --no-proto
    • type: bool
    • desc: Disables Protobuf linting
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_rust" != "true" ]; then
    cargo clippy -- -D warnings
    cargo fmt --all --check
    cargo sqlx prepare --check --workspace -- --all-targets --all-features
    $MASK gql check
fi

if [ "$no_js" != "true" ]; then
    pnpm --recursive --parallel --stream run lint
fi

if [ "$no_terraform" != "true" ]; then
    terraform fmt -check -recursive
fi

if [ "$no_proto" != "true" ]; then
    find . -name '*.proto' -exec clang-format --dry-run --Werror {} \;
fi

audit

Audit the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust linting
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS linting
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_rust" != "true" ]; then
    cargo audit
    cd frontend/player && cargo audit && cd ../..
fi

if [ "$no_js" != "true" ]; then
    pnpm audit
fi

test

Test the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust testing
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS testing
  • no_player_build
    • flags: --no-player-build
    • type: bool
    • desc: Disables Player Building
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_rust" != "true" ]; then
  cargo llvm-cov nextest --lcov --output-path lcov.info --ignore-filename-regex "(main\.rs|tests|.*\.nocov\.rs)" --workspace --fail-fast -r
fi

if [ "$no_js" != "true" ]; then
    if [ "$no_player_build" != "true" ]; then
        $MASK build player --dev
    fi

    pnpm --recursive --parallel --stream run test
fi

db

Database tasks

migrate

Migrate the database

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

sqlx database create
sqlx migrate run --source ./backend/migrations

create (name)

Create a database migration

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

sqlx migrate add "$name" --source ./backend/migrations -r

rollback

Rollback the database

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

sqlx migrate revert --source ./backend/migrations

prepare

Prepare the database

OPTIONS

  • no_format
    • flags: --no-format
    • type: bool
    • desc: Disables formatting
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

cargo sqlx prepare --workspace -- --all-targets --all-features

if [ "$no_format" != "true" ]; then
    pnpm exec prettier --write .sqlx
fi

reset

Reset the database

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

sqlx database reset --source ./backend/migrations

up

Starts the docker compose stack

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

docker compose --file ./dev-stack/db.docker-compose.yml up -d

down

Stops the docker compose stack

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

docker compose --file ./dev-stack/db.docker-compose.yml down

status

Gets the status of the docker compose db stack

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

docker compose --file ./dev-stack/db.docker-compose.yml ps -a

env

Environment tasks

generate

Generate the environment files

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ ! -f .env ]; then
    echo "DATABASE_URL=postgres://root@localhost:5432/scuffle_dev" > .env
    echo "RMQ_URL=amqp://rabbitmq:rabbitmq@localhost:5672/scuffle" >> .env
    echo "REDIS_URL=redis://localhost:6379/0" >> .env
fi

backup

Backup the environment files

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ -f .env ]; then
    mv .env .env.bak
fi

restore

Restore the environment files

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ -f .env.bak ]; then
    mv .env.bak .env
fi

bootstrap

Bootstrap the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust bootstrapping
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS bootstrapping
  • no_js_tests
    • flags: --no-js-tests
    • type: bool
    • desc: Disables JS tests bootstrapping
  • no_env
    • flags: --no-env
    • type: bool
    • desc: Disables environment bootstrapping
  • no_docker
    • flags: --no-docker
    • type: bool
    • desc: Disables docker bootstrapping
  • no_db
    • flags: --no-db
    • type: bool
    • desc: Disables database bootstrapping
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$no_rust" != "true" ]; then
    rustup update

    rustup component add rustfmt clippy llvm-tools-preview

    cargo install cargo-binstall
    cargo binstall cargo-watch -y
    cargo install sqlx-cli --features native-tls,postgres --no-default-features --git https://github.com/launchbadge/sqlx --branch main
    cargo binstall cargo-llvm-cov -y
    cargo binstall cargo-nextest -y
    cargo install cargo-audit --features vendored-openssl
fi

if [ "$no_js" != "true" ]; then
    pnpm --recursive --stream install --frozen-lockfile

    if [ "$no_js_tests" != "true" ]; then
        pnpm --filter website exec playwright install
    fi
fi

if [ "$no_env" != "true" ]; then
    $MASK env generate
fi

if [ "$no_docker" != "true" ]; then
    docker network create scuffle-dev || true

    if [ "$no_db" != "true" ]; then
        $MASK db up
        $MASK db migrate
    fi
fi

update

Update the project

OPTIONS

  • no_rust
    • flags: --no-rust
    • type: bool
    • desc: Disables Rust updating
  • rust_up
    • flags: --rust-up
    • type: bool
    • desc: Updates Rust toolchain
  • no_js
    • flags: --no-js
    • type: bool
    • desc: Disables JS updating
set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

if [ "$rust_up" == "true" ]; then
    rustup update
fi

if [ "$no_rust" != "true" ]; then

    cargo update
fi

if [ "$no_js" != "true" ]; then
    pnpm --recursive --stream run update
fi

gql

GraphQL tasks

prepare

Generate the GraphQL schema

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

cargo run --bin api-gql-generator | pnpm exec prettier --stdin-filepath schema.graphql > schema.graphql

check

Check the GraphQL schema

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

cargo run --bin api-gql-generator | pnpm exec prettier --stdin-filepath schema.graphql | diff - schema.graphql || (echo "GraphQL schema is out of date. Run 'mask gql prepare' to update it." && exit 1)

echo "GraphQL schema is up to date."

cloc

Count lines of code

set -e
if [[ "$verbose" == "true" ]]; then
    set -x
fi

cloc $(git ls-files)