yard-fence 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cab9d088b1349a451adc56f4b43e267d8c94844044812b66c5a57eed3289148b
-  data.tar.gz: d53f16b1762b761fa412527e325fccf3f0d2338d8d90e08f1b08a578d7f42ce2
+  metadata.gz: 5baded4374cd088861f834e9979c206e08dac16af4c52fdbf3d28ea1e7ce8c58
+  data.tar.gz: bf14fe77229b435e7361883d6dd6128bcff08f58ed8a7742fb88eb9223148a2d
 SHA512:
-  metadata.gz: 164bcdf2a12d36a560ee1da0588de321822d16861e1b7c3ceed37bc1ec4a0bae89818b43fdb065ba8285a8512e9429ad5d21c2ab9a1fadfa2badfb627fe727a8
-  data.tar.gz: f92d68174febc61638fb8c7537882062aafa9547f6afdfa2299e9937d861ba0e4ca67a1c1efccba3d5d6d969b6e5ce5742fac335e510036eaa26a2c1b6e49225
+  metadata.gz: 0c10875a2282e3e6613bdc39bcf37b5aa3507489a5f94406ded819765e3a9feb3ab1581c8a9a3e9c4b11e22564bafb0c7f137db6f7f038248e4d59827080cbdf
+  data.tar.gz: fae576e37e8f9c840bb5e6c772cfdfa7e8eb5e3a065ae9c3deda8d23860595a6827f52f529ae7d12944be2321d4fe0a74753e752505b8b2574a4df49704f1803

data/CHANGELOG.md

@@ -30,6 +30,17 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [0.3.0] - 2025-11-07
+
+- TAG: [v0.3.0][0.3.0t]
+- COVERAGE: 96.43% -- 81/84 lines in 4 files
+- BRANCH COVERAGE: 93.75% -- 15/16 branches in 4 files
+- 29.17% documented
+
+### Added
+
+- yard/fence/hoist.rb: Hoisting the customized GFM kramdown parser
+
 ## [0.2.0] - 2025-11-07
 
 - TAG: [v0.2.0][0.2.0t]
@@ -51,6 +62,8 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/galtzo-floss/yard-fence/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.2.0...v0.3.0
+[0.3.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.3.0
 [0.2.0]: https://github.com/galtzo-floss/yard-fence/compare/v0.1.0...v0.2.0
 [0.2.0t]: https://github.com/galtzo-floss/yard-fence/releases/tag/v0.2.0

data/README.md

@@ -56,6 +56,22 @@ Just the important bits:
 - Prioritizes Kramdown's GFM parser so tables and fenced code blocks render correctly.
 - After YARD finishes generating HTML, restores fullwidth braces back to normal ASCII braces so code examples are copy‑pastable.
 
+Create a `.yardopts` file like this:
+
+```text
+--plugin fence
+-e yard/fence/hoist.rb
+--readme tmp/README.md
+--markup markdown
+--output docs
+'lib/**/*.rb'
+-
+'tmp/*.md'
+'tmp/*.txt'
+```
+
+See the configuration and usage sections for more details.
+
 ## 💡 Info you can shake a stick at
 
 | Tokens to Remember      | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace]                                                                                                                                                                                                                                                                          |
@@ -175,7 +191,7 @@ Recommended .yardopts (noise‑free):
 
 ```text
 --plugin fence
--e 'Yard::Fence.use_kramdown_gfm!'
+-e yard/fence/hoist.rb
 --readme tmp/README.md
 --markup markdown
 --output docs
@@ -195,7 +211,7 @@ CLI example that would be similar to what is accomplished by the `.yardopts` fro
 ```bash
 yard doc \
   --plugin fence \
-  -e 'Yard::Fence.use_kramdown_gfm!' \
+  -e yard/fence/hoist.rb \
   --readme tmp/README.md \
   lib/**/*.rb - tmp/*.md tmp/*.txt
 ```

data/lib/yard/fence/hoist.rb

@@ -0,0 +1,9 @@
+if defined?(Yard::Fence) && Yard::Fence.respond_to?(:use_kramdown_gfm!)
+  if Yard::Fence.use_kramdown_gfm!
+    puts "[yard/fence/hoist] Kramdown GFM provider registered"
+  else
+    warn "[yard/fence/hoist] Kramdown GFM provider registration failed"
+  end
+else
+  warn("[yard/fence/hoist] Yard::Fence.use_kramdown_gfm! not available; skipping")
+end

data/lib/yard/fence/version.rb

@@ -3,7 +3,7 @@
 module Yard
   module Fence
     module Version
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
     VERSION = Version::VERSION
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-fence
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter H. Boling
@@ -306,6 +306,7 @@ files:
 - SECURITY.md
 - lib/yard-fence.rb
 - lib/yard/fence.rb
+- lib/yard/fence/hoist.rb
 - lib/yard/fence/kramdown_gfm_document.rb
 - lib/yard/fence/version.rb
 - sig/kramdown.rbs
@@ -315,10 +316,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://yard-fence.galtzo.com/
-  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.2.0
-  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.2.0/CHANGELOG.md
+  source_code_uri: https://github.com/galtzo-floss/yard-fence/tree/v0.3.0
+  changelog_uri: https://github.com/galtzo-floss/yard-fence/blob/v0.3.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/yard-fence/issues
-  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.2.0
+  documentation_uri: https://www.rubydoc.info/gems/yard-fence/0.3.0
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/galtzo-floss/yard-fence/wiki
   news_uri: https://www.railsbling.com/tags/yard-fence