elisp2any 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e1120d995f02da6d5637763a9c2ddfa5bb5977b6abdab9b49fd03b69914bac
-  data.tar.gz: 9de0696b8af77040f5dd0655b5f5fc9c9a8d069b8329c2877961e1e43a7011a6
+  metadata.gz: 5a54442cefe9baee337378b71628c7aa3cf833f38028ea8517f56434b58f9a79
+  data.tar.gz: 3ab64eaec627d61736f14ca559d93a56d547bd21eb3b38ee6829d2f9158a84ca
 SHA512:
-  metadata.gz: cb7a79d6801f2c0b21a61a98fbdf8e965a423ba67e7988f598d9ab6d9f9e390cb361028e7ced4f2fce501234308aa0d0d43adc283dde1499765b6e12254fab8d
-  data.tar.gz: c955943ac810407fedededfa1ef075108ac54b66b4f7ed6ed07518337f8903f79c92a3e39c177c29d3378c91181cd12e8ad3c6fc13fb03fd272a44345447e629
+  metadata.gz: 17dcdd8ccaf1fb4295a32460ef1f5da6e4fcf65ecfdffca48bf53929aa4fa2fa4b6e1c10d00a1d03feec458a8231e28ee63316bff99fa77441f836c456a44a4d
+  data.tar.gz: bbcad198b0eaf48a010c72ff7c1b4f717caed16ec2386c48f670f858241a74bdd53b883bb7166dc394eba57de9bbf146321143dbadcfa34ba27815f0d43606c8

data/.envrc

@@ -0,0 +1,2 @@
+layout ruby
+export LANG=en_US.UTF-8

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log of Elisp2any
 
+## Unreleased
+
+## 0.0.8 - 2026-08-05
+
+* Add JSON format option (for the Pandoc JSON filter).
+
+## 0.0.7 - 2026-07-05
+
+* Add dump flag for debugging.
+* Allow other variables in headers.
+* Remove sidebar.
+* Markup copyright mark.
+* Hide navigation by default.
+* Add comments for command line options.
+
 ## 0.0.6 - 2025-06-22
 
 Removed previous parsers and added simple strscan base parser.

data/README.md

@@ -1,5 +1,10 @@
 # Elisp2any
 
+Project links: [repository](https://codeberg.org/gemmaro/elisp2any),
+[mirror](https://github.com/gemmaro/elisp2any), [RubyGems.org][rg].
+
+[rg]: https://rubygems.org/gems/elisp2any
+
 ## Installation
 
 Install the gem and add to the application's `Gemfile` by executing `bundle add elisp2any`.
@@ -7,14 +12,33 @@ If Bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Currently the command line tool only supports HTML rendering.
+Currently the command line tool supports HTML (default) and JSON rendering.
 
 ```shell
 $ elisp2any --input /path/to/input/file --output /path/to/output/file
 ```
 
+The JSON is based off the [Pandoc JSON filter][pf].  The example usage
+is:
+
+```shell
+./exe/elisp2any \
+    --format=json \
+    < ~/.emacs.d/init.el \
+    | pandoc \
+          --from=json \
+          --standalone \
+          > /tmp/index.html
+```
+
+[pf]: https://pandoc.org/filters.html
+
 ## Development
 
+To run tests, run `test-unit` (or `rake test`).
+
+There are a few notes about the terms.
+
 Two paragraph types:
 
 ```emacs-lisp
@@ -38,5 +62,17 @@ Bug reports and pull requests are welcome.
 
 ## License
 
-This package is provided under the Apache License.
-See `LICENSE.txt` for details.
+Copyright (C) 2025, 2026  gemmaro
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,10 +1,16 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "open3"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+task :deploy do
+  out, _stat = Open3.capture2("./bin/dev")
+  File.write("/tmp/index.html", out)
+  sh "rsync", "-av", "/tmp/index.html", "pi:/srv/www/emacs/"
 end
 
-task default: :test
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end

data/exe/elisp2any

@@ -1,5 +1,20 @@
 #!/usr/bin/env ruby
 
+# Copyright (C) 2025, 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'optparse'
 
 $LOAD_PATH << File.join(__dir__, "../lib")
@@ -8,19 +23,45 @@ require 'elisp'
 input = $stdin
 output = $stdout
 css = nil
+dump = false
+format = :html
 
 OptionParser.new do |parser|
-  parser.on('--input=PATH') do |path|
+  parser.on('--input=PATH', 'ELisp file (default: stdin)') do |path|
     input = File.open(path)
   end
 
-  parser.on('--output=PATH') do |path|
+  parser.on('--output=PATH', 'HTML file (default: stdout)') do |path|
     output = File.open(path, 'w')
   end
 
-  parser.on('--css=PATH') do |path|
+  parser.on('--css=PATH', 'stylesheet') do |path|
     css = path
   end
+
+  parser.on("--dump", 'For debug purpose') { dump = true }
+
+  parser.on("--format=NAME", "'json' is for Pandoc JSON filter.  Default: HTML") do |name|
+    case name
+    in "html"
+      format = :html
+    in "json"
+      format = :json
+    end
+  end
 end.parse!
 
-Elisp.parse(input).write(output, css:)
+css && format != :html and raise "CSS option is for HTML only"
+
+doc = Elisp.parse(input)
+if dump
+  pp doc
+  exit
+end
+
+case format
+in :html
+  doc.write(output, css:)
+in :json
+  doc.write_pandoc_json(output)
+end

data/lib/elisp/comment.rb

@@ -1,3 +1,18 @@
+# Copyright (C) 2025, 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 class Elisp::Comment
   def initialize(content)
     @content = content
@@ -10,84 +25,4 @@ class Elisp::Comment
   def to_minor_para
     Elisp::MinorPara.new(@content)
   end
-
-  def html
-    self.class.parse(@content)
-  end
-end
-
-class Elisp::DocStringParser
-  URI_PATTERN = URI.regexp
-  URI_PATTERN_WITH_ANGLES = /[<](?<uri>#{ URI_PATTERN })[>]/
-  EMAIL = Regexp.new(URI::MailTo::EMAIL_REGEXP.to_s
-                       .sub(/\A[(][?]-mix:\\A/, "(?-mix:")
-                       .sub(/\\z[)]\z/, ")"))
-  EMAIL_WITH_ANGLES = /[<](?<address>#{ EMAIL })[>]/
-
-  def initialize(source)
-    @scanner = StringScanner.new(source)
-  end
-
-  def html
-    result = +""
-    normal = +""
-    until @scanner.eos?
-      if @scanner.skip(/[`](?<code>[A-Za-z!.-]+)[']/)
-        result << normal
-        normal.clear
-        code = CGI.escape_html(@scanner[:code])
-        result << "<code>#{code}</code>"
-        normal.clear
-      elsif @scanner.skip(/\\\\=(?<quote>['`])/)
-        normal << @scanner[:quote]
-      elsif (uri = scan_http_uri)
-        result << normal
-        normal.clear
-        result << html_url(uri)
-      elsif (address = scan_email)
-        result << normal
-        normal.clear
-        uri = CGI.escape(address)
-        address = CGI.escape_html(address)
-        result << %(<a href="mailto:#{uri}">#{address}</a>)
-      else
-        normal << @scanner.getch
-      end
-    end
-    result << normal
-    normal.clear
-    result
-  end
-
-  def scan_email
-    if (address = @scanner.scan(EMAIL))
-      address
-    elsif @scanner.skip(EMAIL_WITH_ANGLES)
-      @scanner[:address]
-    else
-      return
-    end
-  end
-
-  def scan_http_uri
-    if (uri = @scanner.scan(URI_PATTERN))
-    elsif @scanner.skip(URI_PATTERN_WITH_ANGLES)
-      uri = @scanner[:uri]
-    else
-      return
-    end
-    uri = URI(uri)
-    unless uri.is_a?(URI::HTTP)
-      @scanner.unscan
-      return
-    end
-    uri
-  end
-
-  def html_url(url)
-    url = url.to_s
-    ref = CGI.escape(url)
-    label = CGI.escape_html(url)
-    %(<a class="pure-url" href="#{ref}">#{label}</a>)
-  end
 end

data/lib/elisp/default.css

@@ -0,0 +1,11 @@
+.description {
+    font-style: italic;
+}
+pre {
+    font-family: serif;
+    white-space: pre-wrap;
+}
+pre[class="code"] {
+    border-left: 2px solid black;
+    padding-left: 0.5rem;
+}

data/lib/elisp/doc_string_parser.rb

@@ -0,0 +1,217 @@
+# Copyright (C) 2025, 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cgi/escape"
+require "uri"
+require "strscan"
+
+class Elisp::DocStringParser
+  URI_PATTERN = URI::RFC2396_PARSER.make_regexp
+  URI_PATTERN_WITH_ANGLES = /[<](?<uri>#{ URI_PATTERN })[>]/
+  EMAIL = Regexp.new(URI::MailTo::EMAIL_REGEXP.to_s
+                       .sub(/\A[(][?]-mix:\\A/, "(?-mix:")
+                       .sub(/\\z[)]\z/, ")"))
+  EMAIL_WITH_ANGLES = /[<](?<address>#{ EMAIL })[>]/
+
+  def initialize(source)
+    @scanner = StringScanner.new(source)
+  end
+
+  def html
+    parse.map(&:html).join
+  end
+
+  def pandoc_json_objects
+    parse.map(&:pandoc_json_object)
+  end
+
+  private
+
+  def parse
+    result = []
+    normal = +""
+    until @scanner.eos?
+      if @scanner.skip(/[`](?<code>[A-Za-z!.-]+)[']/)
+        result << Text.new(normal)
+        normal = +""
+        result << Code.new(@scanner[:code])
+
+      elsif @scanner.skip(/\\\\=(?<quote>['`])/)
+        normal << @scanner[:quote]
+
+      elsif (uri = scan_http_uri)
+        result << Text.new(normal)
+        normal = +""
+        result << HTMLURL.new(uri)
+
+      elsif (address = scan_email)
+        result << Text.new(normal)
+        normal = +""
+        result << Email.new(address)
+
+      elsif @scanner.skip(/Copyright [(]C[)]/)
+        result << Text.new(normal << "Copyright ") << Copyright.new
+        normal = +""
+
+      else
+        normal << @scanner.getch
+      end
+    end
+
+    result << Text.new(normal)
+    result
+  end
+
+  private
+
+  def scan_email
+    if (address = @scanner.scan(EMAIL))
+      address
+    elsif @scanner.skip(EMAIL_WITH_ANGLES)
+      @scanner[:address]
+    else
+      return
+    end
+  end
+
+  def scan_http_uri
+    if (uri = @scanner.scan(URI_PATTERN))
+    elsif @scanner.skip(URI_PATTERN_WITH_ANGLES)
+      uri = @scanner[:uri]
+    else
+      return
+    end
+    uri = URI(uri)
+    unless uri.is_a?(URI::HTTP)
+      @scanner.unscan
+      return
+    end
+    uri
+  end
+
+  class Text
+    def initialize(content)
+      @content = content
+    end
+
+    def html
+      CGI.escape_html(@content)
+    end
+
+    def pandoc_json_object
+      {
+        "t": "Str",
+        "c": @content,
+      }
+    end
+  end
+
+  class Code
+    def initialize(content)
+      @content = content
+    end
+
+    def html
+      code = CGI.escape_html(@content)
+      "<code>#{code}</code>"
+    end
+
+    def pandoc_json_object
+      {
+        "t": "Code",
+        "c": [
+          ["", [], []],
+          @content,
+        ]
+      }
+    end
+  end
+
+  class HTMLURL
+    def initialize(content)
+      @content = content
+    end
+
+    def html
+      url = @content.to_s
+      ref = CGI.escape(url)
+      label = CGI.escape_html(url)
+      %(<a class="pure-url" href="#{ref}">#{label}</a>)
+    end
+
+    def pandoc_json_object
+      {
+        "t": "Link",
+        "c": [
+          ["", ["uri"], []],
+          [
+            {
+              "t": "Str",
+              "c": @content,
+            }
+          ],
+          [
+            @content,
+            "",
+          ],
+        ],
+      }
+    end
+  end
+
+  class Email
+    def initialize(content)
+      @content = content
+    end
+
+    def html
+      uri = CGI.escape(@content)
+      address = CGI.escape_html(@content)
+      %(<a href="mailto:#{uri}">#{address}</a>)
+    end
+
+    def pandoc_json_object
+      {
+        "t": "Link",
+        "c": [
+          ["", ["email"], []],
+          [
+            {
+              "t": "Str",
+              "c": @content,
+            }
+          ],
+          [
+            "mailto:#{@content}",
+            "",
+          ],
+        ],
+      }
+    end
+  end
+
+  class Copyright
+    def html
+      "&copy;"
+    end
+
+    def pandoc_json_object
+      {
+        "t": "Str",
+        "c": "©",
+      }
+    end
+  end
+end

data/lib/elisp/heading.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2025, 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cgi/escape"
+
+class Elisp::Heading
+  attr_reader :level, :content
+
+  def initialize(content, level: 2)
+    @content = content
+    @level = level
+  end
+
+  def html
+    name = "h#{@level}"
+    content = CGI.escape_html(@content)
+    "<#{name}>#{content}</#{name}>"
+  end
+
+  def pandoc_json_object
+    {
+      "t": "Header",
+      "c": [
+        @level,
+        [@content, [], []],
+        [
+          {
+            "t": "Str",
+            "c": @content,
+          },
+        ],
+      ]
+    }
+  end
+end

data/lib/elisp/parser.rb

@@ -1,8 +1,26 @@
+# Copyright (C) 2025, 2026  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "json"
+require "strscan"
+
 class Elisp::Parser
   HEADER_LINE = %r{
     ;;;[ ]
     (?<title>[a-z]+[.]el)[ ]---[ ](?<desc>.*?)
-    (?:[ ]+-[*]-[ ](?<vars>lexical-binding:[ ]?t);?[ ]-[*]-)?
+    (?:[ ]+-[*]-[ ]*(?<vars>.*?)[ ]*-[*]-)?
     \n+
   }x
   COMMENT = / *;; (?<comment>.*)\n/
@@ -20,45 +38,10 @@ class Elisp::Parser
   }x
   BLANKLINES = /\n+/
   CODE_OR_BLANKLINES = Regexp.union(CODE, BLANKLINES)
-  DEFAULT_CSS = <<~END_CSS
-    <style>
-      :root {
-        --sidebar-width: 200px;
-      }
-      body {
-        display: flex;
-      }
-      main {
-        max-width: 80rem;
-        margin: auto auto auto var(--sidebar-width);
-        padding-left: 0.5rem;
-        border-box: box-sizing;
-      }
-      .sidebar {
-        padding-right: 0.5rem;
-        width: var(--sidebar-width);
-        position: fixed;
-        boxed-sizing: border-box;
-        overflow-y: auto;
-        height: 100%;
-      }
-      .sidebar details ul {
-        position: relative;
-        left: -1.5rem;
-      }
-      .description {
-        font-style: italic;
-      }
-      pre {
-        font-family: serif;
-      }
-      pre[class="code"] {
-        border-left: solid;
-        padding-left: 0.5rem;
-        white-space: pre-wrap;
-      }
-    </style>
-  END_CSS
+  
+  css = File.read(File.join(__dir__, "default.css"))
+  DEFAULT_CSS = "<style>#{css}</style>"
+  
   HEADING = %r{
     ;;;(?<level>;*)[ ](?<title>.+)\n
     (?:(?:;;)?\n)*
@@ -132,7 +115,7 @@ class Elisp::Parser
         @nodes.last << @scanner[:content]
 
       elsif @state == :after_code && @scanner.skip(/\f\n+/)
-        @nodes << PageDelimiter.new
+        @nodes << Elisp::PageDelimiter.new
         @state = :after_page_delimiter
 
       else
@@ -163,9 +146,6 @@ class Elisp::Parser
 
   def write(output, css: nil)
     css = css ? %(<link rel="stylesheet" href="#{CGI.escape(css)}">) : DEFAULT_CSS
-    sidebar = Elisp::Sidebar.new(@nodes.select { |node| node.is_a?(Elisp::Heading) \
-                                                          && node.level >= 2 })
-                .html
     body = @nodes.map(&:html).join("\n")
     output.write(<<~END_HTML)
       <!doctype html>
@@ -173,16 +153,25 @@ class Elisp::Parser
         <head>
           #{css}
           <meta charset="utf8">
+          <meta name="viewport" content="width=device-width, initial-scale=1">
         </head>
         <body>
-          <nav class="sidebar">
-            #{sidebar}
-          </nav>
-          <main>
-            #{body}
-          </main>
+          <main>#{body}</main>
         </body>
       </html>
     END_HTML
   end
+
+  def pandoc_json_object
+    {
+      "pandoc-api-version": [1,23,1,1],
+      "meta": {},
+      "blocks": @nodes.map(&:pandoc_json_object),
+    }
+  end
+
+  def write_pandoc_json(output)
+    json = JSON.dump(pandoc_json_object)
+    output.write(json)
+  end
 end