You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+46-24Lines changed: 46 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,44 +2,50 @@
2
2
3
3
This is the official VSCode extension for the Lightning Blits framework.
4
4
5
-
It provides syntax highlighting, code completion, error checking, and other features to make working with Blits easier.
5
+
Blits is a **lightweight, high-performance frontend framework** for **Lightning 3 applications**. This VSCode extension enhances the development experience by providing **rich language support** for Blits templates, components, and the `.blits` file format.
6
6
7
7
## Features
8
8
9
-
### Syntax Highlighting
9
+
### **1. Syntax Highlighting**
10
+
- Full support for Blits template syntax inside JavaScript and TypeScript files.
11
+
- Dedicated syntax highlighting for `.blits` files, including **script and template sections**.
10
12
11
-
This extension enables syntax highlighting for the template in your Blits components.
13
+
### **2. Code Completion (IntelliSense)**
14
+
- Auto-suggestions for Blits **component names, attributes, and built-in directives**.
15
+
- Supports both built-in and custom components inside **template strings and `.blits` files**.
16
+
- Provides **context-aware** suggestions based on cursor position.
12
17
13
-
### Code Completion
18
+
### **3. Commenting Support**
19
+
- Enables **HTML-style commenting/uncommenting** for template sections.
20
+
- Uses `<!-- -->` for templates and `//` for script sections.
14
21
15
-
The extension offers context-aware IntelliSense for the Blits framework, focusing specifically on component properties and names within template definitions. For code outside of these templates, the extension defers to VSCode's built-in IntelliSense.
22
+
### **4. Custom `.blits` File Support**
23
+
- Full **language support** for `.blits` files:
24
+
-**Syntax highlighting**
25
+
-**IntelliSense** for template and script sections
26
+
-**Signature help** for component methods
27
+
-**Hover information** for component props and attributes
28
+
-**Error diagnostics** for template syntax
16
29
17
-
The code completion feature is designed to avoid suggesting duplicate component properties, providing a cleaner and more efficient coding experience.
30
+
### **5. Code Formatting**
31
+
- Automatic formatting of **Blits template strings** inside JS/TS files.
The extension introduces an enhanced commenting feature for the XML-style templates within Blits components. Integrated seamlessly with the standard VSCode commenting shortcuts, this feature activates when the cursor is positioned within a Blits template or when a block of code within a template is selected. It enables rapid toggling of HTML-style comments (`<!--` and `-->`) without the need for manual insertion.
22
-
23
-
### Format-on-Save
24
-
25
-
The extension includes an auto-format feature for the template definitions in Blits components. This feature enhances the development experience by automatically formatting the templates upon saving the file.
26
-
27
-
When you save a Blits component file (.js or .ts), the extension automatically formats the template sections within the file. This ensures that your templates are consistently styled and easy to read. The formatting applies only to the template parts of your file, leaving the rest of your JavaScript or TypeScript code unchanged.
28
-
29
-
You can disable this feature by setting the `blits.autoFormat` configuration option to `false`.
35
+
You can disable the auto-formatting feature by setting the `blits.autoFormat` configuration option to `false`.
30
36
31
37
The extension provides several configuration options to customize the auto-formatting feature. These settings allow you to tailor the formatting to your coding style and preferences.
This extension is **open-source**. If you encounter issues or have feature requests, please visit the [GitHub Repository](https://github.com/lightning-js/blits-vscode-extension) and submit an issue or contribute to the codebase.
91
+
92
+
---
93
+
94
+
**Enhance your Blits development experience today! 🚀**
0 commit comments