Files
rspade_system/app/RSpade/man/config_rsx.txt
root f6fac6c4bc Fix bin/publish: copy docs.dist from project root
Fix bin/publish: use correct .env path for rspade_system
Fix bin/publish script: prevent grep exit code 1 from terminating script

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-21 02:08:33 +00:00

171 lines
5.7 KiB
Plaintext
Executable File

NAME
config/rsx.php - RSX framework configuration file
SYNOPSIS
Configuration for all RSX framework features in a single location
DESCRIPTION
The config/rsx.php file centralizes all RSX framework configuration.
Unlike Laravel which spreads configuration across multiple files,
RSX consolidates framework settings into one place for easier management.
This configuration controls:
- Manifest building and caching
- Bundle compilation settings
- Console debug output
- Browser error logging
- Development mode features
- Path configurations
STRUCTURE
The configuration file is organized into logical sections:
manifest Manifest system settings
bundles Bundle compilation configuration
console_debug Debug output configuration
log_browser_errors Client-side error logging
development Development mode features
paths Directory path overrides
MANIFEST CONFIGURATION
'manifest' => [
'cache_enabled' => env('RSX_MANIFEST_CACHE', true),
'auto_rebuild' => env('RSX_MANIFEST_AUTO_REBUILD', true),
'scan_directories' => ['/rsx', '/system/app/RSpade'],
'cache_path' => storage_path('rsx-build/manifest_data.php'),
]
cache_enabled Enable manifest caching in production
auto_rebuild Auto-rebuild on file changes (dev only)
scan_directories Directories to scan for RSX files
cache_path Where to store compiled manifest
BUNDLE CONFIGURATION
'bundles' => [
'minify' => env('RSX_BUNDLE_MINIFY', false),
'source_maps' => env('RSX_BUNDLE_SOURCEMAPS', true),
'cache_path' => storage_path('rsx-build/bundles'),
'aliases' => [
'jquery' => 'node_modules/jquery/dist/jquery.js',
'lodash' => 'node_modules/lodash/lodash.js',
],
]
minify Minify JavaScript/CSS in bundles
source_maps Generate source maps for debugging
cache_path Directory for compiled bundles
aliases Module aliases for bundle includes
CONSOLE DEBUG CONFIGURATION
'console_debug' => [
'enabled' => env('CONSOLE_DEBUG_ENABLED', true),
'outputs' => [
'cli' => false, # stderr in CLI mode
'web' => true, # Browser console
'ajax' => true, # AJAX responses
'laravel_log' => false, # Laravel log file
],
'filter_mode' => 'all', # all|whitelist|blacklist|specific
'specific_channel' => null,
'whitelist' => [],
'blacklist' => [],
'include_benchmark' => false,
'include_location' => false,
'include_backtrace' => false,
]
See: php artisan rsx:man console_debug for detailed documentation
BROWSER ERROR LOGGING
'log_browser_errors' => env('LOG_BROWSER_ERRORS', false),
When enabled, JavaScript errors are automatically sent to Laravel log.
Includes stack traces, source locations, and user agent information.
DEVELOPMENT FEATURES
'development' => [
'show_queries' => env('RSX_SHOW_QUERIES', false),
'log_manifest_builds' => env('RSX_LOG_MANIFEST', false),
'verbose_errors' => env('RSX_VERBOSE_ERRORS', true),
]
show_queries Log all database queries
log_manifest_builds Log manifest rebuild events
verbose_errors Show detailed error information
PATH CONFIGURATION
'paths' => [
'rsx_root' => base_path('rsx'),
'build_dir' => storage_path('rsx-build'),
'temp_dir' => storage_path('rsx-tmp'),
'locks_dir' => storage_path('rsx-locks'),
]
rsx_root RSX application root directory
build_dir Compiled assets directory
temp_dir Temporary files directory
locks_dir Lock files directory
ENVIRONMENT VARIABLES
Most settings can be overridden with environment variables:
RSX_MANIFEST_CACHE=false Disable manifest caching
RSX_BUNDLE_MINIFY=true Enable minification
CONSOLE_DEBUG_ENABLED=true Enable console_debug
LOG_BROWSER_ERRORS=true Log browser errors
RSX_SHOW_QUERIES=true Show database queries
EXAMPLES
Enable all debug features for development:
CONSOLE_DEBUG_ENABLED=true
CONSOLE_DEBUG_CLI=true
LOG_BROWSER_ERRORS=true
RSX_VERBOSE_ERRORS=true
RSX_SHOW_QUERIES=true
Production settings:
RSX_MANIFEST_CACHE=true
RSX_MANIFEST_AUTO_REBUILD=false
RSX_BUNDLE_MINIFY=true
CONSOLE_DEBUG_ENABLED=false
LOG_BROWSER_ERRORS=false
Filter console_debug to specific channel:
CONSOLE_DEBUG_FILTER=AUTH
CONSOLE_DEBUG_BENCHMARK=true
RSX VS LARAVEL
Laravel configuration:
- Spread across config/*.php files
- Service providers define features
- Package configuration published separately
- Environment files control everything
RSX configuration:
- Centralized in config/rsx.php
- Manifest controls discovery
- Framework features built-in
- Environment variables for overrides
TROUBLESHOOTING
Manifest not rebuilding:
- Check RSX_MANIFEST_AUTO_REBUILD=true
- Clear cache: php artisan rsx:clean
- Manual rebuild: php artisan rsx:manifest:build
Console_debug not showing:
- Check CONSOLE_DEBUG_ENABLED=true
- Verify filter settings
- Use php artisan rsx:debug --console-log
Bundles not updating:
- Clear bundle cache in storage/rsx-build/bundles
- Check file permissions on build directories
SEE ALSO
console_debug - Debug output system documentation
manifest_api - Manifest system API reference
bundle_api - Bundle compilation documentation