Vscode extension

test/config_test.dart

@@ -72,4 +72,13 @@ void main() async {
       deleteTemporaryDump(dumpName);
     });
   }
+
+  test('should update the vscode readme version', () async {
+    const version = Config.version;
+
+    final file = File('vs_code/README.md');
+    final contents = await file.readAsString();
+
+    expect(contents.contains(version), true);
+  });
 }

vs_code/.eslintrc.json

@@ -0,0 +1,24 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off"
+    },
+    "ignorePatterns": [
+        "out",
+        "dist",
+        "**/*.d.ts"
+    ]
+}

vs_code/.gitignore

@@ -0,0 +1,5 @@
+out
+dist
+node_modules
+.vscode-test/
+*.vsix

vs_code/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint"
+	]
+}

vs_code/.vscode/launch.json

@@ -0,0 +1,34 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/test/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

vs_code/.vscode/settings.json

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off"
+}

vs_code/.vscode/tasks.json

@@ -0,0 +1,20 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}

vs_code/.vscodeignore

@@ -0,0 +1,10 @@
+.vscode/**
+.vscode-test/**
+src/**
+.gitignore
+.yarnrc
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/.eslintrc.json
+**/*.map
+**/*.ts

vs_code/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+
+All notable changes to the "rohd" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+- Initial release

vs_code/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (C) 2021-2023 Intel Corporation
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

vs_code/README.md

@@ -0,0 +1,30 @@
+# Visual Studio Code ROHD Snippets
+
+This Visual Studio Code extension provides commonly used ROHD framework snippets, facilitating usage of auto-complete features.
+
+## What's ROHD
+
+ROHD (pronounced as "road") is a framework for describing and verifying hardware using the Dart programming language. For more information about ROHD, please visit [https://intel.github.io/rohd-website/](https://intel.github.io/rohd-website).
+
+## Features
+
+Currently, this extension follows the conventions in ROHD [v0.5.1](https://github.com/intel/rohd/releases/tag/v0.5.1). It suggests auto-completions when you start typing the prefixes as shown in the table below:
+
+|  Name  |  Prefix  |  Description  |
+|  :---:  |  :---:  |  :--:  |
+|  ROHD Counter Example | `example`  | Generates an ROHD Counter Example |
+|  Module  |  `module` or `mod` or `Mod` or `Module`  | Creates an ROHD Module Class |
+|  Sequential Logic  |  `seq` or `sequential` or `Seq`  | Builds an ROHD Sequential Logic |
+|  Combinational Logic  |  `comb`  | Constructs an ROHD Combinational Logic |
+| Simple Assign (<=)  | `assign` | Demonstrates an example of the Assignment Operator used outside combinational or sequential contexts |
+| Conditional Assign (<) | `assign` | Demonstrates an example of the Assignment Operator used within combinational or sequential contexts |
+| If | `if` or `If` | Constructs an 'IF' conditional block for use within sequential or combinational contexts |
+| Case | `case` or `Case` | Creates a 'CASE' conditional block for use within sequential or combinational contexts |
+| CaseZ | `caseZ` or `CaseZ` | Builds a 'CASEZ' conditional block for use within sequential or combinational contexts |
+| Simulation | `sim` or `Simulator` or `simulation` | Templates a signal Simulation |
+| Finite State Machine  | `fsm` or `FSM` | Creates a Finite State Machine template example for simplified FSM usage |
+| ROHD-VF Testbench | `vf` or `tb` or `testbench` | Creates a ROHD-VF template |
+
+## Reporting Issues
+
+Issues on either ROHD or VSCode snippets should be filed in [https://github.com/intel/rohd/issues](https://github.com/intel/rohd/issues).