Skip to content

Commands.md

Latest commit

 

History

History
91 lines (59 loc) · 2.45 KB

Commands.md

File metadata and controls

91 lines (59 loc) · 2.45 KB
Raw

Commands

This page contains a list of convenient commands to manage the project.

Bootstrap

make bootstrap

The bootstrap command installs all required tools for deevelopment (see steps below for details).

Running make bootstrap will:

  • Run the homebrew.sh script to install Homebrew if not already installed
  • Run the mint.sh script to install Mint if not already installed
  • Run the tuist.sh script to install Tuist, if not already installed
  • Run the hooks.sh script, installing the pre-commit and git hooks in the local git repository

Rename

make rename

Runs rename.sh script that allows the rename of the project and bundle identifier.

Build

make build

Cleans and builds the project using Tuist.

Run

make run

Generate the project workspace and open it using Tuist.

Edit

make edit

Opens the Manifest for editing using Tuist.

Workspace

make workspace

Generate the project workspace but does not open it using Tuist.

Module

make module

Runs the module.sh script, that will guide you through creating a new module for this project. Just answer all the question, and the module will be created and generated by Tuist.

CI

make ci

Running this command will do the following:

  • Install tuist if needed
  • Generate with workspace using tuist
  • Build the workspace using tuist
  • Run all tests

There is also make ci_macos and make ci_ios to run the above commands for each platform individually.

Test

make test

Runs test_ios and test_macos.

make test_ios Runs all the iOS test plans, using xcodebuild.

make test_macos Runs all the macOS test plans, using xcodebuild.

make test_unit_ios Runs all the iOS unit tests, using xcodebuild.

make test_uni_macos Runs all the macOS unit tests, using xcodebuild.

Clean

make clean

Cleans the project by deleting all the *.xcodeproj and *.xcworkspace files to allow a clean project generation when using Tuist.

Linting and formatting

make lint

Runs lint.sh which lints all swift files using swiftlint and swiftformat through Mint.

make format

Runs format.sh which formats all swift files using swiftlint and swiftformat through Mint.

Unisntalling

make unbootstrap

All the installed tools can easily be removed again by running make unbootstrap.