|
| 1 | +This extension provides comprehensive syntax highlighting for PIML (Parenthesis Intended Markup Language) files in Visual Studio Code. |
| 2 | +--- |
| 3 | + |
| 4 | +This extension provides comprehensive syntax highlighting for PIML (Parenthesis Intended Markup Language) files in Visual Studio Code. |
| 5 | + |
| 6 | +## Features |
| 7 | + |
| 8 | +- **Key Highlighting:** Recognizes and highlights PIML keys, enclosed in parentheses (e.g., `(my key)`). |
| 9 | +- **Comment Support:** Highlights single-line comments starting with `#`. |
| 10 | +- **Primitive Data Types:** |
| 11 | + - **Booleans:** `true`, `false` |
| 12 | + - **Null/Empty:** `nil` |
| 13 | + - **Numbers:** Integers and floating-point numbers (e.g., `100`, `99.99`) |
| 14 | +- **String Highlighting:** |
| 15 | + - **Single-line Strings:** Values following a key on the same line. |
| 16 | + - **Multi-line Strings:** Indented blocks of text following a key, preserving newlines and handling escaped characters. |
| 17 | + - **Escape Sequences:** Highlights common escape sequences like `\n`, `\t`, `\\`, `\(`, `\#`. |
| 18 | +- **Collection Types:** |
| 19 | + - **Arrays (Lists):** Items prefixed with `>` (e.g., `> item`). |
| 20 | + - **Sets:** Items prefixed with `>|` (e.g., `>| unique_item`). |
| 21 | + - **List of Objects:** Recognizes the `> (item_key)` syntax for lists containing objects. |
| 22 | + |
| 23 | +## Requirements |
| 24 | + |
| 25 | +Visual Studio Code version 1.x.x or higher. |
| 26 | + |
| 27 | +## Extension Settings |
| 28 | + |
| 29 | +This extension does not contribute any VS Code settings. |
| 30 | + |
| 31 | +## Known Issues |
| 32 | + |
| 33 | +Currently, there are no known issues. If you encounter any problems, please report them on the [GitHub repository](https://github.com/your-repo/piml-highlighter/issues). |
| 34 | + |
| 35 | +## Release Notes |
| 36 | + |
| 37 | +### 1.0.0 |
| 38 | + |
| 39 | +Initial release of the PIML Syntax Highlighter. This version includes comprehensive highlighting for all PIML syntax elements as defined in the PIML specification v1.1.0. |
| 40 | + |
| 41 | +## Usage |
| 42 | + |
| 43 | +1. Install the "PIML Syntax Highlighter" extension from the VS Code Marketplace. |
| 44 | +2. Open any file with a `.piml` extension. |
| 45 | +3. The PIML syntax elements will be automatically highlighted. |
| 46 | + |
| 47 | +## Development |
| 48 | + |
| 49 | +To contribute to this extension: |
| 50 | + |
| 51 | +1. Clone the repository: `git clone https://github.com/your-repo/piml-highlighter.git` |
| 52 | +2. Navigate to the project directory: `cd piml-highlighter` |
| 53 | +3. Install dependencies: `npm install` |
| 54 | +4. To package the extension: `npx vsce package` |
| 55 | +5. To install the packaged extension locally: `code --install-extension piml-highlighter-0.1.0.vsix` |
| 56 | + |
| 57 | +**Enjoy PIML highlighting in VS Code!** |
0 commit comments