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