marked-conductor 1.0.20 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1f949d9bf655cb035b9bc2ed9f023e49c475effab65533f30b86c5392fa9908
-  data.tar.gz: de2824955f1c84608c3c32e5c9ef43b9b28a9e9623f454723ca7ddff3cede011
+  metadata.gz: 5e859f85b430fafdb74633e795caefd6cfc14ce26585970026d77c20ddce06c2
+  data.tar.gz: 292fbc78bdeaeb3480092872afa558c25fa156c1cb80784eee98c87dca55f253
 SHA512:
-  metadata.gz: 0f9c7c098a2e714ddca8673eda552d912319822c3a3c711fbfdba1a816e3f26dc8e42162532a68ccd1fb478d0452304b72e2a0d19c2a3025766ee9e0b3800db2
-  data.tar.gz: ae32f776ecbd94a2eba88b92fbdb3f30c016ace349ded8f8b64ecf1fb688125732d790f6d5ad31152ec74570aab16ef859be9bb43b0df49219086d64c0f52169
+  metadata.gz: 5ea468effe4d2be8b534d7bc9ea27dbb09a57f756393d7aebe4a33cda998326fb0eaa8b31194bc8c17e21487d3dd28aeaf3cedf21b707e61bda65a2253a609b8
+  data.tar.gz: 893e362f929e2a26a4815bc3782d758d6f4d25270ca2137867c56de846b5755adbb4dc1bf3983b996b88a61e904731220d2c76123f523825d88be39dc5bb4ebd

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.21
+
+2024-07-10 12:18
+
+#### NEW
+
+- New filter `fixHeaders` will adapt all headlines in the document to be in semantic order
+
 ### 1.0.20
 
 2024-07-04 12:18

data/README.md

@@ -163,6 +163,7 @@ The action can be `script`, `command`, or `filter`.
 | `prepend/appendCode(path)` | insert a file as a code block at beginning or end of content |
 | `insertCSS(path)` | insert custom CSS into document |
 | `autoLink()` | Turn bare URLs into \<self-linked\> urls |
+| `fixHeaders()` | Reorganize headline levels to semantic order |
 
 For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
 
@@ -176,7 +177,9 @@ If the path for `insertScript` or `insertCSS` is a URL instead of a filename, th
 
 For all of the prepend/append file filters, you can store files in `~/.config/conductor/files` and reference them with just a filename. Otherwise a full path will be assumed.
 
-For `autoLink`, any URL that's not contained in parenthesis or following a `[]: url` pattern will be autolinked (surrounded by angle brackets). URLs must contain `//` to be recognized, but any protocol will work, e.g. `x-marked://refresh`.
+For `autoLink`, any URL that's not contained in parenthesis or following a `[]: url` pattern will be autolinked (surrounded by angle brackets). URLs must contain `//` to be recognized, but any protocol will work, e.g. `x-marked://refresh`. Must be run on Markdown, not HTML.
+
+For `fixHeaders`, it will be ensured that the document has an h1, and all header levels will be adapted to never jump more than one header level when increasing. If no H1 exists in the document, the first header of the lowest existing level will be turned into an H1 and all other headers will be decremented to fit the hierarchy. It's not perfect, but it does a pretty good job. When saving the document as Markdown from Marked, the new headers will be applied.
 
 **Note:** successive filters in a sequence that insert or prepend will always insert content before/above the result of the previous insert filter. So if you have an `insertTitle` filter followed by an `insertCSS` filter, the CSS will appear above the inserted title. If you want elements inserted in reverse order, reverse the order of the inserts in the sequence.
 

data/lib/conductor/filter.rb

@@ -69,12 +69,35 @@ class ::String
     first
   end
 
-  def shift_headers(amt = 1)
-    gsub(/^#/, "#{"#" * amt}#")
+  ##
+  ## Count the characters in a string
+  ##
+  ## @return     [Integer] number of characters
+  ##
+  def chars
+    split(//).count
   end
 
-  def shift_headers!(amt = 1)
-    replace shift_headers(amt)
+  def decrease_headers(amt = 1)
+    gsub(/^(\#{1,6})(?!=#)/) do
+      m = Regexp.last_match
+      level = m[1].chars
+      level -= amt
+      level = 1 if level < 1
+      "#{"#" * level}"
+    end
+  end
+
+  def decrease_headers!(amt = 1)
+    replace decrease_headers(amt)
+  end
+
+  def increase_headers(amt = 1)
+    gsub(/^#/, "#{"#" * amt}#").gsub(/^\#{7,}/, '######')
+  end
+
+  def increase_headers!(amt = 1)
+    replace increase_headers(amt)
   end
 
   def insert_toc(max = nil, after = :h1)
@@ -245,7 +268,7 @@ class ::String
   def insert_title(shift: 0)
     content = dup
     title = get_title
-    content.shift_headers!(shift) if shift.positive?
+    content.increase_headers!(shift) if shift.positive?
     lines = content.split(/\n/)
     insert_point = content.meta_insert_point
     insert_at = insert_point.positive? ? insert_point + 1 : 0
@@ -342,6 +365,121 @@ class ::String
          '<\1>')
   end
 
+  ##
+  ## Count the number of h1 headers in the document
+  ##
+  ## @return     Number of h1s.
+  ##
+  def count_h1s
+    scan(/^#[^#]/).count
+  end
+
+  ##
+  ## Normalize Setext headers to ATX
+  ##
+  ## @return [String] content with headers updated
+  ##
+  def normalize_headers
+    gsub(/^(\S.*)\n([=-]+)\n/) do
+      m = Regexp.last_match
+      case m[2]
+      when /\=/
+        "# #{m[1]}\n\n"
+      else
+        "## #{m[1]}\n\n"
+      end
+    end
+  end
+
+  def normalize_headers!
+    replace normalize_headers
+  end
+
+  ##
+  ## Ensure there's at least 1 h1 in the document
+  ##
+  ## If no h1 is found, converts the lowest level header (first one) into an h1
+  ##
+  ## @return     [String] content with at least 1 h1
+  ##
+  def ensure_h1
+    headers = to_enum(:scan, /(\#{1,6})([^#].*?)$/m).map { Regexp.last_match }
+    return self if headers.select { |h| h[1].chars == 1 }.count.positive?
+
+    lowest_header = headers.min_by { |h| h[1].chars }
+    level = lowest_header[1].chars
+
+    sub(/#{Regexp.escape(lowest_header[0])}/, "# #{lowest_header[2].strip}").decrease_headers(level)
+  end
+
+  def ensure_h1!
+    replace ensure_h1
+  end
+
+  ##
+  ## Bump all headers except for first H1
+  ##
+  ## @return     Content with adjusted headers
+  ##
+  def fix_headers
+    return self if count_h1s == 1
+
+    first_h1 = true
+
+    gsub(%r/^(\#{1,6})([^#].*?)$/m) do
+      m = Regexp.last_match
+      level = m[1].chars
+      content = m[2].strip
+      if level == 1 && first_h1
+        first_h1 = false
+        m[0]
+      else
+        level += 1 if level < 6
+
+        "#{"#" * level} #{content}"
+      end
+    end
+  end
+
+  def fix_headers!
+    replace fix_headers
+  end
+
+  ##
+  ## Adjust header levels so there's no jump greater than 1
+  ##
+  ## @return     Content with adjusted headers
+  ##
+  def fix_hierarchy
+    normalize_headers!
+    ensure_h1!
+    fix_headers!
+    headers = to_enum(:scan, /(\#{1,6})([^#].*?)$/m).map { Regexp.last_match }
+    content = dup
+    last = 1
+    headers.each do |h|
+      level = h[1].chars
+      if level <= last + 1
+        last = level
+        next
+      end
+
+      level = last + 1
+      content.sub!(/#{Regexp.escape(h[0])}/, "#{"#" * level} #{h[2].strip}")
+    end
+
+    content
+  end
+
+  ##
+  ## Convert a string to a regular expression
+  ##
+  ## If the string matches /xxx/, it will be interpreted
+  ## directly as a regex. Otherwise it will be escaped and
+  ## converted to regex.
+  ##
+  ## @return     [Regexp] Regexp representation of the string.
+  ##
   def to_rx
     if self =~ %r{^/(.*?)/([im]+)?$}
       m = Regexp.last_match
@@ -353,6 +491,11 @@ class ::String
     end
   end
 
+  ##
+  ## Convert a string containing $1, $2 to a Regexp replace pattern
+  ##
+  ## @return     [String] Pattern representation of the object.
+  ##
   def to_pattern
     gsub(/\$(\d+)/, '\\\\\1').gsub(/(^["']|["']$)/, "")
   end
@@ -445,6 +588,8 @@ class Filter < String
       content.replace_one(@params[0], @params[1])
     when /(auto|self)link/
       content.autolink
+    when /fix(head(lines|ers)|hierarchy)/
+      content.fix_hierarchy
     end
   end
 end

data/lib/conductor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Conductor
-  VERSION = '1.0.20'
+  VERSION = '1.0.21'
 end

data/src/_README.md

@@ -163,6 +163,7 @@ The action can be `script`, `command`, or `filter`.
 | `prepend/appendCode(path)` | insert a file as a code block at beginning or end of content |
 | `insertCSS(path)` | insert custom CSS into document |
 | `autoLink()` | Turn bare URLs into \<self-linked\> urls |
+| `fixHeaders()` | Reorganize headline levels to semantic order |
 
 For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
 
@@ -176,7 +177,9 @@ If the path for `insertScript` or `insertCSS` is a URL instead of a filename, th
 
 For all of the prepend/append file filters, you can store files in `~/.config/conductor/files` and reference them with just a filename. Otherwise a full path will be assumed.
 
-For `autoLink`, any URL that's not contained in parenthesis or following a `[]: url` pattern will be autolinked (surrounded by angle brackets). URLs must contain `//` to be recognized, but any protocol will work, e.g. `x-marked://refresh`.
+For `autoLink`, any URL that's not contained in parenthesis or following a `[]: url` pattern will be autolinked (surrounded by angle brackets). URLs must contain `//` to be recognized, but any protocol will work, e.g. `x-marked://refresh`. Must be run on Markdown, not HTML.
+
+For `fixHeaders`, it will be ensured that the document has an h1, and all header levels will be adapted to never jump more than one header level when increasing. If no H1 exists in the document, the first header of the lowest existing level will be turned into an H1 and all other headers will be decremented to fit the hierarchy. It's not perfect, but it does a pretty good job. When saving the document as Markdown from Marked, the new headers will be applied.
 
 **Note:** successive filters in a sequence that insert or prepend will always insert content before/above the result of the previous insert filter. So if you have an `insertTitle` filter followed by an `insertCSS` filter, the CSS will appear above the inserted title. If you want elements inserted in reverse order, reverse the order of the inserts in the sequence.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marked-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.20
+  version: 1.0.21
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print