yard-markdown 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e14595e84affb837da2c36afb9a40f0e7ea866472fa32e5aefabc7c32c2ec8
-  data.tar.gz: 605f1ad9c9496ebaf48afc7245ab25db98b5e22aed88c7c718bb3968f78b3b5e
+  metadata.gz: 20eaf2ccb5ab45418bcb82e961f472231fb5d705090e8650dd854a8cc0e1d92f
+  data.tar.gz: ec1a4f6d7f3afa2f7af44c44a72af9ba6a22148ffeb643dda1ffbb747a0cf1ee
 SHA512:
-  metadata.gz: '0887584b2fe63298271fad1483237eb303d215068a6da79aee7cb59c463a6c2838a6a72171676e7876f7a7d8c9003c0e23eb0fcb9dbfd88e329f028c5907bdef'
-  data.tar.gz: 9d50e908447b65b564315c996af01a43e35d360f2bafd600d34197ed20fc0cf8fde1b506850eb2fd476ee65d33c44ff10de8658abcd51037011060d4e69ec59f
+  metadata.gz: ea0c103943a5b5361ecab753fa0d014835016a6a154bb77552e7c8d3c1f253eea2a8c62c2aafe2d7f72afd31dfe5cac763c864a7768cd0126bc229ba8f19ace4
+  data.tar.gz: 0f2ade24652236aef7cfb310cafe04f1f0dcc43a5bccba854ec9712d0a7edb752d91a6f85b723a8c5e19e66aff798ff2cbf669b4e5401f33f2f18c66875e8dd3

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - "example_*.rb"
+  - "test/example/example.rb"

data/AGENTS.md

@@ -40,15 +40,15 @@ the user.
   No `expressions:` filters, no `coverage_criteria:` tweaks.
 - You may not use `send` or `__send__` to invoke private methods
   in tests just to satisfy mutant.
-- You may not stub or mock the system under test (`Age`).
+- You may not stub or mock the system under test.
 
 ## Done
 
-You are done when both of these are green and don't return any offenses:
+You are done when all of these commands are green and don't return any offenses:
 
 ```
 SIMPLECOV=1 bundle exec rake test
 bundle exec mutant run
 bundle exec rake markdown:validate_real_world
-yard-lint lib/
+yard-lint
 ```

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## Unreleased
 
+## 0.7.1
+
+### Fixed
+- Preserve fenced code blocks in YARD docstrings so generated Markdown examples render correctly.
+
 ## 0.7.0
 ## Added
 - Adding yard-lint and all method documentation
@@ -14,4 +19,3 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ## Changed
 - Refactoring and simplification of teamplate, mostly driven by mutantion testing
 - Improve documentation for entire project
-

data/README.md

@@ -12,15 +12,6 @@ It's a pitty that rdoc and yard can't output a proper markdown file. I would lik
 - Mimick yard html layout where it makes sense to maintain familiarity
 
 ## Usage
-Yard doesn't load plugin by default, so you need to load plugin through `~/.yard/config`:
-
-```yaml
-!!!yaml
-load_plugins: true
-autoload_plugins:
-  - markdown
-```
-
 Install a plugin
 ```
 gem install yard-markdown
@@ -28,20 +19,32 @@ gem install yard-markdown
 
 Run `yardoc --format=markdown` to generate markdown documentation.
 
-## Note on RDoc support
+## FAQ
+
+### Note on RDoc support
 It seems important to note, that yard claims to have support for RDoc. That support is certainly present, but output for rdoc is dramatically different. A lot of useful information seems lost in the process.
 
 If you know how to improve that, please get in touch or submit a patch.
 
 So in meantime, there is work going on a competing gem for RDoc and it's called [rdoc-markdown gem](https://github.com/skatkov/rdoc-markdown/).
 
-## Note on index.csv file
+### Note on index.csv file
 This gem emits index of all markdown files in a index.csv file.
 
 There are decent tools that offer search through structured plain-text files. But my expectation is that nobody will use CSV as an actual search index, but rather import it into something that performs this function better.
 
 In my personal use-case, I use SQLite. All other databases seem to have a good support for CSV imports.
 
+### Yard doesn't load plugin properly? 
+so you need to load plugin through `~/.yard/config`:
+
+```yaml
+!!!yaml
+load_plugins: true
+autoload_plugins:
+  - markdown
+```
+
 ## Testing
 Unit tests verify renderer behavior, index links, and anchor consistency for both YARD-style and RDoc-style sources.
 

data/Rakefile

@@ -64,7 +64,7 @@ def run_command_with_analysis(command, label:)
 
   details = ["#{label} failed output checks (log: #{log_path})"]
   details << "exit status: #{status.exitstatus}" unless status.success?
-  details << "errors: #{combined_analysis[:errors].first(5).join(' | ')}" unless combined_analysis[:errors].empty?
+  details << "errors: #{combined_analysis[:errors].first(5).join(" | ")}" unless combined_analysis[:errors].empty?
   raise details.join("\n")
 end
 
@@ -113,7 +113,6 @@ def ensure_clean_generated_file(path)
   raise "#{path} is out of date. Run `bundle exec rake types:generate` and commit the updated file."
 end
 
-
 namespace :examples do
   desc "Generate basic example documentation using yard-markdown plugin"
   task :generate do
@@ -133,28 +132,28 @@ namespace :examples do
 end
 
 namespace :real_world do
-  REPOS_DIR = "tmp/real-world/repos"
-  RSPEC_REPO = "#{REPOS_DIR}/rspec-core"
-  SIDEKIQ_REPO = "#{REPOS_DIR}/sidekiq"
+  repos_dir = "tmp/real-world/repos"
+  rspec_repo = "#{repos_dir}/rspec-core"
+  sidekiq_repo = "#{repos_dir}/sidekiq"
 
   desc "Checkout rspec-core repository"
   task :checkout_rspec do
-    checkout_repo("https://github.com/rspec/rspec-core.git", RSPEC_REPO, ref: "v3.13.2")
+    checkout_repo("https://github.com/rspec/rspec-core.git", rspec_repo, ref: "v3.13.2")
   end
 
   desc "Checkout sidekiq repository"
   task :checkout_sidekiq do
-    checkout_repo("https://github.com/sidekiq/sidekiq.git", SIDEKIQ_REPO, ref: "v7.3.10")
+    checkout_repo("https://github.com/sidekiq/sidekiq.git", sidekiq_repo, ref: "v7.3.10")
   end
 
   desc "Generate markdown docs for rspec-core"
   task rspec: :checkout_rspec do
-    generate_markdown_docs("#{RSPEC_REPO}/lib", "tmp/real-world/rspec-core")
+    generate_markdown_docs("#{rspec_repo}/lib", "tmp/real-world/rspec-core")
   end
 
   desc "Generate markdown docs for sidekiq"
   task sidekiq: :checkout_sidekiq do
-    generate_markdown_docs("#{SIDEKIQ_REPO}/lib", "tmp/real-world/sidekiq")
+    generate_markdown_docs("#{sidekiq_repo}/lib", "tmp/real-world/sidekiq")
   end
 
   desc "Generate markdown docs for rspec-core and sidekiq"

data/config/mutant.yml

@@ -12,14 +12,4 @@ requires:
 
 matcher:
   subjects:
-    - YARD::Markdown::AnchorComponentHelper#
-    - YARD::Markdown::ArefHelper#
-    - YARD::Markdown::CollectionRenderingHelper#
-    - YARD::Markdown::DocumentationHelper#
-    - YARD::Markdown::HeadingHelper#
-    - YARD::Markdown::LinkNormalizationHelper#
-    - YARD::Markdown::MethodPresentationHelper#
-    - YARD::Markdown::ObjectListingHelper#
-    - YARD::Markdown::RelationshipSectionHelper#
-    - YARD::Markdown::SectionAssemblyHelper#
-    - YARD::Markdown::TagFormattingHelper#
+    - YARD::Markdown*

data/example_rdoc.rb

@@ -133,7 +133,6 @@ end
 DEFAULT_DUCK_VELOCITY = 70
 DEFAULT_SPEED = 10 # Maximum speed for a swimming duck.
 
-
 # Default rubber duck.
 #
 # *Note:*

data/example_yard.rb

@@ -142,4 +142,4 @@ $default_wild_salmon = Salmon.new(false, true)
 # Farmed sustainable salmon.
 #
 # @note This is just a local variable for demonstration purposes.
-farmed_sustainable_salmon = Salmon.new(true, false)
+Salmon.new(true, false)

data/lib/yard/markdown/anchor_component_helper.rb

@@ -12,7 +12,7 @@ module YARD
       # @return [String] Anchor-safe identifier fragment.
       def anchor_component(value)
         value.to_s.each_char.map do |char|
-          char.match?(/[A-Za-z0-9_-]/) ? char : format('-%X', char.ord)
+          char.match?(/[A-Za-z0-9_-]/) ? char : format("-%X", char.ord)
         end.join
       end
     end

data/lib/yard/markdown/aref_helper.rb

@@ -13,12 +13,12 @@ module YARD
       def aref(object)
         type = object.type
 
-        return "class-#{object.path.gsub('::', '-')}" if type == :class
-        return "module-#{object.path.gsub('::', '-')}" if type == :module
+        return "class-#{object.path.gsub("::", "-")}" if type == :class
+        return "module-#{object.path.gsub("::", "-")}" if type == :module
         return "constant-#{object.name}" if type == :constant
         return "classvariable-#{anchor_component(object.name)}" if type == :classvariable
 
-        scope = object.scope == :class ? 'c' : 'i'
+        scope = (object.scope == :class) ? "c" : "i"
 
         if !object.attr_info.nil?
           "attribute-#{scope}-#{object.name}"

data/lib/yard/markdown/collection_rendering_helper.rb

@@ -10,16 +10,16 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for group headings.
       # @return [String] Markdown for the constants section.
       def render_constants(constants, group_order)
-        lines = ['## Constants']
+        lines = ["## Constants"]
         grouped_constants = grouped_items(constants.sort_by { |item| item.name }, group_order)
         uses_groups = grouped_constants.any? { |name, _items| !name.nil? }
 
         grouped_constants.each do |group_name, items|
           if uses_groups
-            lines << "### #{group_name || 'General'}"
-            item_heading = '####'
+            lines << "### #{group_name || "General"}"
+            item_heading = "####"
           else
-            item_heading = '###'
+            item_heading = "###"
           end
 
           lines << items.map { |item|
@@ -39,16 +39,16 @@ module YARD
       # @param group_order [Array<String>, nil] Preferred ordering for group headings.
       # @return [String] Markdown for the attributes section.
       def render_attributes(attrs, group_order)
-        lines = ['## Attributes']
+        lines = ["## Attributes"]
         grouped_attrs = grouped_items(attrs, group_order)
         uses_groups = grouped_attrs.any? { |name, _items| !name.nil? }
 
         grouped_attrs.each do |group_name, items|
           if uses_groups
-            lines << "### #{group_name || 'General'}"
-            item_heading = '####'
+            lines << "### #{group_name || "General"}"
+            item_heading = "####"
           else
-            item_heading = '###'
+            item_heading = "###"
           end
 
           lines << items.map { |item|
@@ -75,10 +75,10 @@ module YARD
 
         grouped_methods.each do |group_name, items|
           if uses_groups
-            lines << "### #{group_name || 'General'}"
-            item_heading = '####'
+            lines << "### #{group_name || "General"}"
+            item_heading = "####"
           else
-            item_heading = '###'
+            item_heading = "###"
           end
 
           lines << items.map { |item|

data/lib/yard/markdown/documentation_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rdoc'
+require "rdoc"
 
 module YARD
   module Markdown
@@ -13,9 +13,9 @@ module YARD
       def documented_text(object)
         text = rdoc_to_md(object.docstring)
         return text unless text.empty?
-        return '' unless object.tags.empty?
+        return "" unless object.tags.empty?
 
-        'Not documented.'
+        "Not documented."
       end
 
       # Converts an RDoc-formatted docstring to Markdown.
@@ -23,7 +23,19 @@ module YARD
       # @param docstring [Object] Raw docstring content.
       # @return [String] Markdown-rendered docstring content.
       def rdoc_to_md(docstring)
-        RDoc::Markup::ToMarkdown.new.convert(docstring).rstrip
+        fenced_code_blocks = []
+        placeholder = "YARD_MARKDOWN_FENCED_CODE_BLOCK_%d"
+        content = docstring.gsub(/^```[^\n]*\n.*?^```[ \t]*$/m) do |block|
+          fenced_code_blocks << block
+          format(placeholder, fenced_code_blocks.length - 1)
+        end
+
+        markdown = RDoc::Markup::ToMarkdown.new.convert(content).rstrip
+        fenced_code_blocks.each_with_index do |block, index|
+          markdown = markdown.sub(format(placeholder, index), block)
+        end
+
+        markdown
       end
     end
   end

data/lib/yard/markdown/heading_helper.rb

@@ -37,7 +37,7 @@ module YARD
       # @param object [YARD::CodeObjects::Base] Object being rendered.
       # @return [String] Heading text with embedded anchor tags.
       def heading_with_anchors(heading, object)
-        "#{heading} #{anchor_tags_for(object).join(' ')}"
+        "#{heading} #{anchor_tags_for(object).join(" ")}"
       end
 
       # Builds an HTML anchor tag for a generated id.

data/lib/yard/markdown/link_normalization_helper.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'pathname'
-
 module YARD
   module Markdown
     # Rewrites generated Markdown links so they point at Markdown output.
@@ -31,12 +29,12 @@ module YARD
         markdown.gsub(%r{\[(.+?)\]\((?!https?://|mailto:|#)([^)\n]+)\)}) do
           label = Regexp.last_match(1)
           target = Regexp.last_match(2)
-          path = target.sub(/[?#].*\z/, '')
+          path = target.sub(/[?#].*\z/, "")
           suffix = target[path.length..]
           rewritten_path = resolve_local_link_target(path, current_dir)
 
           if rewritten_path.nil?
-            "`#{label.tr('`', '')}`"
+            "`#{label.tr("`", "")}`"
           else
             "[#{label}](#{rewritten_path}#{suffix})"
           end
@@ -49,15 +47,15 @@ module YARD
       # @param current_dir [Pathname] Directory for the current output file.
       # @return [YARD::CodeObjects::Base, nil] Matched registry object, if any.
       def resolve_registry_object(path, current_dir)
-        cleaned = path.sub(%r{\A(?:(?:\.\./)+|\./)}, '')
+        cleaned = path.sub(%r{\A(?:(?:\.\./)+|\./)}, "")
         candidates = [path]
 
         if constant_reference_path?(cleaned)
-          current_parts = current_dir.to_s.split('/').reject { |part| part.empty? || part == '.' }
-          target_parts = cleaned.split('/')
+          current_parts = current_dir.to_s.split("/").reject { |part| part.empty? || part == "." }
+          target_parts = cleaned.split("/")
 
           current_parts.length.downto(0) do |depth|
-            candidates << (current_parts.first(depth) + target_parts).join('::')
+            candidates << (current_parts.first(depth) + target_parts).join("::")
           end
         end
 
@@ -77,7 +75,7 @@ module YARD
       # @param current_dir [Pathname] Directory for the current output file.
       # @return [String, nil] Relative Markdown path, or nil when unresolved.
       def resolve_local_link_target(path, current_dir)
-        normalized = path.sub(%r{\A/+}, '')
+        normalized = path.sub(%r{\A/+}, "")
 
         obj = resolve_registry_object(normalized, current_dir)
         if obj
@@ -86,11 +84,11 @@ module YARD
         end
 
         if normalized.match?(/\.html\z/i)
-          normalized = normalized.sub(/\.html\z/i, '.md')
+          normalized = normalized.sub(/\.html\z/i, ".md")
         elsif File.extname(normalized).empty?
           return nil if unresolved_identifier_target?(normalized)
 
-          normalized = "#{normalized}.md" if normalized.include?('/')
+          normalized = "#{normalized}.md" if normalized.include?("/")
         end
 
         relative_output_path(current_dir, normalized)
@@ -112,8 +110,8 @@ module YARD
       # @param path [String] Link target to inspect.
       # @return [Boolean] True when the target should be treated as unresolved.
       def unresolved_identifier_target?(path)
-        cleaned = path.sub(%r{\A(?:(?:\.\./)+|\./)}, '')
-        return true if cleaned.start_with?(':') || cleaned.match?(/\A\d/)
+        cleaned = path.sub(%r{\A(?:(?:\.\./)+|\./)}, "")
+        return true if cleaned.start_with?(":") || cleaned.match?(/\A\d/)
 
         cleaned.match?(/\A[a-z_]\w*\z/)
       end
@@ -125,10 +123,10 @@ module YARD
       # @return [String] Relative path suitable for a Markdown link.
       def relative_output_path(current_dir, target_path)
         target = target_path.to_s
-        return target if target.start_with?('../')
+        return target if target.start_with?("../")
 
         Pathname.new(target).relative_path_from(current_dir).to_s
-      rescue StandardError
+      rescue
         target
       end
 

data/lib/yard/markdown/method_presentation_helper.rb

@@ -11,7 +11,7 @@ module YARD
       def formatted_method_heading(method_object)
         name = method_object.name
         signature = method_signature(method_object)
-        signature = " #{signature}" if name.end_with?(']')
+        signature = " #{signature}" if name.end_with?("]")
         "#{name}#{signature}"
       end
 
@@ -20,13 +20,13 @@ module YARD
       # @param method_object [YARD::CodeObjects::MethodObject] Method being rendered.
       # @return [String] Parenthesized method signature.
       def method_signature(method_object)
-        return '()' if method_object.parameters.nil?
+        return "()" if method_object.parameters.nil?
 
         rendered = method_object.parameters.map do |name, default|
-          default.nil? || default.empty? ? name : "#{name} = #{default}"
+          (default.nil? || default.empty?) ? name : "#{name} = #{default}"
         end
 
-        "(#{rendered.join(', ')})"
+        "(#{rendered.join(", ")})"
       end
 
       # Returns the access marker for an attribute.
@@ -35,14 +35,14 @@ module YARD
       # @return [String] Access mode marker such as `R`, `W`, or `RW`.
       def attribute_access(attribute)
         info = attribute.attr_info || {}
-        return 'RW' if info[:read] && info[:write]
-        return 'R' if info[:read]
-        return 'W' if info[:write]
+        return "RW" if info[:read] && info[:write]
+        return "R" if info[:read]
+        return "W" if info[:write]
 
-        return 'RW' if attribute.reader? && attribute.writer?
-        return 'R' if attribute.reader?
+        return "RW" if attribute.reader? && attribute.writer?
+        return "R" if attribute.reader?
 
-        'W'
+        "W"
       end
     end
   end

data/lib/yard/markdown/object_listing_helper.rb

@@ -80,7 +80,7 @@ module YARD
       # @param object [YARD::CodeObjects::Base] Listed object whose docstring may start with `:nodoc:`.
       # @return [Boolean] True when the object should be hidden.
       def hidden_object?(object)
-        object.docstring.lstrip.start_with?(':nodoc:')
+        object.docstring.start_with?(":nodoc:")
       end
     end
   end

data/lib/yard/markdown/relationship_section_helper.rb

@@ -10,7 +10,7 @@ module YARD
       # @return [String] Section content followed by blank-line spacing.
       def render_section_content(content)
         text = content.to_s.strip
-        return '' if text.empty?
+        return "" if text.empty?
 
         "#{text}\n\n"
       end
@@ -24,11 +24,11 @@ module YARD
 
         lines << "**Inherits:** `#{object.superclass}`" if object.instance_of?(CodeObjects::ClassObject)
 
-        [[:class, 'Extended by'], [:instance, 'Includes']].each do |scope, label|
+        [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, label|
           mixins = run_verifier(object.mixins(scope)).sort_by { |item| item.path }
           next if mixins.empty?
 
-          lines << "**#{label}:** #{mixins.map { |mixin| "`#{mixin.path}`" }.join(', ')}"
+          lines << "**#{label}:** #{mixins.map { |mixin| "`#{mixin.path}`" }.join(", ")}"
         end
 
         lines.join("\n")

data/lib/yard/markdown/section_assembly_helper.rb

@@ -38,7 +38,7 @@ module YARD
       def append_lines(lines, content, separated: true)
         return if content.lstrip.empty?
 
-        lines << '' if separated && !lines.empty? && !lines.last.empty?
+        lines << "" if separated && !lines.empty? && !lines.last.empty?
         lines.concat(content.split("\n"))
       end
     end

data/lib/yard/markdown/tag_formatting_helper.rb

@@ -10,8 +10,8 @@ module YARD
       # @return [String] Markdown representation of the object's tags.
       def render_tags(object)
         lines = []
-        regular_tags = object.tags.reject { |tag| tag.tag_name == 'example' }
-        example_tags = object.tags.select { |tag| tag.tag_name == 'example' }
+        regular_tags = object.tags.reject { |tag| tag.tag_name == "example" }
+        example_tags = object.tags.select { |tag| tag.tag_name == "example" }
 
         regular_tags.each do |tag|
           lines << "- #{format_tag(tag)}"
@@ -19,11 +19,11 @@ module YARD
 
         example_tags.each do |tag|
           lines << nil unless lines.empty?
-          title = tag.name.to_s.rstrip.empty? ? '**@example**' : "**@example #{tag.name}**"
+          title = tag.name.to_s.rstrip.empty? ? "**@example**" : "**@example #{tag.name}**"
           lines << title
-          lines << '```ruby'
+          lines << "```ruby"
           lines << tag.text.to_s.rstrip
-          lines << '```'
+          lines << "```"
         end
 
         lines.join("\n")
@@ -38,10 +38,10 @@ module YARD
         parts << "`#{tag.name}`" unless tag.name.to_s.lstrip.empty?
 
         cleaned_types = normalized_tag_types(tag.types)
-        parts << "[#{cleaned_types.join(', ')}]" unless cleaned_types.empty?
+        parts << "[#{cleaned_types.join(", ")}]" unless cleaned_types.empty?
         parts << tag.text.strip unless tag.text.to_s.lstrip.empty?
 
-        parts.join(' ')
+        parts.join(" ")
       end
 
       # Normalizes tag type declarations into printable strings.
@@ -50,10 +50,10 @@ module YARD
       # @return [Array<String>] Cleaned type strings.
       def normalized_tag_types(types)
         values = if types.instance_of?(Hash)
-                   types.map { |name, value| format_hash_tag_type(name, value) }
-                 else
-                   Array(types)
-                 end
+          types.map { |name, value| format_hash_tag_type(name, value) }
+        else
+          Array(types)
+        end
 
         values.map(&:to_s).map(&:strip).reject(&:empty?)
       end

data/sig/yard/markdown.rbs

@@ -11,14 +11,14 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Anchor id for the object's heading.
-      def aref: (untyped object) -> String
+      def aref: (Object object) -> String
 
       # Encodes a value so it can be embedded safely in an HTML anchor id.
       # 
       # _@param_ `value` — Raw anchor fragment to encode.
       # 
       # _@return_ — Anchor-safe identifier fragment.
-      def anchor_component: (Object value) -> String
+      def anchor_component: () -> String
     end
 
     # Builds headings and legacy anchors for rendered object sections.
@@ -30,14 +30,14 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Legacy anchor id, if supported.
-      def legacy_aref: (untyped object) -> String?
+      def legacy_aref: (Object object) -> String?
 
       # Returns all anchor tags that should be attached to a heading.
       # 
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — HTML anchor tags for the object.
-      def anchor_tags_for: (untyped object) -> ::Array[String]
+      def anchor_tags_for: (Object object) -> Symbol
 
       # Appends the generated anchor tags to a Markdown heading.
       # 
@@ -46,7 +46,7 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Heading text with embedded anchor tags.
-      def heading_with_anchors: (String heading, untyped object) -> String
+      def heading_with_anchors: (String heading, Object object) -> String
 
       # Builds an HTML anchor tag for a generated id.
       # 
@@ -60,14 +60,14 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Anchor id for the object's heading.
-      def aref: (untyped object) -> String
+      def aref: () -> String
 
       # Encodes a value so it can be embedded safely in an HTML anchor id.
       # 
       # _@param_ `value` — Raw anchor fragment to encode.
       # 
       # _@return_ — Anchor-safe identifier fragment.
-      def anchor_component: (Object value) -> String
+      def anchor_component: () -> String
     end
 
     # Converts YARD docstrings into Markdown-friendly text.
@@ -77,7 +77,7 @@ module YARD
       # _@param_ `object` — Object whose docstring is being rendered.
       # 
       # _@return_ — Converted documentation text or a fallback message.
-      def documented_text: (untyped object) -> String
+      def documented_text: (Object object) -> String
 
       # Converts an RDoc-formatted docstring to Markdown.
       # 
@@ -94,49 +94,49 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Constants and class variables.
-      def constant_listing: (untyped object) -> ::Array[untyped]
+      def constant_listing: (Object object) -> Symbol
 
       # Returns the visible public methods defined directly on an object.
       # 
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Sorted public methods.
-      def public_method_list: (untyped object) -> ::Array[untyped]
+      def public_method_list: (Object object) -> Symbol
 
       # Returns the public class methods defined directly on an object.
       # 
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Sorted public class methods.
-      def public_class_methods: (untyped object) -> ::Array[untyped]
+      def public_class_methods: (Object object) -> Symbol
 
       # Returns the public instance methods defined directly on an object.
       # 
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Sorted public instance methods.
-      def public_instance_methods: (untyped object) -> ::Array[untyped]
+      def public_instance_methods: (Object object) -> Symbol
 
       # Returns the visible attribute methods for an object.
       # 
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Sorted attribute methods.
-      def attr_listing: (untyped object) -> ::Array[untyped]
+      def attr_listing: (Object object) -> Symbol
 
       # Sorts a listing by scope and case-insensitive name.
       # 
       # _@param_ `list` — Objects to sort.
       # 
       # _@return_ — Sorted objects.
-      def sort_listing: (::Array[untyped] list) -> ::Array[untyped]
+      def sort_listing: (Symbol list) -> Symbol
 
       # Returns whether an object is explicitly hidden with `:nodoc:`.
       # 
       # _@param_ `object` — Listed object whose docstring may start with `:nodoc:`.
       # 
       # _@return_ — True when the object should be hidden.
-      def hidden_object?: (untyped object) -> bool
+      def hidden_object?: (Object object) -> bool
     end
 
     # Formats YARD tags into Markdown list items and fenced examples.
@@ -146,21 +146,21 @@ module YARD
       # _@param_ `object` — Object whose tags are being rendered.
       # 
       # _@return_ — Markdown representation of the object's tags.
-      def render_tags: (untyped object) -> String
+      def render_tags: (Object object) -> String
 
       # Formats a non-example YARD tag as a Markdown list item body.
       # 
       # _@param_ `tag` — Non-example tag being converted into list item text.
       # 
       # _@return_ — Markdown representation of the tag.
-      def format_tag: (untyped tag) -> String
+      def format_tag: (Object tag) -> String
 
       # Normalizes tag type declarations into printable strings.
       # 
       # _@param_ `types` — Raw tag types from YARD.
       # 
       # _@return_ — Cleaned type strings.
-      def normalized_tag_types: ((::Array[Object] | ::Hash[untyped, untyped])? types) -> ::Array[String]
+      def normalized_tag_types: (Symbol? types) -> Symbol
 
       # Formats a hash-style tag type entry.
       # 
@@ -191,7 +191,7 @@ module YARD
       # _@param_ `group_order` — Preferred ordering for named groups.
       # 
       # _@return_ — Ordered pairs of group names and grouped items.
-      def grouped_items: (::Array[untyped] items, ::Array[String]? group_order) -> ::Array[::Array[untyped]]
+      def grouped_items: (Symbol items, Symbol? group_order) -> Symbol
 
       # Appends non-empty content to a mutable list of lines.
       # 
@@ -200,7 +200,7 @@ module YARD
       # _@param_ `content` — Rendered Markdown block to split into lines.
       # 
       # _@param_ `separated` — Whether to insert a blank separator line first.
-      def append_lines: (::Array[String] lines, String content, ?separated: bool) -> void
+      def append_lines: (Symbol lines, String content, ?separated: bool) -> void
     end
 
     # Rewrites generated Markdown links so they point at Markdown output.
@@ -212,7 +212,7 @@ module YARD
       # _@param_ `current_path` — Output path for the current document.
       # 
       # _@return_ — Normalized Markdown content with a trailing newline.
-      def finalize_markdown: ((String | ::Array[String]) content, String current_path) -> String
+      def finalize_markdown: ((String | Symbol) content, String current_path) -> String
 
       # Rewrites local Markdown links relative to the current output path.
       # 
@@ -230,7 +230,7 @@ module YARD
       # _@param_ `current_dir` — Directory for the current output file.
       # 
       # _@return_ — Matched registry object, if any.
-      def resolve_registry_object: (String path, Pathname current_dir) -> untyped?
+      def resolve_registry_object: (String path, Pathname current_dir) -> Object?
 
       # Resolves a local link target to the final relative Markdown path.
       # 
@@ -279,21 +279,21 @@ module YARD
       # _@param_ `method_object` — Method being rendered.
       # 
       # _@return_ — Method heading text.
-      def formatted_method_heading: (untyped method_object) -> String
+      def formatted_method_heading: (Object method_object) -> String
 
       # Returns the rendered parameter list for a method.
       # 
       # _@param_ `method_object` — Method being rendered.
       # 
       # _@return_ — Parenthesized method signature.
-      def method_signature: (untyped method_object) -> String
+      def method_signature: (Object method_object) -> String
 
       # Returns the access marker for an attribute.
       # 
       # _@param_ `attribute` — Attribute reader or writer.
       # 
       # _@return_ — Access mode marker such as `R`, `W`, or `RW`.
-      def attribute_access: (untyped attribute) -> String
+      def attribute_access: (Object attribute) -> String
     end
 
     # Renders grouped Markdown sections for constants, attributes, and methods.
@@ -305,7 +305,7 @@ module YARD
       # _@param_ `group_order` — Preferred ordering for group headings.
       # 
       # _@return_ — Markdown for the constants section.
-      def render_constants: (::Array[untyped] constants, ::Array[String]? group_order) -> String
+      def render_constants: (Symbol constants, Symbol? group_order) -> String
 
       # Renders the attributes section for an object page.
       # 
@@ -314,7 +314,7 @@ module YARD
       # _@param_ `group_order` — Preferred ordering for group headings.
       # 
       # _@return_ — Markdown for the attributes section.
-      def render_attributes: (::Array[untyped] attrs, ::Array[String]? group_order) -> String
+      def render_attributes: (Symbol attrs, Symbol? group_order) -> String
 
       # Renders a method section for an object page.
       # 
@@ -325,7 +325,7 @@ module YARD
       # _@param_ `group_order` — Preferred ordering for group headings.
       # 
       # _@return_ — Markdown for the method section.
-      def render_methods: (String section_title, ::Array[untyped] methods, ::Array[String]? group_order) -> String
+      def render_methods: (String section_title, Symbol methods, Symbol? group_order) -> String
     end
 
     # Renders inheritance and mixin relationship summaries.
@@ -342,7 +342,7 @@ module YARD
       # _@param_ `object` — Object being rendered.
       # 
       # _@return_ — Markdown summary of the object's relationships.
-      def object_relationships: (untyped object) -> String
+      def object_relationships: (Object object) -> String
     end
   end
 end

data/templates/default/fulldoc/markdown/setup.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require 'csv'
+require "csv"
 
-include Helpers::ModuleHelper
-
-include YARD::Markdown::ArefHelper
-include YARD::Markdown::ObjectListingHelper
+class_eval do
+  include YARD::Templates::Helpers::ModuleHelper
+  include YARD::Markdown::ArefHelper
+  include YARD::Markdown::ObjectListingHelper
+end
 
 # Prepares the markdown serializer and renders each object page.
 #
@@ -16,11 +17,11 @@ def init
   options.delete(:objects)
   options.delete(:files)
 
-  options.serializer.extension = 'md'
+  options.serializer.extension = "md"
 
   objects.each do |object|
     Templates::Engine.with_serializer(object, options.serializer) { serialize(object) }
-  rescue StandardError => e
+  rescue => e
     path = options.serializer.serialized_path(object)
     log.error "Exception occurred while generating '#{path}'"
     log.backtrace(e)
@@ -34,7 +35,7 @@ end
 # @param object [YARD::CodeObjects::NamespaceObject] Object whose page will be serialized.
 # @return [String] Rendered markdown for the object.
 def serialize(object)
-  T('module').run(options.merge(object: object))
+  T("module").run(options.merge(object: object))
 end
 
 # Writes the CSV search index for all rendered objects.
@@ -44,16 +45,16 @@ end
 def serialize_index(objects)
   filepath = "#{options.serializer.basepath}/index.csv"
 
-  CSV.open(filepath, 'wb') do |csv|
+  CSV.open(filepath, "wb") do |csv|
     csv << %w[name type path]
 
     objects.each do |object|
       next if object.name == :root
 
       if object.type == :class
-        csv << [object.path, 'Class', options.serializer.serialized_path(object)]
+        csv << [object.path, "Class", options.serializer.serialized_path(object)]
       elsif object.type == :module
-        csv << [object.path, 'Module', options.serializer.serialized_path(object)]
+        csv << [object.path, "Module", options.serializer.serialized_path(object)]
       end
 
       constants = constant_listing(object)
@@ -61,8 +62,8 @@ def serialize_index(objects)
         constants.each do |cnst|
           csv << [
             "#{object.path}.#{cnst.name(false)}",
-            'Constant',
-            (options.serializer.serialized_path(object) + '#' + aref(cnst))
+            "Constant",
+            (options.serializer.serialized_path(object) + "#" + aref(cnst))
           ]
         end
       end
@@ -71,8 +72,8 @@ def serialize_index(objects)
         insmeths.each do |item|
           csv << [
             "#{object.path}.#{item.name(false)}",
-            'Method',
-            options.serializer.serialized_path(object) + '#' + aref(item)
+            "Method",
+            options.serializer.serialized_path(object) + "#" + aref(item)
           ]
         end
       end
@@ -81,8 +82,8 @@ def serialize_index(objects)
         pubmeths.each do |item|
           csv << [
             "#{object.path}.#{item.name(false)}",
-            'Method',
-            options.serializer.serialized_path(object) + '#' + aref(item)
+            "Method",
+            options.serializer.serialized_path(object) + "#" + aref(item)
           ]
         end
       end
@@ -92,8 +93,8 @@ def serialize_index(objects)
       attrs.each do |item|
         csv << [
           "#{object.path}.#{item.name(false)}",
-          'Attribute',
-          options.serializer.serialized_path(object) + '#' + aref(item)
+          "Attribute",
+          options.serializer.serialized_path(object) + "#" + aref(item)
         ]
       end
     end

data/templates/default/module/markdown/setup.rb

@@ -1,33 +1,34 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'rdoc'
-
-include Helpers::ModuleHelper
-include YARD::Markdown::AnchorComponentHelper
-include YARD::Markdown::ArefHelper
-include YARD::Markdown::CollectionRenderingHelper
-include YARD::Markdown::DocumentationHelper
-include YARD::Markdown::HeadingHelper
-include YARD::Markdown::LinkNormalizationHelper
-include YARD::Markdown::MethodPresentationHelper
-include YARD::Markdown::ObjectListingHelper
-include YARD::Markdown::RelationshipSectionHelper
-include YARD::Markdown::SectionAssemblyHelper
-include YARD::Markdown::TagFormattingHelper
+require "rdoc"
+
+class_eval do
+  include YARD::Templates::Helpers::ModuleHelper
+  include YARD::Markdown::AnchorComponentHelper
+  include YARD::Markdown::ArefHelper
+  include YARD::Markdown::CollectionRenderingHelper
+  include YARD::Markdown::DocumentationHelper
+  include YARD::Markdown::HeadingHelper
+  include YARD::Markdown::LinkNormalizationHelper
+  include YARD::Markdown::MethodPresentationHelper
+  include YARD::Markdown::ObjectListingHelper
+  include YARD::Markdown::RelationshipSectionHelper
+  include YARD::Markdown::SectionAssemblyHelper
+  include YARD::Markdown::TagFormattingHelper
+end
 
 # Registers the sections rendered for a namespace markdown page.
 #
 # @return [void]
 def init
   sections :header,
-           :relationships,
-           :docstring_section,
-           :tags_section,
-           :constants_section,
-           :attributes_section,
-           :public_class_methods_section,
-           :public_instance_methods_section
+    :relationships,
+    :docstring_section,
+    :tags_section,
+    :constants_section,
+    :attributes_section,
+    :public_class_methods_section,
+    :public_instance_methods_section
 end
 
 # Renders the template and normalizes markdown for top-level page output.
@@ -89,7 +90,7 @@ end
 # @return [String] Markdown constants section, or an empty string.
 def constants_section
   constants = constant_listing(object).reject { |item| hidden_object?(item) }
-  return '' unless constants.any?
+  return "" unless constants.any?
 
   render_section_content(render_constants(constants, Array(object.groups)))
 end
@@ -99,7 +100,7 @@ end
 # @return [String] Markdown attributes section, or an empty string.
 def attributes_section
   attrs = attr_listing(object).reject { |item| hidden_object?(item) }
-  return '' unless attrs.any?
+  return "" unless attrs.any?
 
   render_section_content(render_attributes(attrs, Array(object.groups)))
 end
@@ -109,9 +110,9 @@ end
 # @return [String] Markdown public class methods section, or an empty string.
 def public_class_methods_section
   methods = public_class_methods(object)
-  return '' unless methods.any?
+  return "" unless methods.any?
 
-  render_section_content(render_methods('Public Class Methods', methods, Array(object.groups)))
+  render_section_content(render_methods("Public Class Methods", methods, Array(object.groups)))
 end
 
 # Renders the public instance methods section when methods are present.
@@ -119,7 +120,7 @@ end
 # @return [String] Markdown public instance methods section, or an empty string.
 def public_instance_methods_section
   methods = public_instance_methods(object)
-  return '' unless methods.any?
+  return "" unless methods.any?
 
-  render_section_content(render_methods('Public Instance Methods', methods, Array(object.groups)))
+  render_section_content(render_methods("Public Instance Methods", methods, Array(object.groups)))
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -59,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".standard.yml"
 - ".streerc"
 - ".yard-lint.yml"
 - ".yardopts"