hanskre / markdown-execute Goto Github PK

View Code? Open in Web Editor NEW

8.0 2.0 0.0 2.88 MB

VSCode Extension to execute commands directly from Markdown

License: MIT License

TypeScript 91.07% JavaScript 8.93%

markdown-execute's Introduction

makrdown-execute

VSCode Extension which allows you to execute code from markdown files.

Detects code blocks in your markdown-files starting with:
- ```sh
- ```bash
- ```js
- ```python
Adds 'Execute command in terminal as Shell-Script', 'Execute command in terminal as NodeJs-Script', 'Execute command in terminal as python-Script' label.
Clicking on the label executes code-block until the closing ticks ``` in the terminal as Shell, NodeJs or Python script.

Alternatively, use cmd+f1 (mac) / ctrl+f1 (windows) shortcut to execute current selection.

Features

Execute code blocks in terminal

Execute Selection

Select code and either use shortcut cmd+f1 (mac) / ctrl+f1 (windows) to execute or open the VSCode command palette and type markdown execute to find the command:

Side By Side view

If you interact with terminal very often, I recomment using the terminal in editor area side by side in split view.:

Extension Settings

This extension contributes the following settings:

markdown-execute.executeInSsh: enable/disable execution of code in a SSH session. If disabled and active terminal is running a SSH session, a new terminal is used as target for commands.
markdown-execute.executeSelection: Shortcut to execute selection. Defaults to cmd+f1 (mac) / ctrl+f1 (windows).

Backlog

Analyse and fix why the watch-task in debugging terminal is ignored
Add PHP & TypeScript as execution runtimes:
1. commandCodeLensProvider:
  1. Execute command with TS
  2. Execute command PHP
2. extension.ts & execute.ts:
  1. Add PHP and TS as execution runtimes
Add quick select keybinding without promting:
1. cmd+f1 s Execute command as Shell
2. cmd+f1 s Execute command with Nodejs

Appreciations

Sycl´s Markdown Command Runner Extension served as inspiration. Thanks!

It was lacking execution of code blocks in active SSH sessions, shortcuts and NodeJs-support, so I made my own.

markdown-execute's People

Contributors

Stargazers

Watchers

markdown-execute's Issues

TypeScript Support

Would you consider adding TypeScript?
I think you can use ts-node.

Example:
ts-node -e "console.log('Hello');"

Exception on markdown-execute.execute

I get the following exception upon invoking markdown-execute.execute with ctrl+f1.

[2022-09-03 07:59:51.727] [exthost] [error] TypeError: Cannot read properties of undefined (reading 'runtime')
	at /home/jpambrun/.vscode-server/extensions/hanskre.markdown-execute-0.0.13/dist/extension.js:1:2455
	at c._executeContributedCommand (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:85:63770)
	at c.$executeContributedCommand (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:85:64474)
	at i._doInvokeHandler (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:95:13689)
	at i._invokeHandler (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:95:13371)
	at i._receiveRequest (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:95:12141)
	at i._receiveOneMessage (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:95:10843)
	at /home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:95:8950
	at b.invoke (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:145)
	at p.deliver (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:2266)
	at v.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:1844)
	at a.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:19042)
	at /home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:111:17079
	at b.invoke (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:145)
	at p.deliver (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:2266)
	at v.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:1844)
	at a.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:19042)
	at r._receiveMessage (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:23854)
	at /home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:21224
	at b.invoke (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:145)
	at p.deliver (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:2266)
	at v.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:1844)
	at v.acceptChunk (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:15873)
	at /home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:15003
	at b.invoke (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:145)
	at p.deliver (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:2266)
	at v.fire (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:61:1844)
	at v._processReadQueue (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:34271)
	at v.acceptFrame (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:33927)
	at b._acceptChunk (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:31891)
	at /home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:28880
	at Socket.d (/home/jpambrun/.vscode-server/bin/784b0177c56c607789f9638da7b6bf3230d47a8c/out/vs/workbench/api/node/extensionHostProcess.js:69:26763)
	at Socket.emit (node:events:526:28)
	at addChunk (node:internal/streams/readable:315:12)
	at readableAddChunk (node:internal/streams/readable:289:9)
	at Socket.Readable.push (node:internal/streams/readable:228:10)
	at TCP.onStreamRead (node:internal/stream_base_commons:190:23) markdown-execute.execute {"value":"hanskre.markdown-execute","_lower":"hanskre.markdown-execute"}

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

Update dependency @types/node to v18.19.4

Pending Branch Automerge

These updates await pending status checks before automerging. Click on a checkbox to abort the branch automerge, and create a PR instead.

Update typescript-eslint monorepo to v6.17.0 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update dependency @types/node to v20

Detected dependencies

npm

package.json

@types/vscode ^1.85.0

@types/glob ^8.1.0

@types/mocha ^10.0.6

@types/node ^18.19.3

@typescript-eslint/eslint-plugin ^6.16.0

@typescript-eslint/parser ^6.16.0

eslint ^8.56.0

glob ^10.3.10

mocha ^10.2.0

typescript ^5.3.3

ts-loader ^9.5.1

webpack ^5.89.0

webpack-cli ^5.1.4

@vscode/test-electron ^2.3.8

vscode ^1.63.0

Check this box to trigger a request for Renovate to run again on this repository

Execute in currently active terminal

I love this extension, but for me to become useful I need the script to run in the current active terminal. That would be great.

Many characters must be escaped for JS

The following doesn't work:

let i = 12;
console.log("ab$cd")
console.log("ab$$cd")
console.log('sdfdsgdfg')
console.log(`ab${i}cd`)

as it results in

❯ node -e "let i = 12;
∙ console.log('ab$cd')
∙ console.log('ab$$cd')
∙ console.log('sdfdsgdfg')
∙ console.log(`ab${i}cd`)
∙ "
bash: abcd: command not found
ab
ab2847cd
sdfdsgdfg

Many characters needs to be escaped. Alternatively, the markdown block can the piped into node's stdin.

Python Error: IndentationError: expected an indented block after function definition on line 1

Problem

While passing python code with indentation in markdown file - indentation is not passed - causing IndentationError:

example from `md` file

```python
def say_hello(name):
  print(f'Hello {name}')
say_hello('World')
```

is passed to terminal as:

python -c "def say_hello(name):
print(f'Hello {name}')
say_hello('World')
"

with no indentation - causing IndentationError.