VS Code Setup

VS Code Setup for MirthSync

Looking for the MirthSync VS Code Extension?

This page covers general VS Code editor tips (extensions, settings, shortcuts). For the dedicated MirthSync VS Code Extension with IntelliSense, tree views, and connection management, see the VS Code Extension docs →.

Visual Studio Code is an excellent choice for working with MirthSync projects. This guide helps you optimize VS Code for editing Mirth Connect channels, code templates, and configurations.

Recommended Extensions

Install these extensions to enhance your MirthSync development experience:

Essential Extensions

XML Tools

• Extension ID: DotJoshJohnson.xml
• Provides: XML formatting, validation, and tree view
• Use: Format channel.xml files, validate XML structure

JavaScript (ES6) Code Snippets

• Extension ID: xabikos.JavaScriptSnippets
• Provides: JavaScript code snippets and shortcuts
• Use: Quick insertion of common JavaScript patterns in transformers

GitLens

• Extension ID: eamodio.gitlens
• Provides: Enhanced Git capabilities and history
• Use: View commit history, blame annotations, compare changes

Optional but Helpful

Prettier

• Extension ID: esbenp.prettier-vscode
• Provides: Code formatting
• Use: Auto-format JavaScript code in transformers

Error Lens

• Extension ID: usernamehw.errorlens
• Provides: Inline error highlighting
• Use: See XML and JavaScript errors immediately

Path Intellisense

• Extension ID: christian-kohler.path-intellisense
• Provides: Autocomplete for file paths
• Use: Quick navigation to related files

VS Code Settings

Create or update .vscode/settings.json in your MirthSync project:

{
  // File associations
  "files.associations": {
    "channel.xml": "xml",
    "*.xml": "xml"
  },

  // Editor settings
  "editor.formatOnSave": true,
  "editor.tabSize": 2,
  "editor.insertSpaces": true,

  // XML formatting
  "xml.format.enabled": true,
  "xml.format.splitAttributes": false,

  // JavaScript settings
  "javascript.format.enable": true,
  "javascript.suggest.autoImports": false,

  // File exclusions (optional)
  "files.exclude": {
    "**/.git": true,
    "**/.DS_Store": true
  },

  // Search exclusions
  "search.exclude": {
    "**/node_modules": true,
    "**/.git": true
  }
}

Workspace Configuration

For team consistency, commit .vscode/settings.json to your repository. This ensures all team members use the same editor settings.

Useful Keyboard Shortcuts

Navigation

• Ctrl+P (Windows/Linux) or Cmd+P (Mac) - Quick file open
• Ctrl+Shift+F - Search across all files
• Ctrl+B - Toggle sidebar
• Ctrl+ ` - Toggle terminal

Editing

• Alt+Up/Down - Move line up/down
• Shift+Alt+Up/Down - Copy line up/down
• Ctrl+D - Select next occurrence
• Ctrl+Shift+L - Select all occurrences
• Ctrl+/ - Toggle comment

Git

• Ctrl+Shift+G - Open Source Control
• Ctrl+Enter - Commit staged changes
• Ctrl+Shift+P then “Git: View History” - View commit history

Workflow Tips

1. Use the Explorer

The VS Code file explorer makes it easy to navigate your MirthSync project structure:

• Expand folders to see channels and code templates
• Right-click files for context menu options
• Use Ctrl+Click to open files in new tabs

2. Search and Replace

VS Code’s search is powerful for bulk changes:

• Ctrl+Shift+F opens search across all files
• Use regex patterns for complex searches
• Preview changes before replacing

3. Split View

Compare channels or view multiple files:

• Right-click a file tab > “Split Right”
• Drag tabs to create custom layouts
• Useful for comparing channel configurations

4. Integrated Terminal

VS Code’s integrated terminal lets you run MirthSync commands:

• Ctrl+` opens terminal
• Run ./mirthsync.sh pull, ./mirthsync.sh push, etc.
• See output directly in the editor

5. Git Integration

VS Code has excellent Git support:

• View file changes with green/red indicators
• Stage files with + button
• Write commit messages in the editor
• View diff side-by-side

Example Workflow

1. Open Project

   code /path/to/mirthsync-project

2. Pull Latest

   • Open terminal: Ctrl+`
   • Run: ./mirthsync.sh pull -s https://server:8443/api -u admin -t .

3. Edit Files

   • Navigate to channel in Explorer
   • Open channel.xml
   • Edit JavaScript transformer
   • Save: Ctrl+S

4. Review Changes

   • Click Source Control icon (or Ctrl+Shift+G)
   • Review diff for changed files
   • Stage files: Click + next to files

5. Commit

   • Write commit message
   • Press Ctrl+Enter to commit

6. Push to Mirth Connect

   • Open terminal
   • Run: ./mirthsync.sh push -s https://server:8443/api -u admin -t .

Troubleshooting

XML Not Formatting

If XML files aren’t formatting:

1. Install “XML Tools” extension
2. Check xml.format.enabled in settings
3. Right-click file > “Format Document”

JavaScript Not Highlighting

If JavaScript in XML transformers isn’t highlighted:

1. Ensure file is recognized as XML
2. JavaScript within XML should highlight automatically
3. Check files.associations in settings

Git Not Showing Changes

If Git panel doesn’t show changes:

1. Ensure folder is a Git repository (./mirthsync.sh -t . git init)
2. Check .gitignore isn’t excluding files
3. Reload window: Ctrl+Shift+P > “Reload Window”