netlistsvg: example of how to generate a .svg from a .v file

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>

Author: oharboe

.gitignore

@@ -5,3 +5,5 @@ build/
 .metals/
 .vscode/
 __pycache__/
+node_modules/
+

BUILD

@@ -1,6 +1,9 @@
+load("@aspect_rules_js//js:defs.bzl", "js_binary")
 load("@bazel-orfs-pip//:requirements.bzl", "requirement")
+load("@npm//:defs.bzl", "npm_link_all_packages")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 load("//:eqy.bzl", "eqy_test")
+load("//:netlistsvg.bzl", "netlistsvg")
 load("//:openroad.bzl", "get_stage_args", "orfs_floorplan", "orfs_flow", "orfs_macro", "orfs_run")
 load("//:ppa.bzl", "orfs_ppa")
 load("//:sweep.bzl", "orfs_sweep")
@@ -467,3 +470,21 @@ yosys(
         "read_verilog $(location alu.v); proc; write_json $(location alu.json)",
     ],
 )
+
+npm_link_all_packages(name = "node_modules")
+
+js_binary(
+    name = "netlistsvg",
+    data = [
+        "//:node_modules/netlistsvg",
+        "//:node_modules/yargs",
+    ],
+    entry_point = "main.js",
+    visibility = ["//visibility:public"],
+)
+
+netlistsvg(
+    name = "alu_svg",
+    src = "alu.json",
+    out = "alu.svg",
+)

MODULE.bazel

@@ -4,6 +4,31 @@ module(
     compatibility_level = 1,
 )
 
+bazel_dep(name = "aspect_rules_js", version = "2.1.3")
+
+####### Node.js version #########
+# By default you get the node version from DEFAULT_NODE_VERSION in @rules_nodejs//nodejs:repositories.bzl
+# Optionally you can pin a different node version:
+bazel_dep(name = "rules_nodejs", version = "6.3.0")
+
+node = use_extension("@rules_nodejs//nodejs:extensions.bzl", "node")
+node.toolchain(node_version = "16.14.2")
+#################################
+
+npm = use_extension("@aspect_rules_js//npm:extensions.bzl", "npm")
+npm.npm_translate_lock(
+    name = "npm",
+    pnpm_lock = "//:pnpm-lock.yaml",
+    #verify_node_modules_ignored = "//:.bazelignore",
+)
+use_repo(npm, "npm")
+
+pnpm = use_extension("@aspect_rules_js//npm:extensions.bzl", "pnpm")
+
+# Allows developers to use the matching pnpm version, for example:
+# bazel run -- @pnpm --dir /home/runner/work/rules_js/rules_js install
+use_repo(pnpm, "pnpm")
+
 http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
 http_archive(

MODULE.bazel.lock

@@ -0,0 +1,15 @@
+// netlistsvg is a dependency installed with npm
+// call netlistsvg module with the command line arguments
+var netlistsvg = require('netlistsvg/bin/netlistsvg.js');
+
+var yargs = require('yargs');
+
+var argv = yargs
+.demand(1)
+.usage('usage: $0 input_json_file [-o output_svg_file] [--skin skin_file] [--layout elk_json_file]')
+.argv;
+
+// print cwd
+console.log(process.cwd());
+
+netlistsvg.main(argv._[0], argv.o, argv.skin, argv.layout);

main.js

@@ -0,0 +1,16 @@
+"""netlistsvg utility function"""
+
+load("@aspect_rules_js//js:defs.bzl", "js_run_binary")
+
+def netlistsvg(name, src, out):
+    """Run netlistsvg on the given source file"""
+    js_run_binary(
+        name = name,
+        srcs = [src],
+        outs = [out],
+        chdir = native.package_name(),
+        # $(location :alu) does not work as the cwd of the nodejs binary is not the
+        # workspace root
+        args = [src, "-o", out],
+        tool = "@bazel-orfs//:netlistsvg",
+    )

netlistsvg.bzl

@@ -0,0 +1,9 @@
+{
+    "name": "bazel-orfs",
+    "version": "0.0.1",
+    "description": "A project for Bazel ORFS",
+    "dependencies": {
+      "netlistsvg": "^1.0.2",
+      "yargs": "^17.0.1"
+    }
+}