Skip to content

feat: improve autopr template handling #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
semihpolat wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: improve autopr template handling #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion postinstall.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ async function setupStatueSSG(options = {}) {
// 5. Copy required scripts
const scriptsDir = path.join(targetDir, 'scripts');
fs.ensureDirSync(scriptsDir);
for (const script of ['generate-seo-files.js', 'run-pagefind.js']) {
for (const script of ['generate-seo-files.js', 'run-pagefind.js', 'autopr.sh','validate-contribution.sh']) {
fs.copySync(path.join(sourceDir, 'scripts', script), path.join(scriptsDir, script), { overwrite: true });
}
console.log(chalk.green('✓ scripts copied'));
Expand Down
197 changes: 134 additions & 63 deletions scripts/autopr.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ parse_args() {
# Initialize arrays
SOURCE_PATHS=()
DEST_PATHS=()
TEMP_DIRS_TO_CLEAN=()

case "$contrib_type" in
component)
Expand Down Expand Up @@ -234,36 +235,93 @@ parse_args() {
;;

template)
# Template: current dir (src/routes/, content/, site.config.js) -> templates/template-name/
# Template: current dir (src/, filtered static/, content/, site.config.js) -> templates/template-name/
if [ ! -d "src/routes" ]; then
log_error "src/routes/ directory not found in current directory"
log_error "Make sure you're in the root of a Statue site"
exit 1
fi

# Required files/directories
SOURCE_PATHS+=("src/routes")
DEST_PATHS+=("templates/$name/src/routes")
# Required: entire src directory (routes, lib, etc.)
SOURCE_PATHS+=("src")
DEST_PATHS+=("templates/$name/src")

# Optional: content directory (no filtering - user may have modified it)
if [ -d "content" ]; then
SOURCE_PATHS+=("content")
DEST_PATHS+=("templates/$name/content")
else
log_warn "content/ directory not found, skipping"
fi

# Optional: site.config.js
if [ -f "site.config.js" ]; then
SOURCE_PATHS+=("site.config.js")
DEST_PATHS+=("templates/$name/site.config.js")
else
log_warn "site.config.js not found, skipping"
fi

# Optional: static directory
# Optional: static directory (filtered - exclude files from node_modules/statue-ssg/resources)
if [ -d "static" ]; then
log_info "Found static/ directory, including in template"
SOURCE_PATHS+=("static")
DEST_PATHS+=("templates/$name/static")
log_info "Found static/ directory, filtering out default resources..."
# Get the resources path from node_modules
local resources_dir="node_modules/statue-ssg/resources"
if [ -d "$resources_dir" ]; then
# Find files in static that are NOT in resources (or are different)
local temp_static_list=$(mktemp)
local temp_found_any=0

# Find all files in static directory
while IFS= read -r -d '' static_file; do
# Get relative path from static/
local rel_path="${static_file#static/}"

# Check if same file exists in resources
local resources_file="$resources_dir/$rel_path"
if [ -f "$resources_file" ]; then
# Files exist in both - compare checksums
if ! cmp -s "$static_file" "$resources_file"; then
# Files are different, include this file
echo "$static_file" >> "$temp_static_list"
temp_found_any=1
fi
else
# File doesn't exist in resources, include it
echo "$static_file" >> "$temp_static_list"
temp_found_any=1
fi
done < <(find static -type f -print0)

if [ "$temp_found_any" -eq 1 ]; then
log_info "Found custom static files to include..."
# Create a temporary directory to hold filtered static files
local temp_static_dir=$(mktemp -d)
mkdir -p "$temp_static_dir/static"

# Copy each unique/different file to temp directory
while IFS= read -r static_file; do
local rel_path="${static_file#static/}"
local dest_dir="$temp_static_dir/static/$(dirname "$rel_path")"
mkdir -p "$dest_dir"
cp "$static_file" "$dest_dir/"
done < "$temp_static_list"

SOURCE_PATHS+=("$temp_static_dir/static")
DEST_PATHS+=("templates/$name/static")
# Clean up temp file
rm -f "$temp_static_list"
# Track temp directory for cleanup
TEMP_DIRS_TO_CLEAN+=("$temp_static_dir")
else
log_info "No custom static files found (all files match default resources)"
rm -f "$temp_static_list"
fi
else
log_warn "node_modules/statue-ssg/resources not found, including entire static/ directory"
SOURCE_PATHS+=("static")
DEST_PATHS+=("templates/$name/static")
fi
fi

BRANCH_NAME="$(generate_random_prefix)-template-${name}"
Expand All @@ -273,7 +331,7 @@ parse_args() {
;;

all)
# All: Template + custom components + custom themes -> templates/template-name/
# All: Template (entire src, filtered static, content) -> templates/template-name/
if [ ! -d "src/routes" ]; then
log_error "src/routes/ directory not found in current directory"
log_error "Make sure you're in the root of a Statue site"
Expand All @@ -282,9 +340,9 @@ parse_args() {

log_info "Bundling complete template with custom components and themes..."

# Required: routes
SOURCE_PATHS+=("src/routes")
DEST_PATHS+=("templates/$name/src/routes")
# Required: entire src directory
SOURCE_PATHS+=("src")
DEST_PATHS+=("templates/$name/src")

# Optional: content
if [ -d "content" ]; then
Expand All @@ -302,57 +360,66 @@ parse_args() {
log_warn "site.config.js not found, skipping"
fi

# Optional: static
# Optional: static directory (filtered - exclude files from node_modules/statue-ssg/resources)
if [ -d "static" ]; then
log_info "Found static/ directory, including in template"
SOURCE_PATHS+=("static")
DEST_PATHS+=("templates/$name/static")
fi

# Optional: src/lib/index.ts (component exports)
if [ -f "src/lib/index.ts" ]; then
log_info "Found src/lib/index.ts, including in template"
SOURCE_PATHS+=("src/lib/index.ts")
DEST_PATHS+=("templates/$name/src/lib/index.ts")
fi

# Optional: src/lib/index.css (styles and theme imports)
if [ -f "src/lib/index.css" ]; then
log_info "Found src/lib/index.css, including in template"
SOURCE_PATHS+=("src/lib/index.css")
DEST_PATHS+=("templates/$name/src/lib/index.css")
fi

# Bundle custom components (if they exist)
if [ -d "src/lib/components" ]; then
log_info "Found custom components, bundling into template..."
local component_count=0
while IFS= read -r -d '' component_file; do
# Get relative path from src/lib/components/
local rel_path="${component_file#src/lib/components/}"
SOURCE_PATHS+=("$component_file")
DEST_PATHS+=("templates/$name/src/lib/components/$rel_path")
component_count=$((component_count + 1))
done < <(find src/lib/components -type f -name "*.svelte" -print0)
log_info "Bundled $component_count custom component(s)"
else
log_info "No custom components directory found (src/lib/components/)"
fi

# Bundle custom themes (if they exist)
if [ -d "src/lib/themes" ]; then
log_info "Found custom themes, bundling into template..."
local theme_count=0
while IFS= read -r -d '' theme_file; do
# Get relative path from src/lib/themes/
local rel_path="${theme_file#src/lib/themes/}"
SOURCE_PATHS+=("$theme_file")
DEST_PATHS+=("templates/$name/src/lib/themes/$rel_path")
theme_count=$((theme_count + 1))
done < <(find src/lib/themes -type f -name "*.css" -print0)
log_info "Bundled $theme_count custom theme(s)"
else
log_info "No custom themes directory found (src/lib/themes/)"
log_info "Found static/ directory, filtering out default resources..."
# Get the resources path from node_modules
local resources_dir="node_modules/statue-ssg/resources"
if [ -d "$resources_dir" ]; then
# Find files in static that are NOT in resources (or are different)
local temp_static_list=$(mktemp)
local temp_found_any=0

# Find all files in static directory
while IFS= read -r -d '' static_file; do
# Get relative path from static/
local rel_path="${static_file#static/}"

# Check if same file exists in resources
local resources_file="$resources_dir/$rel_path"
if [ -f "$resources_file" ]; then
# Files exist in both - compare checksums
if ! cmp -s "$static_file" "$resources_file"; then
# Files are different, include this file
echo "$static_file" >> "$temp_static_list"
temp_found_any=1
fi
else
# File doesn't exist in resources, include it
echo "$static_file" >> "$temp_static_list"
temp_found_any=1
fi
done < <(find static -type f -print0)

if [ "$temp_found_any" -eq 1 ]; then
log_info "Found custom static files to include..."
# Create a temporary directory to hold filtered static files
local temp_static_dir=$(mktemp -d)
mkdir -p "$temp_static_dir/static"

# Copy each unique/different file to temp directory
while IFS= read -r static_file; do
local rel_path="${static_file#static/}"
local dest_dir="$temp_static_dir/static/$(dirname "$rel_path")"
mkdir -p "$dest_dir"
cp "$static_file" "$dest_dir/"
done < "$temp_static_list"

SOURCE_PATHS+=("$temp_static_dir/static")
DEST_PATHS+=("templates/$name/static")
# Clean up temp file
rm -f "$temp_static_list"
# Track temp directory for cleanup
TEMP_DIRS_TO_CLEAN+=("$temp_static_dir")
else
log_info "No custom static files found (all files match default resources)"
rm -f "$temp_static_list"
fi
else
log_warn "node_modules/statue-ssg/resources not found, including entire static/ directory"
SOURCE_PATHS+=("static")
DEST_PATHS+=("templates/$name/static")
fi
fi

BRANCH_NAME="$(generate_random_prefix)-all-${name}"
Expand Down Expand Up @@ -403,8 +470,12 @@ create_pr() {

# Cleanup function
cleanup() {
log_info "Cleaning up temporary directory..."
log_info "Cleaning up temporary directories..."
rm -rf "$temp_dir"
# Clean up any additional temp directories created during filtering
for dir in "${TEMP_DIRS_TO_CLEAN[@]}"; do
rm -rf "$dir" 2>/dev/null || true
done
}
trap cleanup EXIT

Expand Down
17 changes: 2 additions & 15 deletions scripts/validate-contribution.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,21 +238,8 @@ validate_template() {
log_error "Missing required route: [directory]/+page.svelte and +page.server.js"
fi

# Check for $lib imports (not statue-ssg)
log_info "Checking imports in route files..."
local bad_imports=0
while IFS= read -r -d '' file; do
if grep -q "from 'statue-ssg'" "$file" || grep -q 'from "statue-ssg"' "$file"; then
log_error "File uses 'statue-ssg' import instead of '\$lib': $(basename "$file")"
log_error " Change: import { Component } from 'statue-ssg'"
log_error " To: import { Component } from '\$lib'"
bad_imports=$((bad_imports + 1))
fi
done < <(find "$routes_dir" \( -name "*.svelte" -o -name "*.js" \) -print0 2>/dev/null)

if [[ $bad_imports -eq 0 ]]; then
log_success "All route files use '\$lib' imports"
fi
# Note: statue-ssg imports are allowed in templates (user projects use them)
# Templates may contain either $lib or statue-ssg imports depending on context

# Check for content directory
if [[ -d "$template_dir/content" ]]; then
Expand Down
Loading