elisp2any 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf30639582d2ecf42060b4db852d32438545e209b2c2eeac8b23ded371a4d50
-  data.tar.gz: 0ae7c862c01e4e5cdb0995d2ce31d6fe8b0df253f3e29ffd58fd5bfed580edbb
+  metadata.gz: 5a54442cefe9baee337378b71628c7aa3cf833f38028ea8517f56434b58f9a79
+  data.tar.gz: 3ab64eaec627d61736f14ca559d93a56d547bd21eb3b38ee6829d2f9158a84ca
 SHA512:
-  metadata.gz: 747da66f11028d3da70cc731b5bf60e3ed44a261c19359022a33d3a151611e14df560dae64ec650ecb4cb8e8bc9509164e76f72586a7454d44ddf76805d8c856
-  data.tar.gz: 63928b7c7b20e1e045159f3457b309e47c9be922c63ce3fda708ac1be98b46c66000052cc7849d157ddce7d8dd1127dc39ba21b2f1a6ea49d9bd3869707c9fca
+  metadata.gz: 17dcdd8ccaf1fb4295a32460ef1f5da6e4fcf65ecfdffca48bf53929aa4fa2fa4b6e1c10d00a1d03feec458a8231e28ee63316bff99fa77441f836c456a44a4d
+  data.tar.gz: bbcad198b0eaf48a010c72ff7c1b4f717caed16ec2386c48f670f858241a74bdd53b883bb7166dc394eba57de9bbf146321143dbadcfa34ba27815f0d43606c8

data/.envrc

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

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 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.

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,15 +12,32 @@ 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`.
+To run tests, run `test-unit` (or `rake test`).
+
+There are a few notes about the terms.
 
 Two paragraph types:
 
@@ -40,7 +62,7 @@ Bug reports and pull requests are welcome.
 
 ## License
 
-Copyright (C) 2025  gemmaro
+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

data/Rakefile

@@ -6,3 +6,11 @@ task :deploy do
   File.write("/tmp/index.html", out)
   sh "rsync", "-av", "/tmp/index.html", "pi:/srv/www/emacs/"
 end
+
+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,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright (C) 2025  gemmaro
+# 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
@@ -24,6 +24,7 @@ input = $stdin
 output = $stdout
 css = nil
 dump = false
+format = :html
 
 OptionParser.new do |parser|
   parser.on('--input=PATH', 'ELisp file (default: stdin)') do |path|
@@ -38,13 +39,29 @@ OptionParser.new do |parser|
     css = path
   end
 
-  parser.on("--dump") { dump = true }
+  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!
 
+css && format != :html and raise "CSS option is for HTML only"
+
 doc = Elisp.parse(input)
 if dump
   pp doc
   exit
 end
 
-doc.write(output, css:)
+case format
+in :html
+  doc.write(output, css:)
+in :json
+  doc.write_pandoc_json(output)
+end

data/lib/elisp/comment.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -25,8 +25,4 @@ class Elisp::Comment
   def to_minor_para
     Elisp::MinorPara.new(@content)
   end
-
-  def html
-    self.class.parse(@content)
-  end
 end

data/lib/elisp/doc_string_parser.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -13,12 +13,12 @@
 # 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"
+require "cgi/escape"
 require "uri"
 require "strscan"
 
 class Elisp::DocStringParser
-  URI_PATTERN = URI.regexp
+  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:")
@@ -30,38 +30,52 @@ class Elisp::DocStringParser
   end
 
   def html
-    result = +""
+    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 << normal
-        normal.clear
-        code = CGI.escape_html(@scanner[:code])
-        result << "<code>#{code}</code>"
-        normal.clear
+        result << Text.new(normal)
+        normal = +""
+        result << Code.new(@scanner[:code])
+
       elsif @scanner.skip(/\\\\=(?<quote>['`])/)
         normal << @scanner[:quote]
+
       elsif (uri = scan_http_uri)
-        result << normal
-        normal.clear
-        result << html_url(uri)
+        result << Text.new(normal)
+        normal = +""
+        result << HTMLURL.new(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>)
+        result << Text.new(normal)
+        normal = +""
+        result << Email.new(address)
+
       elsif @scanner.skip(/Copyright [(]C[)]/)
-        result << "Copyright &copy;"
+        result << Text.new(normal << "Copyright ") << Copyright.new
+        normal = +""
+
       else
         normal << @scanner.getch
       end
     end
-    result << normal
-    normal.clear
+
+    result << Text.new(normal)
     result
   end
 
+  private
+
   def scan_email
     if (address = @scanner.scan(EMAIL))
       address
@@ -87,10 +101,117 @@ class Elisp::DocStringParser
     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>)
+  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

@@ -1,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -13,7 +13,7 @@
 # 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"
+require "cgi/escape"
 
 class Elisp::Heading
   attr_reader :level, :content
@@ -28,4 +28,20 @@ class Elisp::Heading
     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,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -13,6 +13,9 @@
 # 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{
     ;;;[ ]
@@ -158,4 +161,17 @@ class Elisp::Parser
       </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

data/lib/elisp/version.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -14,5 +14,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 class Elisp
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/elisp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2025  gemmaro
+# 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
@@ -13,10 +13,10 @@
 # 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 "strscan"
-require "cgi"
-require "uri"
+require "cgi/escape"
 
+# +pandoc_json_object+ methods for some classes means the AST for the
+# Pandoc JSON filter.
 class Elisp
   Error = Class.new(StandardError)
 
@@ -27,6 +27,11 @@ end
 
 class Elisp::PageDelimiter
   def html = "<hr>"
+  def pandoc_json_object
+    {
+      "t": "HorizontalRule",
+    }
+  end
 end
 
 class Elisp::Desc
@@ -38,6 +43,26 @@ class Elisp::Desc
     content = CGI.escape_html(@content)
     %(<p class="description">#{content}</p>)
   end
+
+  def pandoc_json_object
+    {
+      "t": "Div",
+      "c": [
+        ["", ["description"], []],
+        [
+          {
+            "t": "Para",
+            "c": [
+              {
+                "t": "Str",
+                "c": @content,
+              },
+            ],
+          },
+        ],
+      ],
+    }
+  end
 end
 
 class Elisp::Variables
@@ -54,6 +79,24 @@ class Elisp::Variables
       </article>
     END_HTML
   end
+
+  def pandoc_json_object
+    {
+      "t": "Div",
+      "c": [
+        ["", ["header-line-variables"], []],
+        [
+          {
+            "t": "CodeBlock",
+            "c": [
+              ["", ["emacs-lisp-header-line-variables"], []],
+              @content,
+            ],
+          },
+        ],
+      ],
+    }
+  end
 end
 
 class Elisp::MajorPara
@@ -65,6 +108,16 @@ class Elisp::MajorPara
     paras = @paras.map(&:html).join("\n")
     "<article>#{paras}</article>"
   end
+
+  def pandoc_json_object
+    {
+      "t": "Div",
+      "c": [
+        ["", ["major-para"], []],
+        @paras.map(&:pandoc_json_object),
+      ],
+    }
+  end
 end
 
 class Elisp::MinorPara
@@ -76,6 +129,13 @@ class Elisp::MinorPara
     content = Elisp::DocStringParser.new(@content).html
     "<pre>#{content}</pre>"
   end
+
+  def pandoc_json_object
+    {
+      "t": "Para",
+      "c": Elisp::DocStringParser.new(@content).pandoc_json_objects,
+    }
+  end
 end
 
 class Elisp::Code
@@ -91,6 +151,16 @@ class Elisp::Code
     content = CGI.escape_html(@content)
     %(<pre class="code"><code>#{content}</code></pre>)
   end
+
+  def pandoc_json_object
+    {
+      "t": "CodeBlock",
+      "c": [
+        ["", ["emacs-lisp"], []],
+        @content,
+      ],
+    }
+  end
 end
 
 require_relative "elisp/comment"

data/sample.md

@@ -0,0 +1,30 @@
+これはページ区切りです：
+
+---
+
+これはコードブロックです：
+
+```emacs-lisp
+(message "hello")
+```
+
+これは有塀divです：
+
+::: majorpara
+段落1つ目。
+
+段落2つ目。
+:::
+
+なお、普通の段落はminor paraです。
+
+行内コード`aaa`を確かめます。
+
+# これは見出しです
+
+生のHTMLリンク https://example.com です。
+生のHTMLリンク <https://example.com> です。
+
+これは著作情報 Copyright (C) gemmaro です。
+
+これは電子メール<gemmaro.dev@gmail.com>です。

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elisp2any
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - gemmaro
@@ -46,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -60,6 +61,7 @@ files:
 - lib/elisp/heading.rb
 - lib/elisp/parser.rb
 - lib/elisp/version.rb
+- sample.md
 homepage: https://codeberg.org/gemmaro/elisp2any
 licenses:
 - GPL-3.0-or-later
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Converter from Emacs Lisp to some document markup
 test_files: []