markdown-run 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb74c59f4e26ed84c5733a6adc0707523cc9eae17797a12cf90a854618c11a3
-  data.tar.gz: 765069182cc8a77902e6e9676469f670a3cee84c1a5e888571d189e9d4d782bc
+  metadata.gz: 00367c7c6c302db7b935780c6bb63f6deec1175516f82999ed7295f4b88794b6
+  data.tar.gz: dbf713b531a435d794e40da3f9e4f2d04b9a78e859bedba44649ed0ac46a5898
 SHA512:
-  metadata.gz: 29ba3d6f47e39875804ffdeafde532149b10f5052b26fd1c333564531445a27789602140105e51371d98f198582bde1ee200a50ef8e6595a0e4c1d5656e97249
-  data.tar.gz: 89df023e98a32578dee678dde88f0922312aaf018893e11a263552386eaafa2bafea44984255e73a9dc9f8e5dfecc3955d5d3d8b8f1a47ed07dbdf9bad0eabcb
+  metadata.gz: 5680e8dfa751cd59afc0cd5e92070cd6eb6d3d24c13a53f44212cc7f4398cd2504e3f63718c15f3e00ba92b8d87aced3a9d92804e9a25922b7af833c9d4608bb
+  data.tar.gz: 5778ebed3f7495f478fdc370faa06c8b7c38ada306de254103849ee18a14251f94a281d0fd91d78207c79fe27bac125e4cdf24dd78c039085e0013b67796b898

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 ## [Unreleased]
 
-## [0.2.0] - 2025-05-14
+## [0.1.4] - 2025-05-18
+
+- Add support for zsh, bash, sh
+
+## [0.1.3] - 2025-05-14
+
+- Fix missing minitest dep
+
+## [0.1.2] - 2025-05-14
 
 - Gemfile update
 

data/README.md

@@ -1,9 +1,13 @@
-[![Ruby](https://github.com/aurelienbottazini/markdown-run/actions/workflows/main.yml/badge.svg)](https://github.com/aurelienbottazini/markdown-run/actions/workflows/main.yml)
-
-[![Gem Version](https://badge.fury.io/rb/markdown-run.svg)](https://badge.fury.io/rb/markdown-run)
+[![Ruby](https://github.com/aurelienbottazini/markdown-run/actions/workflows/main.yml/badge.svg)](https://github.com/aurelienbottazini/markdown-run/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/markdown-run.svg)](https://badge.fury.io/rb/markdown-run)
 
 # Markdown-run
 
+Execute code blocks from your markdown files.
+Save results to a new code block appended after the initial code block.
+Do not rerun code blocks if result block is present.
+
+Meant to be used from the terminal or from an editor with a keybinding.
+
 ## Installation
 
 `gem install markdown-run`
@@ -13,6 +17,36 @@
 - Run specs `markdown-run`
 - Run on a markdown file `markdown-run your-filename`
 
+example vscode keybinding
+
+```json
+  {
+    "key": "ctrl+shift+b",
+    "command": "runCommands",
+    "args": {
+      "commands": [
+        {
+          "command": "workbench.action.files.save"
+        },
+        {
+          "command": "workbench.action.terminal.sendSequence",
+          "args": {
+            "text": "markdown-run \"${file}\"\n"
+          }
+        },
+        {
+          "command": "workbench.action.files.revert"
+        }
+      ]
+    },
+    "when": "editorTextFocus && editorLangId == 'markdown'"
+  },
+```
+
+## Demo
+
+![VSCode Usage](docs/markdown-run-vscode.gif)
+
 ## Development
 
 Just run the script with `./exe/markdown-run`
@@ -25,4 +59,4 @@ Bug reports are welcome on GitHub at https://github.com/aurelienbottazini/markdo
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## [code of conduct](https://github.com/aurelienbottazini/markdown-run/blob/main/CODE_OF_CONDUCT.md).
+## [Code of conduct](https://github.com/aurelienbottazini/markdown-run/blob/main/CODE_OF_CONDUCT.md).

data/exe/markdown-run

@@ -30,8 +30,7 @@ SUPPORTED_LANGUAGES = {
     command: ->(code_content, _temp_file_path) {
       psql_exists = system("command -v psql > /dev/null 2>&1")
       unless psql_exists
-        warn "Error: psql command not found. Please install PostgreSQL or ensure psql is in your PATH."
-        exit 1 # Abort the script
+        abort "Error: psql command not found. Please install PostgreSQL or ensure psql is in your PATH."
       end
       [ "psql -A -t -X", { stdin_data: code_content } ]
     }
@@ -40,8 +39,7 @@ SUPPORTED_LANGUAGES = {
     command: ->(_code_content, temp_file_path) {
       xmpfilter_exists = system("command -v xmpfilter > /dev/null 2>&1")
       unless xmpfilter_exists
-        warn "Error: xmpfilter command not found. Please install xmpfilter or ensure it is in your PATH."
-        exit 1 # Abort the script
+        abort "Error: xmpfilter command not found. Please install xmpfilter or ensure it is in your PATH."
       end
       [ "xmpfilter #{temp_file_path}", {} ]
     },
@@ -51,26 +49,43 @@ SUPPORTED_LANGUAGES = {
   "js" => JS_CONFIG,
   "javascript" => JS_CONFIG, # Alias for js
   "sqlite" => SQLITE_CONFIG,
-  "sqlite3" => SQLITE_CONFIG # Alias for sqlite
+  "sqlite3" => SQLITE_CONFIG, # Alias for sqlite
+  "bash" => {
+    command: ->(_code_content, temp_file_path) {
+      bash_exists = system("command -v bash > /dev/null 2>&1")
+      unless bash_exists
+        abort "Error: bash command not found. Please ensure bash is in your PATH."
+      end
+      [ "bash #{temp_file_path}", {} ]
+    },
+    temp_file_suffix: ".sh"
+  },
+  "zsh" => {
+    command: ->(_code_content, temp_file_path) {
+      zsh_exists = system("command -v zsh > /dev/null 2>&1")
+      unless zsh_exists
+        abort "Error: zsh command not found. Please ensure zsh is in your PATH."
+      end
+      [ "zsh #{temp_file_path}", {} ]
+    },
+    temp_file_suffix: ".zsh"
+  },
+  "sh" => {
+    command: ->(_code_content, temp_file_path) {
+      sh_exists = system("command -v sh > /dev/null 2>&1")
+      unless sh_exists
+        abort "Error: sh command not found. Please ensure sh is in your PATH."
+      end
+      [ "sh #{temp_file_path}", {} ]
+    },
+    temp_file_suffix: ".sh"
+  }
 }.freeze
 
 LANGUAGE_REGEX_PART = SUPPORTED_LANGUAGES.keys.map { |lang| Regexp.escape(lang) }.join("|").freeze
 CODE_BLOCK_START_REGEX = /^```(#{LANGUAGE_REGEX_PART})$/i
 # --- End Language Execution Configuration ---
 
-if ARGV.empty?
-  require "bundler/inline"
-  gemfile(true) do
-    source "https://rubygems.org"
-    gem "minitest" # You can specify a version like '~> 5.10' if needed
-    gem "rcodetools"
-  end
-
-  puts "Running tests..."
-  require "minitest/spec"
-  require "minitest/autorun"
-end
-
 # Script to process markdown files, execute code blocks based on language,
 # and insert their results back into the markdown.
 
@@ -290,6 +305,19 @@ def process_markdown_file_main(input_file_path)
   true # Indicate success
 end
 
+if ARGV.empty?
+
+ require "minitest/spec"
+  require "bundler/inline"
+  gemfile(true) do
+    source "https://rubygems.org"
+    gem "minitest", "5.25.5" # Specify the required version
+    gem "rcodetools"
+  end
+
+  puts "Running tests..."
+  require "minitest/autorun"
+
 # --- Minitest Test Class Definition ---
 class TestMarkdownExec < Minitest::Test
   def setup
@@ -387,5 +415,6 @@ class TestMarkdownExec < Minitest::Test
     assert_equal original_content.strip, read_md_file.strip, "Should not execute if ```ruby RESULT block exists"
   end
 end
+end
 
 process_markdown_file_main(ARGV[0]) unless ARGV.empty?

data/lib/markdown/run/version.rb

@@ -2,6 +2,6 @@
 
 module Markdown
   module Run
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
   end
 end

data/markdown-run-sample.md

@@ -0,0 +1,78 @@
+This is an example markdown file
+
+The following psql code block should be executed
+And the result should be shown in a following codeblock
+
+```ruby
+p "foo"
+```
+
+```ruby RESULT
+p "foo"
+# >> "foo"
+```
+
+```bash
+date
+```
+
+```RESULT
+Sun May 18 15:05:35 CEST 2025
+```
+
+```zsh
+date
+```
+
+```RESULT
+Sun May 18 15:05:13 CEST 2025
+```
+
+```sh
+date
+```
+
+```RESULT
+Sun May 18 15:07:05 CEST 2025
+```
+
+```js
+1 + 2;
+console.log(3);
+```
+
+```RESULT
+3
+```
+
+```psql
+\d
+```
+
+```RESULT
+public|ar_internal_metadata|table|aurelienbottazini
+public|schema_migrations|table|aurelienbottazini
+```
+
+```sqlite3
+.stats
+```
+
+```RESULT
+Memory Used:                         147824 (max 147888) bytes
+Number of Outstanding Allocations:   169 (max 170)
+Number of Pcache Overflow Bytes:     4608 (max 4608) bytes
+Largest Allocation:                  122400 bytes
+Largest Pcache Allocation:           4104 bytes
+Lookaside Slots Used:                34 (max 34)
+Successful lookaside attempts:       34
+Lookaside failures due to size:      0
+Lookaside failures due to OOM:       0
+Pager Heap Usage:                    5632 bytes
+Page cache hits:                     0
+Page cache misses:                   0
+Page cache writes:                   0
+Page cache spills:                   0
+Schema Heap Usage:                   0 bytes
+Statement Heap/Lookaside Usage:      0 bytes
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown-run
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Aurélien Bottazini
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-14 00:00:00.000000000 Z
+date: 2025-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rcodetools
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.25.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.25.5
 description: Run code blocks in Markdown files for Ruby, JavaScript, sqlite and psql.
   Insert execution results next to the original code blocks.
 email:
@@ -38,8 +52,10 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
+- docs/markdown-run-vscode.gif
 - exe/markdown-run
 - lib/markdown/run/version.rb
+- markdown-run-sample.md
 homepage: https://rubygems.org/gems/markdown-run
 licenses:
 - MIT