Merge pull request #8 from sanjibansg/cli

feat: CLI tool for visualizing plans

Author: westonpace

.eslintrc.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'prettier', 'import'],
+  ignorePatterns: ['node_modules/', 'dist/', 'generated/'],
+  extends: ['plugin:@typescript-eslint/recommended', 'prettier'],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+    'prettier/prettier': 'error',
+    'import/order': [
+      'error',
+      {
+        'groups': [['builtin', 'external'], ['internal', 'parent', 'sibling', 'index']],
+        'newlines-between': 'always',
+      },
+    ],
+  },
+};

.eslintrc.js

@@ -1,6 +1,6 @@
 name: Lint
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   ESLint: 

.github/workflows/lint.yaml

@@ -0,0 +1,31 @@
+name: substraitJS
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Initialize and update submodules
+        run: |
+          git submodule update --init --recursive
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm run test
+

.github/workflows/test.yaml

@@ -1,6 +1,6 @@
 
 # susbtrait-js
-Typescript typings for Substrait specifications. Also provides a parser for translating substrait plans.
+Typescript typings for Substrait specifications. Also provides a parser for translating substrait plans and a CLI tool to visualize substrait plans.
 
 Substrait is cross-language specification for data compute operations, composed primarily of:
 1. a formal specification
@@ -29,6 +29,30 @@ Installation includes the following steps:
 npm ci
 npm run build
 ```
+
+## Visualization
+substrait-JS provides a CLI tool for exporting graph visualization of substrait JSON and binary plans. The tool currently uses the `--experimental-specifier-resolution` flag for module resolution. The  visualization functions are the required helper methods for the [substrait-fiddle](https://github.com/voltrondata/substrait-fiddle) tool.
+
+The tool uses [viz-js](https://github.com/mdaines/viz-js) for rendering plots on JSDOM using [Graphviz](https://graphviz.org/)'s DOT language.
+
+Plot generation includes the following steps:
+```
+// The tool currently requires NodeJS version 18.0.0 for operation
+source ~/.nvm/nvm.sh
+nvm use 18.0.0
+
+substrait  -p ../plan.json -o <output path>
+```
+
+## Testing
+Jest is used for testing the visualization functionality of the library. To run the test, we need
+to use `nvm v18.0.0`
+```
+source ~/.nvm/nvm.sh
+nvm use 18.0.0
+
+npm run test
+```
 
 ## License
 [Apache-2.0 license](https://www.apache.org/licenses/LICENSE-2.0)