jekyll_pre 1.4.2 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9891991d8f4517372a76f9a52f60dd8d063a5527738b2bd5194fc749bba5a02e
-  data.tar.gz: 52b238c5f9aee99c593bd552552411503a0dd49f2c470b1c48bc6600c257e114
+  metadata.gz: c9c89dfed1bd63dfb97f8eea204a543d7ea06af6dca9f8b627b2bcf51ad0e65d
+  data.tar.gz: e81ee9721c99b5391d401c6a19fbbd2bca8371225b9cc2bf82ff3bfbcc4ab274
 SHA512:
-  metadata.gz: 3629fe65cd677c4d964b89e5197f6f18862177da853d862a905bd0162eb6265aa3922e196a34c0149bfd627e9d959155a39675b5ebccde9dfc5cd5f6fa05a355
-  data.tar.gz: 341e7a4863fc7dccb227d997154cccf677ef4576403f8c75b74cc1a596cbc1c1232d95df1257d052c03f6a65d0fb2104024398902b1fa98e68f54b912df46974
+  metadata.gz: 79af8ae474c13a9ad92436e1c916f4b21269b2944fc41725f59976ca543da264ebe8fd669cfe9de119c7f882d138b860006dc70c328c7ad6a58c16c700987a53
+  data.tar.gz: 004b17970a50fbe7c9df57d47b38456b36d5786d831db067dba9be7d219fac72823768a63247013beffb02ba9c9a24faa2379323dcdb6e8d1fb08dd99e4c628b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.4.3
+
+* Added the `no_stderr` option, which discards any STDERR output.
+
+
 ## 1.4.2
 
 * Added missing `require` in `pre_tag_block.rb`.

data/README.md

@@ -61,6 +61,16 @@ This Jekyll plugin provides 3 new Liquid tags that work together:
     - `die_if_error` – Set `false` to treat exceptions generated by this plugin as non-fatal.
       Instead of terminating Jekyll with an error message, the message will be displayed as an error by the Jekyll logger.
     - `no_escape` – Do not HTML escape the result of running the shell command.
+    - `no_stderr` - Discard STDERR output.
+      This is helpful for suppressing annoying `groff` error messages that are emitted when the `exec` subcommand runs `man`.
+      Use it like this:
+
+      ```html
+      {% pre copyButton dedent shell %}
+      {% noselect %}{% exec no_stderr man netplan %}
+      {% endpre %}
+      ```
+
     - `no_strip` – Do not remove leading and trailing whitespace from the result.
     - `wrapper_class` class applied to outer `div`.
     - `wrapper_style` style applied to outer `div`.

data/lib/exec_tag.rb

@@ -77,31 +77,44 @@ module JekyllPreModule
 
       @no_escape      = @helper.parameter_specified? 'no_escape'
       @no_strip       = @helper.parameter_specified? 'no_strip'
+      @no_stderr      = @helper.parameter_specified? 'no_stderr'
       @die_if_nonzero = @helper.parameter_specified?('die_if_nonzero') # Implies die_if_error
       @die_if_error   = @helper.parameter_specified?('die_if_error') | @die_if_nonzero
     end
 
     # References @cd
     # Defines @child_status
+    # Ignores stderr output
     # @return result of running command
     # @param command [String] Shell command to execute
     def run_command(command)
-      result = if @cd
-                 Dir.chdir(@cd) do
-                   `#{command}`
-                 end
-               else
-                 `#{command}`
-               end
-      @child_status = $CHILD_STATUS
-      result
+      stdout_str = ''
+      stderr_str = ''
+      if @cd
+        Dir.chdir(@cd) do
+          @logger.debug { "Executing '#{command}' from '#{@cd}'" }
+          stdout_str, stderr_str, @child_status = Open3.capture3 command
+        end
+      else
+        @logger.debug { "Executing '#{command}'" }
+        stdout_str, stderr_str, @child_status = Open3.capture3 command
+      end
+      unless @no_stderr
+        stderr_str.strip!
+        unless stderr_str.empty?
+          @logger.info do
+            "'#{command}' STDERR=#{stderr_str}\nThe exec subcommand's 'no_stderr' option suppresses this message."
+          end
+        end
+      end
+      stdout_str
     rescue StandardError => e
       msg = self.class.remove_html_tags(e.message) +
             " from executing '#{@original_command}' on line #{@line_number} (after front matter) of #{@page['path']}"
       raise PreError, msg.red, [] if @die_if_error
     ensure
       @child_status = $CHILD_STATUS
-      result
+      stdout_str
     end
 
     JekyllPluginHelper.register(self, 'exec')

data/lib/jekyll_pre/version.rb

@@ -1,3 +1,3 @@
 module JekyllPreVersion
-  VERSION = '1.4.2'.freeze
+  VERSION = '1.4.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_pre
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll