hiki2md 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 75c588c94f143ff7531246991a1f1cd286e4d22d
-  data.tar.gz: 9acce914fec1459b92dac42914badf6b4861bff6
+SHA256:
+  metadata.gz: 9b4d6cfffb000735e6110b7f97177fed422bd998b1ea8d07672ee0965f0232f8
+  data.tar.gz: 92ac94a769691e6bd4a7662bb0b33adcc7b6036d720f5d7171b21c08511a6954
 SHA512:
-  metadata.gz: 81094c8d50da145dfd50b7ac42a1965404e87302185beeaa156f7f9e5d0f2162fe6a5a1ed3ac593c0c8e16bc7713b2470327c3cad59633c38dc5a48595634575
-  data.tar.gz: 0b862ccd85bcd0f374a89b06a2b4abf5bbde43ed965e6723b6e1df1d1f099a3c27f0de8fddfed40f7ef370cc974c69de742ee2b69c89be180297014d3a54b70b
+  metadata.gz: fc77e072352a1a301871154af34120ccf5a32bb0857019e92132a0867a972c7ff918f53915a062fc3317b1c702b1512dfdc25889f9f590c0b18f28c883c80820
+  data.tar.gz: 3c6df53740b623b39bb5f20e11d314a6f6de3f251cfced2e7f7bb596d98f2a67d4cf04573bb58f3179510ee80d1ac1f018489fc7bc6ed81cc9ae3d82084a66be

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+dist: jammy
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 3.1
+  - 3.4
+before_install: gem install bundler -v 2.6.8

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    hiki2md (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    rake (13.3.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  bundler
+  hiki2md!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.6.8

data/README.md

@@ -6,6 +6,8 @@ Converter of Hiki to Markdown.
 
 ## Installation
 
+Hiki2md requires Ruby 2.2 or newer.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,7 +24,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Ruby
+
+```ruby
+require "hiki2md"
+
+converter = Hiki2md.new(
+  interwiki_map: {
+    "Google" => "https://www.google.com/search?q=",
+    "Issues" => "https://example.com/issues/$1"
+  },
+  use_wiki_name: true,
+  preserve_plugins: false
+)
+
+markdown = converter.convert(hiki_source)
+```
+
+Internal page links receive a `.md` extension. InterWiki values either have
+the encoded page name appended, or can contain `$1` where the page name should
+be inserted.
+
+### Command line
+
+```console
+$ hiki2md [options] input.hiki
+```
+
+Options:
+
+- `--interwiki-map PATH`: load InterWiki prefixes from a YAML mapping.
+- `--[no-]wiki-name`: enable or disable automatic WikiName links.
+- `--preserve-plugins`: retain plugins as escaped Markdown text instead of
+  removing them.
+
+### Supported Hiki syntax
+
+The converter targets Hiki's default style and emits GitHub Flavored Markdown
+(GFM).
+
+| Hiki | Output |
+| --- | --- |
+| `!` through `!!!!!` | headings 2 through 6 |
+| `*` / `#` | nested unordered / ordered lists |
+| `''text''` / `'''text'''` | emphasis / strong emphasis |
+| `==text==` / double-backtick text | strikethrough / inline code |
+| `[[Page]]` / `[[label\|target]]` | page, URL, and InterWiki links |
+| image URLs | Markdown images, including basename or labeled alt text |
+| leading space or tab, `<<<` ... `>>>` | fenced code blocks |
+| `""` | recursive blockquotes |
+| `:term:description` | HTML definition lists |
+| `\|\|cell` | raw HTML tables |
+| `----` | horizontal rules |
+| `// comment` | removed comments |
+
+Hiki permits tables without a header row, while GFM pipe tables require one.
+All Hiki tables are therefore emitted as raw HTML so ordinary `td` cells,
+explicit `!` header cells, and `^` / `>` row and column spans retain their
+meaning.
+
+Hiki plugins are executable Ruby extensions and cannot be converted
+generically. Plugin calls are removed by default. Use `preserve_plugins: true`
+or `--preserve-plugins` to keep them as escaped Markdown text for manual
+migration. Plugin-looking text inside preformatted blocks is always kept
+literally.
+
+### Version 0.3 output changes
+
+Version 0.3 favors the rendered meaning of Hiki over preserving the exact
+Markdown source produced by 0.2. In particular, all tables now use raw HTML,
+ordered-list indentation follows CommonMark, and Markdown-looking source text
+is escaped when Hiki treats it as plain text. The legacy public `make_matrix`
+and `make_table` helpers retain their 0.2 behavior.
+
+Lists deeper than 100 levels use raw HTML to keep output growth bounded.
+Uniform blockquotes may be arbitrarily deep; blocks containing more than 100
+distinct quote depths raise `ArgumentError` instead of risking stack or CPU
+exhaustion.
+
+See Hiki's
+[TextFormattingRules](https://hikiwiki.org/en/TextFormattingRules.html) for
+the source syntax.
 
 ## Development
 
@@ -40,4 +122,3 @@ The gem is available as open source under the terms of the [MIT License](http://
 ## Inspired by
 
 https://github.com/masasuzu/p5-App-hiki2md
-

data/exe/hiki2md

@@ -1,12 +1,45 @@
 #!/usr/bin/env ruby
 require 'hiki2md'
+require 'optparse'
+require 'yaml'
+
+interwiki_map = {}
+use_wiki_name = true
+preserve_plugins = false
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: hiki2md [options] <file>"
+
+  opts.on("--interwiki-map PATH", "Path to a YAML file for InterWiki definitions") do |path|
+    if File.exist?(path)
+      interwiki_map.merge!(YAML.load_file(path))
+    else
+      raise IOError.new("InterWiki map file not found: #{path}")
+    end
+  end
+
+  opts.on("--[no-]wiki-name", "Enable or disable WikiName autolinking") do |enabled|
+    use_wiki_name = enabled
+  end
+
+  opts.on("--preserve-plugins", "Keep Hiki plugins as escaped Markdown text") do
+    preserve_plugins = true
+  end
+end.parse!
 
 if ARGV.size != 1
   raise ArgumentError.new("no file specified")
 end
 
-if !File.exist?(ARGV[0])
-  raise IOError.new("no exist #{ARGV[0]}")
+input_file = ARGV[0]
+
+if !File.exist?(input_file)
+  raise IOError.new("no exist #{input_file}")
 end
 
-puts Hiki2md.new.convert(File.read(ARGV[0]))
+hiki2md = Hiki2md.new(
+  interwiki_map: interwiki_map,
+  use_wiki_name: use_wiki_name,
+  preserve_plugins: preserve_plugins
+)
+puts hiki2md.convert(File.read(input_file))

data/hiki2md.gemspec

@@ -12,13 +12,14 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Converter of Hiki to Markdown}
   spec.homepage      = "http://github.com/kdmsnr/hiki2md"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.2.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/hiki2md/version.rb

@@ -1,3 +1,3 @@
 class Hiki2md
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end