chore: enhance clangd and CI configurations for improved development experience
- Updated `.clangd` configuration to include additional include paths and feature flags tailored for ROM hacking workflows, optimizing IntelliSense support. - Introduced `.pre-commit-config.yaml` for managing code quality checks and formatting, ensuring consistent code style across the project. - Added `cmake-format.yaml` for CMake formatting configuration, promoting adherence to style guidelines. - Enhanced CI workflows to include new actions for testing and building, improving overall reliability and efficiency in the development process. Benefits: - Streamlines development setup and improves code quality through automated checks. - Facilitates better collaboration by ensuring consistent coding standards and configurations.
This commit is contained in:
scawful
288
scripts/dev-setup.sh
Executable file
288
scripts/dev-setup.sh
Executable file
@@ -0,0 +1,288 @@
|
||||
#!/bin/bash
|
||||
# YAZE Developer Setup Script
|
||||
# One-command setup for new developers
|
||||
|
||||
set -e
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Print functions
|
||||
print_header() {
|
||||
echo -e "${BLUE}================================${NC}"
|
||||
echo -e "${BLUE}$1${NC}"
|
||||
echo -e "${BLUE}================================${NC}"
|
||||
}
|
||||
|
||||
print_success() {
|
||||
echo -e "${GREEN}✓ $1${NC}"
|
||||
}
|
||||
|
||||
print_warning() {
|
||||
echo -e "${YELLOW}⚠ $1${NC}"
|
||||
}
|
||||
|
||||
print_error() {
|
||||
echo -e "${RED}✗ $1${NC}"
|
||||
}
|
||||
|
||||
# Detect OS
|
||||
detect_os() {
|
||||
if [[ "$OSTYPE" == "linux-gnu"* ]]; then
|
||||
OS="linux"
|
||||
elif [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
OS="macos"
|
||||
elif [[ "$OSTYPE" == "msys" ]] || [[ "$OSTYPE" == "cygwin" ]]; then
|
||||
OS="windows"
|
||||
else
|
||||
OS="unknown"
|
||||
fi
|
||||
echo "Detected OS: $OS"
|
||||
}
|
||||
|
||||
# Check prerequisites
|
||||
check_prerequisites() {
|
||||
print_header "Checking Prerequisites"
|
||||
|
||||
# Check Git
|
||||
if command -v git &> /dev/null; then
|
||||
print_success "Git found: $(git --version)"
|
||||
else
|
||||
print_error "Git not found. Please install Git first."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check CMake
|
||||
if command -v cmake &> /dev/null; then
|
||||
CMAKE_VERSION=$(cmake --version | head -n1 | cut -d' ' -f3)
|
||||
print_success "CMake found: $CMAKE_VERSION"
|
||||
|
||||
# Check version
|
||||
CMAKE_MAJOR=$(echo $CMAKE_VERSION | cut -d'.' -f1)
|
||||
CMAKE_MINOR=$(echo $CMAKE_VERSION | cut -d'.' -f2)
|
||||
if [ "$CMAKE_MAJOR" -lt 3 ] || ([ "$CMAKE_MAJOR" -eq 3 ] && [ "$CMAKE_MINOR" -lt 16 ]); then
|
||||
print_error "CMake 3.16+ required. Found: $CMAKE_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
print_error "CMake not found. Please install CMake 3.16+ first."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check compiler
|
||||
if command -v gcc &> /dev/null; then
|
||||
GCC_VERSION=$(gcc --version | head -n1 | cut -d' ' -f4)
|
||||
print_success "GCC found: $GCC_VERSION"
|
||||
elif command -v clang &> /dev/null; then
|
||||
CLANG_VERSION=$(clang --version | head -n1 | cut -d' ' -f4)
|
||||
print_success "Clang found: $CLANG_VERSION"
|
||||
else
|
||||
print_error "No C++ compiler found. Please install GCC 12+ or Clang 14+."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check Ninja
|
||||
if command -v ninja &> /dev/null; then
|
||||
print_success "Ninja found: $(ninja --version)"
|
||||
else
|
||||
print_warning "Ninja not found. Will use Make instead."
|
||||
fi
|
||||
}
|
||||
|
||||
# Install dependencies
|
||||
install_dependencies() {
|
||||
print_header "Installing Dependencies"
|
||||
|
||||
case $OS in
|
||||
"linux")
|
||||
if command -v apt-get &> /dev/null; then
|
||||
print_success "Installing dependencies via apt..."
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y build-essential ninja-build pkg-config ccache \
|
||||
libsdl2-dev libyaml-cpp-dev libgtk-3-dev libglew-dev
|
||||
elif command -v dnf &> /dev/null; then
|
||||
print_success "Installing dependencies via dnf..."
|
||||
sudo dnf install -y gcc-c++ ninja-build pkgconfig SDL2-devel yaml-cpp-devel
|
||||
elif command -v pacman &> /dev/null; then
|
||||
print_success "Installing dependencies via pacman..."
|
||||
sudo pacman -S --needed base-devel ninja pkgconfig sdl2 yaml-cpp
|
||||
else
|
||||
print_warning "Unknown Linux distribution. Please install dependencies manually."
|
||||
fi
|
||||
;;
|
||||
"macos")
|
||||
if command -v brew &> /dev/null; then
|
||||
print_success "Installing dependencies via Homebrew..."
|
||||
brew install cmake ninja pkg-config ccache sdl2 yaml-cpp
|
||||
else
|
||||
print_warning "Homebrew not found. Please install dependencies manually."
|
||||
fi
|
||||
;;
|
||||
"windows")
|
||||
print_warning "Windows detected. Please install dependencies manually:"
|
||||
echo "1. Install Visual Studio Build Tools"
|
||||
echo "2. Install vcpkg and packages: sdl2, yaml-cpp"
|
||||
echo "3. Install Ninja from https://ninja-build.org/"
|
||||
;;
|
||||
*)
|
||||
print_warning "Unknown OS. Please install dependencies manually."
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
# Setup repository
|
||||
setup_repository() {
|
||||
print_header "Setting up Repository"
|
||||
|
||||
# Check if we're in a git repository
|
||||
if [ ! -d ".git" ]; then
|
||||
print_error "Not in a git repository. Please run this script from the YAZE root directory."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Update submodules
|
||||
print_success "Updating submodules..."
|
||||
git submodule update --init --recursive
|
||||
|
||||
# Check for uncommitted changes
|
||||
if ! git diff-index --quiet HEAD --; then
|
||||
print_warning "You have uncommitted changes. Consider committing or stashing them."
|
||||
fi
|
||||
}
|
||||
|
||||
# Configure IDE
|
||||
configure_ide() {
|
||||
print_header "Configuring IDE"
|
||||
|
||||
# Generate compile_commands.json
|
||||
print_success "Generating compile_commands.json..."
|
||||
cmake -B build -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
|
||||
|
||||
# Create VS Code settings
|
||||
if [ ! -d ".vscode" ]; then
|
||||
mkdir -p .vscode
|
||||
print_success "Creating VS Code configuration..."
|
||||
|
||||
cat > .vscode/settings.json << EOF
|
||||
{
|
||||
"C_Cpp.default.configurationProvider": "ms-vscode.cmake-tools",
|
||||
"C_Cpp.default.compileCommands": "build/compile_commands.json",
|
||||
"C_Cpp.default.intelliSenseMode": "macos-clang-x64",
|
||||
"files.associations": {
|
||||
"*.h": "c",
|
||||
"*.cc": "cpp"
|
||||
},
|
||||
"cmake.buildDirectory": "build",
|
||||
"cmake.configureOnOpen": true,
|
||||
"cmake.generator": "Ninja"
|
||||
}
|
||||
EOF
|
||||
|
||||
cat > .vscode/tasks.json << EOF
|
||||
{
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "build",
|
||||
"type": "shell",
|
||||
"command": "cmake",
|
||||
"args": ["--build", "build"],
|
||||
"group": "build",
|
||||
"presentation": {
|
||||
"echo": true,
|
||||
"reveal": "always",
|
||||
"focus": false,
|
||||
"panel": "shared"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "configure",
|
||||
"type": "shell",
|
||||
"command": "cmake",
|
||||
"args": ["--preset", "dev"],
|
||||
"group": "build"
|
||||
}
|
||||
]
|
||||
}
|
||||
EOF
|
||||
fi
|
||||
}
|
||||
|
||||
# Run first build
|
||||
run_first_build() {
|
||||
print_header "Running First Build"
|
||||
|
||||
# Configure project
|
||||
print_success "Configuring project..."
|
||||
cmake --preset dev
|
||||
|
||||
# Build project
|
||||
print_success "Building project..."
|
||||
cmake --build build
|
||||
|
||||
# Check if build succeeded
|
||||
if [ -f "build/bin/yaze" ] || [ -f "build/bin/yaze.exe" ]; then
|
||||
print_success "Build successful! YAZE executable created."
|
||||
else
|
||||
print_error "Build failed. Check the output above for errors."
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
# Run tests
|
||||
run_tests() {
|
||||
print_header "Running Tests"
|
||||
|
||||
print_success "Running test suite..."
|
||||
cd build
|
||||
ctest --output-on-failure -L stable || print_warning "Some tests failed (this is normal for first setup)"
|
||||
cd ..
|
||||
}
|
||||
|
||||
# Print next steps
|
||||
print_next_steps() {
|
||||
print_header "Setup Complete!"
|
||||
|
||||
echo -e "${GREEN}✓ YAZE development environment is ready!${NC}"
|
||||
echo ""
|
||||
echo "Next steps:"
|
||||
echo "1. Run the application:"
|
||||
echo " ./build/bin/yaze"
|
||||
echo ""
|
||||
echo "2. Run tests:"
|
||||
echo " cd build && ctest"
|
||||
echo ""
|
||||
echo "3. Format code:"
|
||||
echo " cmake --build build --target yaze-format"
|
||||
echo ""
|
||||
echo "4. Check formatting:"
|
||||
echo " cmake --build build --target yaze-format-check"
|
||||
echo ""
|
||||
echo "5. Read the documentation:"
|
||||
echo " docs/BUILD.md"
|
||||
echo ""
|
||||
echo "Happy coding! 🎮"
|
||||
}
|
||||
|
||||
# Main function
|
||||
main() {
|
||||
print_header "YAZE Developer Setup"
|
||||
echo "This script will set up your YAZE development environment."
|
||||
echo ""
|
||||
|
||||
detect_os
|
||||
check_prerequisites
|
||||
install_dependencies
|
||||
setup_repository
|
||||
configure_ide
|
||||
run_first_build
|
||||
run_tests
|
||||
print_next_steps
|
||||
}
|
||||
|
||||
# Run main function
|
||||
main "$@"
|
||||
138
scripts/merge_feature.sh
Executable file
138
scripts/merge_feature.sh
Executable file
@@ -0,0 +1,138 @@
|
||||
#!/bin/bash
|
||||
# Quick feature branch merge script for yaze
|
||||
# Merges feature → develop → master, pushes, and cleans up
|
||||
|
||||
set -e # Exit on error
|
||||
|
||||
# Colors
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
RED='\033[0;31m'
|
||||
BLUE='\033[0;34m'
|
||||
CYAN='\033[0;36m'
|
||||
NC='\033[0m'
|
||||
|
||||
# Usage
|
||||
if [ $# -lt 1 ]; then
|
||||
echo -e "${RED}Usage: $0 <feature-branch-name>${NC}"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 feature/new-audio-system"
|
||||
echo " $0 fix/memory-leak"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
FEATURE_BRANCH="$1"
|
||||
|
||||
echo ""
|
||||
echo -e "${CYAN}═══════════════════════════════════════${NC}"
|
||||
echo -e "${CYAN} Quick Feature Merge: ${YELLOW}${FEATURE_BRANCH}${NC}"
|
||||
echo -e "${CYAN}═══════════════════════════════════════${NC}"
|
||||
echo ""
|
||||
|
||||
# Check if we're in the right directory
|
||||
if [ ! -f "CMakeLists.txt" ] || [ ! -d ".git" ]; then
|
||||
echo -e "${RED}❌ Error: Not in yaze project root!${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Save current branch
|
||||
ORIGINAL_BRANCH=$(git branch --show-current)
|
||||
echo -e "${BLUE}📍 Current branch: ${CYAN}${ORIGINAL_BRANCH}${NC}"
|
||||
|
||||
# Check for uncommitted changes
|
||||
if ! git diff-index --quiet HEAD --; then
|
||||
echo -e "${RED}❌ You have uncommitted changes. Please commit or stash first.${NC}"
|
||||
git status --short
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Fetch latest
|
||||
echo -e "${BLUE}🔄 Fetching latest from origin...${NC}"
|
||||
git fetch origin
|
||||
|
||||
# Check if feature branch exists
|
||||
if ! git show-ref --verify --quiet "refs/heads/${FEATURE_BRANCH}"; then
|
||||
echo -e "${RED}❌ Branch '${FEATURE_BRANCH}' not found locally${NC}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${BLUE}📊 Commits in ${YELLOW}${FEATURE_BRANCH}${BLUE} not in develop:${NC}"
|
||||
git log develop..${FEATURE_BRANCH} --oneline --decorate | head -10
|
||||
echo ""
|
||||
|
||||
# Step 1: Merge into develop
|
||||
echo -e "${BLUE}[1/5] Merging ${YELLOW}${FEATURE_BRANCH}${BLUE} → ${CYAN}develop${NC}"
|
||||
git checkout develop
|
||||
git pull origin develop --ff-only
|
||||
git merge ${FEATURE_BRANCH} --no-edit
|
||||
|
||||
echo -e "${GREEN}✅ Merged into develop${NC}"
|
||||
echo ""
|
||||
|
||||
# Step 2: Merge develop into master
|
||||
echo -e "${BLUE}[2/5] Merging ${CYAN}develop${BLUE} → ${CYAN}master${NC}"
|
||||
git checkout master
|
||||
git pull origin master --ff-only
|
||||
git merge develop --no-edit
|
||||
|
||||
echo -e "${GREEN}✅ Merged into master${NC}"
|
||||
echo ""
|
||||
|
||||
# Step 3: Push master
|
||||
echo -e "${BLUE}[3/5] Pushing ${CYAN}master${BLUE} to origin...${NC}"
|
||||
git push origin master
|
||||
|
||||
echo -e "${GREEN}✅ Pushed master${NC}"
|
||||
echo ""
|
||||
|
||||
# Step 4: Update and push develop
|
||||
echo -e "${BLUE}[4/5] Syncing ${CYAN}develop${BLUE} with master...${NC}"
|
||||
git checkout develop
|
||||
git merge master --ff-only
|
||||
git push origin develop
|
||||
|
||||
echo -e "${GREEN}✅ Pushed develop${NC}"
|
||||
echo ""
|
||||
|
||||
# Step 5: Delete feature branch
|
||||
echo -e "${BLUE}[5/5] Cleaning up ${YELLOW}${FEATURE_BRANCH}${NC}"
|
||||
git branch -d ${FEATURE_BRANCH}
|
||||
|
||||
# Delete remote branch if it exists
|
||||
if git show-ref --verify --quiet "refs/remotes/origin/${FEATURE_BRANCH}"; then
|
||||
git push origin --delete ${FEATURE_BRANCH}
|
||||
echo -e "${GREEN}✅ Deleted remote branch${NC}"
|
||||
fi
|
||||
|
||||
echo -e "${GREEN}✅ Deleted local branch${NC}"
|
||||
echo ""
|
||||
|
||||
# Return to original branch if it still exists
|
||||
if [ "$ORIGINAL_BRANCH" != "$FEATURE_BRANCH" ]; then
|
||||
if git show-ref --verify --quiet "refs/heads/${ORIGINAL_BRANCH}"; then
|
||||
git checkout ${ORIGINAL_BRANCH}
|
||||
echo -e "${BLUE}📍 Returned to ${CYAN}${ORIGINAL_BRANCH}${NC}"
|
||||
else
|
||||
echo -e "${BLUE}📍 Staying on ${CYAN}develop${NC}"
|
||||
fi
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}╔═══════════════════════════════════════╗${NC}"
|
||||
echo -e "${GREEN}║ 🚀 SUCCESS! 🚀 ║${NC}"
|
||||
echo -e "${GREEN}║ Feature merged and deployed ║${NC}"
|
||||
echo -e "${GREEN}╚═══════════════════════════════════════╝${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN}What happened:${NC}"
|
||||
echo -e " ✅ ${YELLOW}${FEATURE_BRANCH}${NC} → ${CYAN}develop${NC}"
|
||||
echo -e " ✅ ${CYAN}develop${NC} → ${CYAN}master${NC}"
|
||||
echo -e " ✅ Pushed both branches"
|
||||
echo -e " ✅ Deleted ${YELLOW}${FEATURE_BRANCH}${NC}"
|
||||
echo ""
|
||||
echo -e "${CYAN}Current state:${NC}"
|
||||
git log --oneline --graph --decorate -5
|
||||
echo ""
|
||||
|
||||
40
scripts/test-linux-build.sh
Executable file
40
scripts/test-linux-build.sh
Executable file
@@ -0,0 +1,40 @@
|
||||
#!/bin/bash
|
||||
# Test Linux build in Docker container (simulates CI environment)
|
||||
set -e
|
||||
|
||||
echo "🐧 Testing Linux build in Docker container..."
|
||||
|
||||
# Use same Ubuntu version as CI
|
||||
docker run --rm -v "$PWD:/workspace" -w /workspace \
|
||||
ubuntu:22.04 bash -c '
|
||||
set -e
|
||||
echo "📦 Installing dependencies..."
|
||||
export DEBIAN_FRONTEND=noninteractive
|
||||
apt-get update
|
||||
apt-get install -y \
|
||||
build-essential cmake ninja-build pkg-config gcc-12 g++-12 \
|
||||
libglew-dev libxext-dev libwavpack-dev libboost-all-dev \
|
||||
libpng-dev python3-dev libpython3-dev \
|
||||
libasound2-dev libpulse-dev libaudio-dev \
|
||||
libx11-dev libxrandr-dev libxcursor-dev libxinerama-dev libxi-dev \
|
||||
libxss-dev libxxf86vm-dev libxkbcommon-dev libwayland-dev libdecor-0-dev \
|
||||
libgtk-3-dev libdbus-1-dev git
|
||||
|
||||
echo "⚙️ Configuring build..."
|
||||
cmake -B build -G Ninja \
|
||||
-DCMAKE_BUILD_TYPE=Release \
|
||||
-DCMAKE_C_COMPILER=gcc-12 \
|
||||
-DCMAKE_CXX_COMPILER=g++-12 \
|
||||
-DYAZE_BUILD_TESTS=OFF \
|
||||
-DYAZE_BUILD_EMU=ON \
|
||||
-DYAZE_BUILD_Z3ED=ON \
|
||||
-DYAZE_BUILD_TOOLS=ON \
|
||||
-DNFD_PORTAL=ON
|
||||
|
||||
echo "🔨 Building..."
|
||||
cmake --build build --parallel $(nproc)
|
||||
|
||||
echo "✅ Linux build succeeded!"
|
||||
ls -lh build/bin/
|
||||
'
|
||||
|
||||
Reference in New Issue
Block a user