README.md

Environment Setup Guide

This guide explains the required environment variables for working with wrkstrm packages and tools. This guide is specifically for M class Macs.

Installation

Prerequisites

1. Homebrew

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

   After installation, make sure Homebrew is in your PATH:

   eval "$(/opt/homebrew/bin/brew shellenv)"

2. Development Tools

   Install required development tools using Homebrew:

   # Install Fastlane for iOS automation and localization
   brew install fastlane
   
   # Install linting tools
   brew install swiftlint
   brew install swiftformat
   brew install swift-format

3. Environment Setup

   Add the following to your ~/.zprofile:

   # Package Steward Configuration
   # Controls whether to use local dependencies (true) or remote dependencies (false)
   export SPM_CI_USE_LOCAL_DEPS=true

This environment variable controls dependency resolution behavior:

• true: Uses local dependencies for development
• false: Uses remote dependencies (useful for CI environments)

Verification

Verify your installations:

# Check Homebrew
brew --version

# Check Fastlane
fastlane --version

# Check SwiftLint
swiftlint version

Verification

After adding the variable to your .zprofile, verify your setup:

source ~/.zprofile
echo $SPM_CI_USE_LOCAL_DEPS

This should output: true

Troubleshooting

brew issues

If you encounter any issues:

1. Update Homebrew and all packages:

   brew update && brew upgrade

2. Check for any Homebrew problems:

   brew doctor

3. Ensure Homebrew's binary location is in your PATH:

   echo $PATH | grep brew

.zprofile issues

If the variable isn't being set:

1. Ensure your .zprofile is being sourced by adding to .zshrc:

   if [ -f "$HOME/.zprofile" ]; then
       source "$HOME/.zprofile"
   fi

2. Check file permissions:

   chmod 600 ~/.zprofile

3. Verify the variable after opening a new terminal:

   echo $SPM_CI_USE_LOCAL_DEPS