https://github.com/mneedham/venkat

https://github.com/mneedham/venkat

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/mneedham/venkat
• Owner: mneedham
• License: mit
• Created: 2023-05-10T22:30:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T21:50:32.000Z (about 3 years ago)
• Last Synced: 2025-04-11T14:56:56.070Z (about 1 year ago)
• Language: TypeScript
• Size: 2.53 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# venkat

This is the README for the VS Code extension "venkat". 

It runs the example file up to the current line (or the selection) and displays the result of that last line in a comment after or for multi-line results below (or as info message).

It is inspired by Venkat Subramaniam's use of Textmate tooltips for [code execution results](http://blog.agiledeveloper.com/2014/10/running-in-textmate.html) which is great for presentations.

## Features

* execute selection or code up to current line

* Language support for python, javascript, typescript, ruby, java, kotlin

* supports multiline outputs

* selects result, so can be deleted or copied with a single keystroke

* show result as comment or as info message

* configurable extra languages

![](images/venkat-demo.gif)

## Requirements

An interpreter for the languages used, should be installed.

* python: python

* javascript : node

* ruby: ruby

* java: jshell -s

* kotlin: kotlin

* typescript: ts-node

* php: php -f

## Configuration

* resultAsComment : boolean, default true - insert the result as comments, otherwise show them as info message

* languages : structure for languages with entries for `extension, comment, executable, output, exit`, where output contains a `${expression}` placeholder, and exit optionally contains code to end the script execution.

Here are two examples:

```json

    "venkat.languages": {

        "python": {

            "comment": "#",

            "executable": "python",

            "extension": "py",

            "output": "print(${expression})"

        },

        "java": {

            "comment": "//",

            "executable": "jshell -s ",

            "extension": "java",

            "output": "System.out.println(${expression});",

            "exit": "/exit"

        }

    }

```