Scripts and Tools

Comprehensive documentation for all scripts and tools in the monorepo

Scripts and Tools

This section contains comprehensive documentation for all scripts and tools available in our monorepo. These tools help with development, building, maintenance, and automation tasks.

Available Documentation

Angular Component Management - Automated component separation and barrel management
Build Scripts - Comprehensive build automation for libraries and applications
Cache Monitoring - NX cache health monitoring and repair
Cleanup and Maintenance - File cleanup, branch management, and maintenance tools
Development Utilities - Development tools, debugging, and code generation
Shell Scripts - System-level scripts, environment setup, and deployment tools

Quick Start

For the most common tasks, see the Scripts Index page with quick commands and workflows.

sal-component-manager.js libs/scroll-trigger/src/lib/components/ # Fix barrel export issues node tools/scripts/smart-barrel-manager.js libs/ux-test-lib/src/lib/components/ --create-nested

Building

# Build everything
node tools/scripts/build-scripts/build-all.js

# Build specific library
node tools/scripts/build-scripts/build-libs.js core-types

# Build specific application
node tools/scripts/build-scripts/build-apps.js docs-angular

Cache Management

# Check cache health
node tools/scripts/cache-monitor.js

# Fix cache issues
node tools/scripts/cache-monitor.js --fix

Cleanup

# Analyze unused files
node tools/scripts/cleanup-unused-files.js --dry-run

# Clean old branches
./tools/scripts/cleanup-branches.sh

📁 Script Categories

🎯 Angular Component Management

Purpose: Automate component separation and barrel export management

Key Scripts:

universal-component-manager.js - Ultimate tool for complete component management
smart-barrel-manager.js - Super intelligent barrel export management
angular-component-separator.js - Single component processing
angular-component-separator-batch.js - Batch component processing
update-barrel-exports.js - Basic barrel export updates

Quick Commands:

# Complete refactoring
node tools/scripts/universal-component-manager.js path/to/components/

# Fix barrel exports
node tools/scripts/smart-barrel-manager.js path/to/components/ --create-nested

🏗️ Build Scripts

Purpose: Comprehensive build automation for the NX monorepo

Key Scripts:

build-all.js - Unified build process for everything
build-libs.js - Library build with dependency resolution
build-apps.js - Application build with multiple strategies
clean-dist.js - Clean build outputs
copy-lib.js - Fallback library build method

Quick Commands:

# Build everything
node tools/scripts/build-scripts/build-all.js

# Build libraries only
node tools/scripts/build-scripts/build-libs.js

# Build applications only
node tools/scripts/build-scripts/build-apps.js

🔍 Cache Monitoring

Purpose: Monitor and maintain NX cache health

Key Scripts:

cache-monitor.js - Advanced cache monitoring and repair
check-nx-cache-health.sh - Quick cache health check

Quick Commands:

# Check cache health
node tools/scripts/cache-monitor.js

# Fix cache issues
node tools/scripts/cache-monitor.js --fix

🧹 Cleanup and Maintenance

Purpose: Maintain clean and optimized monorepo

Key Scripts:

cleanup-unused-files.js - Detect and remove unused files
cleanup-executors.js - Remove deprecated migration scripts
cleanup-branches.sh - Clean up old local branches

Quick Commands:

# Analyze unused files
node tools/scripts/cleanup-unused-files.js --dry-run

# Clean old branches
./tools/scripts/cleanup-branches.sh

🛠️ Development Utilities

Purpose: Development tools, debugging, and code generation

Key Scripts:

debug-tools.js - Theme system debugging utilities
generate-theme-utilities.js - Generate theme utility classes
update-imports.js - Update import paths across codebase
extract-types.js - Extract and organize TypeScript types

Quick Commands:

# Generate theme utilities
node tools/scripts/generate-theme-utilities.js

# Update import paths
node tools/scripts/update-imports.js

# Debug theme issues
node tools/scripts/debug-tools.js

🐚 Shell Scripts

Purpose: System-level automation and environment setup

Key Scripts:

build-docs-angular.sh - Smart build for docs-angular
build-nx.sh - Reliable NX build script
pre-dev-setup.sh - Pre-development environment setup
migrate-theme-system.sh - Theme system migration

Quick Commands:

# Build docs-angular
./tools/scripts/build-docs-angular.sh

# Setup development environment
./tools/scripts/pre-dev-setup.sh

🎯 Common Workflows

Daily Development

# 1. Check cache health
node tools/scripts/cache-monitor.js

# 2. Build libraries
node tools/scripts/build-scripts/build-libs.js

# 3. Build applications
node tools/scripts/build-scripts/build-apps.js

Component Refactoring

# 1. Preview changes
node tools/scripts/universal-component-manager.js path/to/components/ --dry-run

# 2. Apply changes
node tools/scripts/universal-component-manager.js path/to/components/

# 3. Fix barrel exports
node tools/scripts/smart-barrel-manager.js path/to/components/ --create-nested

Maintenance Tasks

# 1. Analyze unused files
node tools/scripts/cleanup-unused-files.js --dry-run

# 2. Clean unused files
node tools/scripts/cleanup-unused-files.js

# 3. Clean old branches
./tools/scripts/cleanup-branches.sh

Troubleshooting

# 1. Check cache health
node tools/scripts/cache-monitor.js --report

# 2. Fix cache issues
node tools/scripts/cache-monitor.js --fix

# 3. Clean and rebuild
node tools/scripts/build-scripts/clean-dist.js
node tools/scripts/build-scripts/build-all.js --skip-nx-cache

🔧 Configuration

Environment Variables

# Cache configuration
export NX_CACHE_DIRECTORY=/tmp/nx-cache

# Build configuration
export NODE_ENV=development

Script Permissions

# Make shell scripts executable
chmod +x tools/scripts/*.sh

# Make Node.js scripts executable
chmod +x tools/scripts/*.js

📊 Script Features Comparison

Feature	Component Mgmt	Build Scripts	Cache Monitor	Cleanup	Dev Utils	Shell Scripts
Automation	✅	✅	✅	✅	✅	✅
Error Recovery	✅	✅	✅	✅	❌	❌
Dry Run Mode	✅	❌	✅	✅	✅	❌
Progress Tracking	✅	✅	✅	✅	❌	❌
Backup Creation	❌	❌	❌	✅	❌	❌
Configuration	✅	✅	✅	✅	✅	✅

🐛 Common Issues and Solutions

Permission Issues

# Fix script permissions
chmod +x tools/scripts/*.sh
chmod +x tools/scripts/*.js

Cache Issues

# Check and fix cache
node tools/scripts/cache-monitor.js --fix

Build Issues

# Clean and rebuild
node tools/scripts/build-scripts/clean-dist.js
node tools/scripts/build-scripts/build-all.js --skip-nx-cache

Import Issues

# Update import paths
node tools/scripts/update-imports.js

📝 Best Practices

Always Use Dry Run First: Test scripts with --dry-run when available
Check Cache Health: Monitor cache health regularly
Clean Before Building: Clean dist directory before major builds
Use Appropriate Scripts: Choose the right tool for the task
Monitor Progress: Use scripts with progress tracking for long operations
Create Backups: Use scripts that create backups for destructive operations

🤝 Contributing

To improve scripts and tools:

Add Error Handling: Improve error detection and recovery
Enhance Reporting: Add better progress tracking and reporting
Add Configuration: Make scripts more configurable
Improve Safety: Add more safety checks and validations
Add Tests: Create tests for critical scripts
Update Documentation: Keep documentation current with script changes

📄 License

All scripts and tools are part of the project and follow the same license terms.

For detailed information about each category of scripts, see the individual documentation pages linked above.