Better SystemVerilog Syntax for Visual Studio Code

August 16, 2024 Β· View on GitHub

CI Visual Studio Marketplace Version GitHub License

Introduction

Welcome to Better SystemVerilog Syntax! This extension enhances your coding experience by providing advanced TextMate grammar support, specifically designed to improve SystemVerilog syntax highlighting. Our aim is to make your coding sessions more enjoyable and productive by enhancing readability and aesthetics.

showcase

Getting Started

  1. Install the Extension: You can find Better SystemVerilog Syntax in the VS Code Marketplace. Just search for it and click 'Install'.
  2. Activate Syntax Highlighting: Once installed, open any .sv or .svh file, and enjoy enhanced syntax highlighting tailored for SystemVerilog.

Supported Syntax

Here's a summary of the SystemVerilog syntax support, categorized by chapter:

ChapterTitleStatus
5Lexical conventions🟒 Implemented
6Data types🟒 Implemented
7Aggregate data types🟒 Implemented
8Classes🟒 Implemented
9Processes🟒 Implemented
10Assignment statements🟒 Implemented
11Operators and expressions🟒 Implemented
12Procedural programming statements🟒 Implemented
13Tasks and functions (subroutines)🟒 Implemented
14Clocking blocks🟒 Implemented
15Interprocess synchronization and communication🟒 Implemented
16Assertions🟒 Implemented
17CheckersπŸ”΄ Not Implemented
18Constrained random value generation🟒 Implemented
19Functional coverageπŸ”΄ Not Implemented
20Utility system tasks and system functions🟒 Implemented
21Input/output system tasks and system functions🟒 Implemented
22Compiler directives🟒 Implemented
23Modules and hierarchy🟒 Implemented
24Programs🟒 Implemented
25Interfaces🟒 Implemented
26Packages🟒 Implemented
27Generate constructsπŸ”΄ Not Implemented
28Gate-level and switch-level modelingπŸ”΄ Not Implemented
29User-defined primitivesπŸ”΄ Not Implemented
30Specify blocks🟒 Implemented
31Timing checks🟒 Implemented
32Backannotation using the standard delay formatπŸ”΄ Not Implemented
33Configuring the contents of a design🟒 Implemented
34Protected envelopesπŸ”΄ Not Implemented

Features

Enhanced Syntax Highlighting

  • Precision: SystemVerilog syntax is highlighted with unmatched accuracy, ensuring clarity and focus.
  • Robustness: Even incomplete or unconventional code structures maintain readability and aesthetics.
  • Efficiency: Minified JSON files ensure quick loading times and minimal performance overhead.

How to Contribute

Your contributions are essential for ongoing improvements! Here’s how you can help:

  • Issue Reporting: If you encounter incorrect syntax highlighting, please open an issue.
  • Pull Requests: For those looking to contribute code, especially for unimplemented chapters, feel free to submit a pull request. Be sure to include tests!

License

This project is licensed under the MIT License, meaning it’s free for personal and commercial use. For full details, see the LICENSE file.