A powerful VS Code extension for managing meta-framework addons with ease
Table of Contents
Overview
The RTS Extension is a comprehensive addon manager designed specifically for meta-framework development workflows. It provides an intuitive interface within VS Code to manage, build, test, and publish multiple addons simultaneously across different workspace types, streamlining your development process.
Key Benefits
- Dual Workspace Support: Framework and Product workspace environments
- Unified Management: Control multiple addons from a single interface
- Batch Operations: Execute commands across selected addons simultaneously
- Visual Interface: Color-coded icons and intuitive tree views
- Publishing Pipeline: Integrated semantic versioning and publishing workflow
- Configurable: Customizable settings for different project needs
- NPM Integration: Advanced linking and unlinking capabilities
Features
Addon Management
- Multi-select Interface: Checkbox-based selection with visual feedback
- Smart Detection: Automatically discovers addons with package.json files
- Quick Actions: Individual addon operations via context menus
- Workspace Integration: Direct file explorer access
- Cross-workspace Support: Works in both framework and product environments
- Build: Compile and build selected addons
- Verify: Run quality checks and validation
- Link/Unlink: Manage addon dependencies with live detection
- Test Build: Execute test suites with build process
Setup & Maintenance
- Setup: Initialize project with configurable concurrency limits
- ReInit: Multiple cleanup and reinitialization options
- Version Update: Automated version management
- Cleanup: Selective cleaning of dist, declarations, or temp files
Publishing Pipeline
- Semantic Versioning: Support for patch, minor, major, and pre-release versions
- Pre-release Identifiers: Alpha, beta, RC, dev, and experimental tags
- Dry Run: Test publishing process without actual deployment
- Custom Messages: Configurable commit and publish messages
- Development Server: Configurable serve command with custom port, proxy, and environment
- Production Build: Optimized build process for products
- Environment Management: Development, production, and custom environments
- Auto-setup: Automated product initialization
Framework Integration (Product Workspace)
- NPM Linking: Link framework addons to product workspace
- Live Link Detection: Real-time monitoring of linked addons
- Framework Building: Build addons within linked framework
- Link Management: Visual interface for managing linked dependencies
Installation
From VS Code Marketplace
- Open VS Code
- Go to Extensions view (
Ctrl+Shift+X)
- Search for "RTS Extension" or "ThenRam.rts-vs-extension"
- Click Install
Manual Installation
- Download the
.vsix file from releases
- Open VS Code
- Run
Extensions: Install from VSIX... command
- Select the downloaded file
Getting Started
Prerequisites
- VS Code version 1.102.0 or higher
- Node.js and npm installed
- A workspace with appropriate structure (see Workspace Types)
Quick Setup
For Framework Workspace
- Open your project in VS Code
- Ensure meta-framework structure:
your-workspace/
├── meta-frameworks/
│ └── config/
│ └── meta/
│ └── meta.js
├── addon-1/
│ └── addon/
│ └── package.json
├── addon-2/
│ └── addon/
│ └── package.json
└── ...
For Product Workspace
- Open your product in VS Code
- Setup meta framework path:
- Click "Setup Meta Path" if prompted
- Select folder containing
meta-frameworks directory
- Extension creates
meta.txt with path reference
- Access the extension via the activity bar icon
- Select addons using checkboxes
- Execute operations from the tool panels
Workspace Types
Framework Workspace
- Structure: Contains
meta-frameworks directory directly
- Purpose: Direct addon development environment
- Features: Full access to all development, setup, and publishing tools
- Detection: Automatic when
meta-frameworks folder is found
Product Workspace
- Structure: Product development environment with external framework reference
- Purpose: Product development with framework addon integration
- Features: Product tools, framework linking, and addon building
- Configuration: Uses
meta.txt file to reference framework location
Unknown Workspace
- Condition: Workspace not recognized as framework or product
- Display: Shows setup instructions and folder opening options
- Actions: Provides guidance to configure proper workspace structure
User Interface
The extension adds a dedicated activity bar section with multiple panels based on workspace type:
- Status Messages: Clear indication of workspace issues
- Setup Actions: Quick access to configuration options
- Help Integration: Direct links to setup procedures
Select Addons Panel
- Checkbox Selection: Multi-select addons for batch operations
- Visual Indicators:
- Green folders = Selected addons
- Gray folders = Unselected addons
- Toolbar Actions:
- Refresh: Reload addon list
- Select All: Choose all available addons
- Deselect All: Clear all selections
- Clone: Clone meta-framework configuration
- Help: Open extension marketplace page
Interactive development commands with color-coded icons:
| Tool |
Description |
Features |
| Build |
Compile and build addons |
Batch processing |
| Verify |
Run quality checks |
Validation suite |
| Link |
Link dependencies |
With unlink option |
| Test Build |
Execute test suite |
Development testing |
Project initialization and maintenance:
| Tool |
Description |
Options |
| Setup |
Initialize project |
Configurable concurrency |
| ReInit |
Reinitialize project |
Multiple cleanup options |
| Update Version |
Update addon versions |
Automatic versioning |
Publishing and release management:
| Tool |
Description |
Features |
| Publish |
Release packages |
Full semantic versioning |
| Dry Run |
Test publish process |
Safe preview mode |
Product development and configuration:
| Tool |
Description |
Configuration |
| Serve |
Development server |
Port, proxy, environment |
| Build |
Production build |
Environment-specific |
| Setup |
Product initialization |
Dependency setup |
Framework integration and linking:
| Tool |
Description |
Features |
| Build |
Build framework addons |
Cross-workspace building |
| Link |
NPM link addons |
Live link detection |
| UnLink (Live) |
Remove npm links |
Real-time monitoring |
| Dev Linked Addons |
Show linked addons |
Live status updates |
Detailed Usage
Selecting Addons
- Individual Selection: Click checkboxes next to addon names
- Bulk Selection: Use toolbar buttons (Select All/Deselect All)
- Visual Feedback: Selected addons show green folder icons
- Cross-workspace: Works in both framework and product environments
Setup and Initialization
Project Setup
- Click Setup in Setup Tools
- Optionally configure concurrency limit via context menu
- Monitor terminal for progress
- Supports custom concurrent limits for optimal performance
ReInit Options
- ReInit: Complete reset and setup
- Clean Dist: Remove only distribution files
- Clean Decs: Remove only declaration files
- Clean: Remove temp files without setup
Product Development
Server Configuration
- Port: Configure development server port (default: 4200)
- Proxy: Set backend proxy URL (default: http://localhost:8000)
- Environment: Choose development/production mode
- Live Updates: Changes apply immediately to running servers
Framework Linking
- Select addons in the addon list
- Click Link in Framework Tools
- Monitor Dev Linked Addons section for status
- Use UnLink (Live) to remove links with real-time detection
Publishing Workflow
Standard Publishing
- Select addons to publish
- Click Publish in Publish Tools
- Choose version type:
- Patch: Bug fixes (1.0.0 → 1.0.1)
- Minor: New features (1.0.0 → 1.1.0)
- Major: Breaking changes (1.0.0 → 2.0.0)
- Pre-release: Pre-release versions
- Select pre-release identifier (if applicable):
- Alpha: Early development
- Beta: Feature complete
- RC: Release candidate
- Dev: Development build
- Experimental: Experimental features
- Enter commit message
- Confirm publication
Dry Run Testing
Use Dry Run to test the publishing process without actually releasing packages.
Auto-generated Files
/path/to/framework/workspace
This file is automatically created when you configure the meta framework path in a product workspace.
Context Menu Commands
Right-click on addons for additional options:
- Open in Workspace: Open addon in file explorer (Framework)
- Open Client Workspace: Open framework workspace (Product)
- Build: Build individual addon
- Verify: Verify individual addon
Troubleshooting
Common Issues
Extension Not Loading
- Cause: Missing workspace structure
- Solution: Ensure proper framework or product workspace structure
No Addons Detected
- Cause: Incorrect or missing meta.txt file
- Solution: Use "Setup Meta Path" command to reconfigure
Terminal Commands Failing
- Cause: Node.js/npm not in PATH
- Solution: Install Node.js and restart VS Code
Permission Errors
- Cause: Insufficient file system permissions
- Solution: Run VS Code with appropriate permissions
NPM Link Issues (Product Workspace)
- Cause: Symlink permissions or path issues
- Solution: Check file permissions and ensure framework path is accessible
Made with for the Admindroid Client Frameworks
Back to Top
