impex-plugin-ycc README

ImpEx Syntax Highlighter & Formatter for VS Code

This VS Code plugin provides syntax highlighting, text decoration, and automatic formatting for ImpEx files, improving readability and productivity when working with this file type.

Features

1. Keyword Highlighting

• Keywords such as INSERT, UPDATE, INSERT_UPDATE, and REMOVE are highlighted in orange.
• Automatically detects ImpEx block headers.

2. Variable Decoration

• Variables defined with $, such as $storeUid or $currencies, are displayed in light purple.

3. Header Column Decoration

• Header columns within an ImpEx block are highlighted in blue.
• Content inside parentheses () and square brackets [] is not highlighted.
• Clicking on a header column automatically highlights the corresponding data column.

4. Comment Highlighting

• Comments starting with # are displayed in gray.

5. String Decoration

• Text enclosed in double quotes " " is displayed in green.

6. Punctuation Decoration

• Semicolons ;, square brackets [], and parentheses () are displayed in orange to clearly distinguish the block structure.

7. Dynamic Header Highlighting

• Clicking on a data cell highlights its corresponding header.
• Clicking on a header highlights the entire data column.

8. Automatic Formatter

• Applying the format command aligns columns within ImpEx blocks.
• Preserves comments and variables intact.
• Improves readability for long ImpEx blocks.

ImpEx File Example

# Sample comment
$currencies=USD,EUR
INSERT_UPDATE BaseStore; uid[unique = true]; catalogs(id); currencies(isocode)[default = $currencies]; net[default = $net]

$currencies → Purple variable
INSERT_UPDATE → Orange keyword
BaseStore, uid, catalogs → Blue columns
[unique = true], (id) → Not highlighted
; → Orange punctuation
Comments → Gray

Installation

1.- Open VS Code.
2.- Go to Extensions and search for ImpEx Syntax Highlighter.
3.- Install it and restart VS Code if necessary.

Usage

• Open any .impex file.

• The plugin will automatically apply:

  • Syntax highlighting
  • Column formatting
  • Variable, string, and punctuation decoration
  • Dynamic header highlighting on click

• To manually format a file:

  • Use Shift + Alt + F
    or Right-click > Format Document in VS Code

Support

If you encounter any bugs or have suggestions, please open an issue or contact:
📧 y.camarasa@gmail.com

Credits

Yolanda Camarasa Caamaño

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines

Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

• Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
• Toggle preview (Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
• Press Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!