sharedo-vscode-extension

⚠️ Important Disclaimer

This is a community-developed, unofficial extension for ShareDo.

NOT FOR PRODUCTION USE

• This extension is provided "as-is" without warranties
• Not officially supported by ShareDo or Nintex
• Use at your own risk
• No guarantees of compatibility or stability
• May contain bugs or security vulnerabilities

For production environments, please use official ShareDo tools and interfaces.

Features

Current Version (v0.12.2):

• 🚀 Unified HLD System (NEW!)

  • MAJOR UPGRADE! Command consolidation: 16 commands reduced to 3 unified commands
  • NEW! Generate HLD Document - Universal generator with format/stakeholder selection
  • NEW! Preview HLD Document - Enhanced preview with live updates
  • NEW! Configure HLD Settings - Unified configuration management
  • IMPROVED! 80% reduction in code duplication with enhanced performance
  • MAINTAINED! Full backward compatibility with legacy commands

• 📋 HLD Generation Features

  • Multiple Formats: Markdown, HTML, and DOCX output
  • Stakeholder Views: Business Analyst, System Admin, Support, Trainer, and Full documentation
  • Batch Processing: Generate HLD for multiple work types simultaneously
  • Template System: Role-based filtering and custom templates
  • Smart Configuration: Intelligent dependency analysis and cross-references

• 🎨 Enhanced User Experience

  • NEW! Visual format selection with icons and descriptions
  • NEW! Progress tracking for complex operations
  • NEW! Contextual error messages with suggested solutions
  • NEW! Status bar integration with real-time feedback
  • IMPROVED! Setup wizard for first-time users

• 📁 File Management

  • Upload and download IDE files (Cross-platform Windows/Mac/Linux support)
  • Batch file operations with progress tracking
  • File conflict resolution and validation
  • Enhanced error handling with context-aware messages

• 🔐 Work-Type Permission Management

  • Delete permissions
  • Apply to ALL derived types
  • Bulk permission operations

• 🎯 Work-Type Role Permissions

  • Delete role permissions
  • Apply to all derived types
  • Copy permissions between work types

• 🔧 Developer Experience

  • Enhanced error handling and logging for better debugging
  • Structured logging format with module and function names
  • Cross-platform path handling utilities
  • Better debugging information with caller context

HLD Command Migration Guide

The extension now features a simplified, unified command structure! All legacy HLD commands continue to work but are now marked as "(Legacy)" for easy identification.

New Unified Commands:

• 🚀 Generate HLD Document (sharedo.hld.generate)

  • Replaces 10+ individual generation commands
  • Interactive format selection (Markdown, HTML, DOCX)
  • Stakeholder role filtering (Business Analyst, System Admin, etc.)
  • Batch processing support

• 🔍 Preview HLD Document (sharedo.hld.preview)

  • Replaces preview and Playwright preview commands
  • Live preview with format switching
  • Auto-refresh capabilities

• ⚙️ Configure HLD Settings (sharedo.hld.configure)

  • Replaces configuration, cache, and performance commands
  • Unified settings management
  • Performance monitoring dashboard

Legacy Command Compatibility:

All existing commands continue to work and are automatically routed to the new unified system:

• Generate Business Analyst HLD (Legacy) → Routes to unified generator with BA preset
• Generate System Admin HLD (Legacy) → Routes to unified generator with SysAdmin preset
• Clear HLD Cache (Legacy) → Routes to unified configuration cache management
• And all other legacy commands maintain full functionality

Recommendation: Start using the new unified commands for the best experience, while legacy commands remain available for backward compatibility.

Requirements

• VS Code: Version 1.76.0 or higher
• ShareDo Server: Access to a ShareDo platform server
• Node.js: For development (v16.x or higher recommended)

Known Issues

Fixed in v0.8.0:

• ✅ Windows path handling issues when publishing files to ShareDo
• ✅ Cross-platform compatibility improvements
• ✅ Enhanced error logging with caller information

Current Issues:

• Some UI elements may not scale properly on high-DPI displays
• Large file uploads may timeout on slower connections

Pre-Release, please raise issue here: https://github.com/Alter-Igor/sharedo-vscode-extension/issues

Compatibility

• VS Code: 1.76.0 or higher
• Operating Systems: Windows, macOS, Linux
• ShareDo: Compatible with ShareDo platform servers

Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
3. Search for "ShareDo VSCode Extension"
4. Click Install
5. New! Run the Setup Wizard: Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and search for "ShareDo: Setup Wizard"

From VSIX File (Manual Installation)

1. Download the .vsix file from GitHub Releases
2. Open VS Code
3. Go to Extensions (Ctrl+Shift+X / Cmd+Shift+X)
4. Click the ... menu at the top of the Extensions panel
5. Select "Install from VSIX..."
6. Browse to the downloaded .vsix file and select it

Quick Start

1. Use the Setup Wizard (Ctrl+Shift+P → "ShareDo: Setup Wizard") for guided configuration
2. Or manually connect using "ShareDo: Connect to ShareDo Server"
3. Your ShareDo resources will appear in the Explorer panel under "ShareDo Servers"

User Experience Improvements

v0.8.1+ Enhancements:

• 🧙‍♂️ Setup Wizard: Guided first-time setup with validation and testing
• 📊 Progress Indicators: Visual feedback for file uploads, downloads, and API operations
• 💬 Smart Notifications: Context-aware messages with suggested actions
• 🔗 Connection Status: Real-time connection status in the status bar
• 📈 Operation Results: Detailed success/failure reporting for batch operations
• 🛠️ Better Error Messages: User-friendly errors with troubleshooting suggestions
• ✅ Bug Fixes: Resolved extension activation issues and command conflicts

Release Notes

[0.8.0] - 2025-07-25

Added

• Enhanced error handling and logging throughout codebase
• Cross-platform path handling for Windows/Mac/Linux compatibility
• Better debugging information with caller context

Fixed

• Windows file path issues when publishing to ShareDo servers
• Malformed URLs due to backslash/forward slash path differences
• URL encoding for special characters in file paths

Changed

• Improved logging format for better traceability
• Standardized path handling across all file operations

Enjoy!