tsumanne 0.0.2 → 0.0.4

data/sorbet/rbi/gems/{mdl@0.12.0.rbi → mdl@0.15.0.rbi}

@@ -4,133 +4,125 @@
 # This is an autogenerated file for types exported from the `mdl` gem.
 # Please instead update this file by running `bin/tapioca gem mdl`.
 
-# source://mdl//lib/mdl/kramdown_parser.rb#6
-module Kramdown
-  class << self
-    # source://kramdown/2.4.0/lib/kramdown/document.rb#49
-    def data_dir; end
-  end
-end
 
-# source://mdl//lib/mdl/kramdown_parser.rb#7
+# pkg:gem/mdl#lib/mdl/kramdown_parser.rb:6
+module Kramdown; end
+
+# pkg:gem/mdl#lib/mdl/kramdown_parser.rb:7
 module Kramdown::Parser; end
 
 # modified parser class - see comment above
 #
-# source://mdl//lib/mdl/kramdown_parser.rb#9
+# pkg:gem/mdl#lib/mdl/kramdown_parser.rb:9
 class Kramdown::Parser::MarkdownLint < ::Kramdown::Parser::Kramdown
-  # @return [MarkdownLint] a new instance of MarkdownLint
-  #
-  # source://mdl//lib/mdl/kramdown_parser.rb#10
+  # pkg:gem/mdl#lib/mdl/kramdown_parser.rb:10
   def initialize(source, options); end
 end
 
 # Regular kramdown parser, but with GFM style fenced code blocks
 #
-# source://mdl//lib/mdl/kramdown_parser.rb#18
+# pkg:gem/mdl#lib/mdl/kramdown_parser.rb:18
 Kramdown::Parser::MarkdownLint::FENCED_CODEBLOCK_MATCH = T.let(T.unsafe(nil), Regexp)
 
 # Primary MDL container
 #
-# source://mdl//lib/mdl/cli.rb#4
+# pkg:gem/mdl#lib/mdl/formatters/sarif.rb:3
 module MarkdownLint
   class << self
     # Creates hyperlinks in terminal emulators, if available: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
     #
-    # source://mdl//lib/mdl.rb#151
+    # pkg:gem/mdl#lib/mdl.rb:155
     def linkify(text, url); end
 
-    # source://mdl//lib/mdl.rb#144
+    # pkg:gem/mdl#lib/mdl.rb:148
     def printable_id(rule); end
 
-    # source://mdl//lib/mdl.rb#14
+    # pkg:gem/mdl#lib/mdl.rb:15
     def run(argv = T.unsafe(nil)); end
   end
 end
 
 # Our Mixlib::CLI class
 #
-# source://mdl//lib/mdl/cli.rb#6
+# pkg:gem/mdl#lib/mdl/cli.rb:6
 class MarkdownLint::CLI
   include ::Mixlib::CLI
   extend ::Mixlib::CLI::ClassMethods
   extend ::Mixlib::CLI::InheritMethods
 
-  # source://mdl//lib/mdl/cli.rb#110
+  # pkg:gem/mdl#lib/mdl/cli.rb:116
   def run(argv = T.unsafe(nil)); end
 
   class << self
-    # source://mdl//lib/mdl/cli.rb#164
+    # pkg:gem/mdl#lib/mdl/cli.rb:170
     def probe_config_file(path); end
 
-    # source://mdl//lib/mdl/cli.rb#147
+    # pkg:gem/mdl#lib/mdl/cli.rb:153
     def toggle_list(parts, to_sym = T.unsafe(nil)); end
   end
 end
 
-# source://mdl//lib/mdl/cli.rb#9
+# pkg:gem/mdl#lib/mdl/cli.rb:9
 MarkdownLint::CLI::CONFIG_FILE = T.let(T.unsafe(nil), String)
 
 # our Mixlib::Config class
 #
-# source://mdl//lib/mdl/config.rb#5
+# pkg:gem/mdl#lib/mdl/config.rb:5
 module MarkdownLint::Config
   extend ::Mixlib::Config
 
   class << self
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#34
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_context_hashes; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#34
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_context_hashes=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#33
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_context_lists; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#33
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_context_lists=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#32
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_contexts; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#32
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_contexts=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#35
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_parent; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#35
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def config_parent=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#31
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def configurables; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#31
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def configurables=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#30
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def configuration; end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#30
+    # pkg:gem/mdl#lib/mdl/config.rb:6
     def configuration=(_arg0); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#667
+    # pkg:gem/mdl#lib/mdl/config.rb:8
     def style(*args, &block); end
 
-    # source://mixlib-config/3.0.27/lib/mixlib/config.rb#663
+    # pkg:gem/mdl#lib/mdl/config.rb:8
     def style=(value); end
   end
 end
 
 # Representation of the markdown document passed to rule checks
 #
-# source://mdl//lib/mdl/doc.rb#7
+# pkg:gem/mdl#lib/mdl/doc.rb:7
 class MarkdownLint::Doc
   # Create a new document given a string containing the markdown source
   #
-  # @return [Doc] a new instance of Doc
-  #
-  # source://mdl//lib/mdl/doc.rb#29
+  # pkg:gem/mdl#lib/mdl/doc.rb:29
   def initialize(text, ignore_front_matter = T.unsafe(nil)); end
 
   # Returns the actual source line for a given element. You can pass in an
@@ -138,25 +130,25 @@ class MarkdownLint::Doc
   # examine the source line directly for your rule to make use of
   # information that isn't present in the parsed document.
   #
-  # source://mdl//lib/mdl/doc.rb#135
+  # pkg:gem/mdl#lib/mdl/doc.rb:135
   def element_line(element); end
 
   # Returns the line number a given element is located on in the source
   # file. You can pass in either an element object or an options hash here.
   #
-  # source://mdl//lib/mdl/doc.rb#124
+  # pkg:gem/mdl#lib/mdl/doc.rb:124
   def element_linenumber(element); end
 
   # Returns a list of line numbers for all elements passed in. You can pass
   # in a list of element objects or a list of options hashes here.
   #
-  # source://mdl//lib/mdl/doc.rb#143
+  # pkg:gem/mdl#lib/mdl/doc.rb:143
   def element_linenumbers(elements); end
 
   # Returns the actual source lines for a list of elements. You can pass in
   # a list of elements objects or a list of options hashes here.
   #
-  # source://mdl//lib/mdl/doc.rb#151
+  # pkg:gem/mdl#lib/mdl/doc.rb:151
   def element_lines(elements); end
 
   # A list of raw markdown source lines. Note that the list is 0-indexed,
@@ -164,13 +156,18 @@ class MarkdownLint::Doc
   # subtract 1 from a line number to get the correct line. The element_line*
   # methods take care of this for you.
   #
-  # source://mdl//lib/mdl/doc.rb#14
+  # pkg:gem/mdl#lib/mdl/doc.rb:14
   def elements; end
 
+  # Returns the element as plaintext
+  #
+  # pkg:gem/mdl#lib/mdl/doc.rb:274
+  def extract_as_text(element); end
+
   # Extracts the text from an element whose children consist of text
   # elements and other things
   #
-  # source://mdl//lib/mdl/doc.rb#245
+  # pkg:gem/mdl#lib/mdl/doc.rb:245
   def extract_text(element, prefix = T.unsafe(nil), restore_whitespace = T.unsafe(nil)); end
 
   # Find all elements of a given type, returning their options hash. The
@@ -183,7 +180,7 @@ class MarkdownLint::Doc
   # If +nested+ is set to false, this returns only top level elements of a
   # given type.
   #
-  # source://mdl//lib/mdl/doc.rb#67
+  # pkg:gem/mdl#lib/mdl/doc.rb:67
   def find_type(type, nested = T.unsafe(nil)); end
 
   # Find all elements of a given type, returning a list of the element
@@ -195,7 +192,7 @@ class MarkdownLint::Doc
   # If +nested+ is set to false, this returns only top level elements of a
   # given type.
   #
-  # source://mdl//lib/mdl/doc.rb#81
+  # pkg:gem/mdl#lib/mdl/doc.rb:81
   def find_type_elements(type, nested = T.unsafe(nil), elements = T.unsafe(nil)); end
 
   # A variation on find_type_elements that allows you to skip drilling down
@@ -207,7 +204,7 @@ class MarkdownLint::Doc
   # Unlike find_type_elements, this method will always search for nested
   # elements, and skip the element types given to nested_except.
   #
-  # source://mdl//lib/mdl/doc.rb#103
+  # pkg:gem/mdl#lib/mdl/doc.rb:103
   def find_type_elements_except(type, nested_except = T.unsafe(nil), elements = T.unsafe(nil)); end
 
   # Returns the header 'style' - :atx (hashes at the beginning), :atx_closed
@@ -215,13 +212,13 @@ class MarkdownLint::Doc
   # (underlined). You can pass in the element object or an options hash
   # here.
   #
-  # source://mdl//lib/mdl/doc.rb#161
+  # pkg:gem/mdl#lib/mdl/doc.rb:161
   def header_style(header); end
 
   # Returns how much a given line is indented. Hard tabs are treated as an
   # indent of 8 spaces. You need to pass in the raw string here.
   #
-  # source://mdl//lib/mdl/doc.rb#206
+  # pkg:gem/mdl#lib/mdl/doc.rb:206
   def indent_for(line); end
 
   # A list of raw markdown source lines. Note that the list is 0-indexed,
@@ -229,26 +226,26 @@ class MarkdownLint::Doc
   # subtract 1 from a line number to get the correct line. The element_line*
   # methods take care of this for you.
   #
-  # source://mdl//lib/mdl/doc.rb#14
+  # pkg:gem/mdl#lib/mdl/doc.rb:14
   def lines; end
 
   # Returns the list style for a list: :asterisk, :plus, :dash, :ordered or
   # :ordered_paren depending on which symbol is used to denote the list
   # item. You can pass in either the element itself or an options hash here.
   #
-  # source://mdl//lib/mdl/doc.rb#183
+  # pkg:gem/mdl#lib/mdl/doc.rb:183
   def list_style(item); end
 
   # Returns line numbers for lines that match the given regular expression
   #
-  # source://mdl//lib/mdl/doc.rb#213
+  # pkg:gem/mdl#lib/mdl/doc.rb:213
   def matching_lines(regex); end
 
   # Returns line numbers for lines that match the given regular expression.
   # Only considers text inside of 'text' elements (i.e. regular markdown
   # text and not code/links or other elements).
   #
-  # source://mdl//lib/mdl/doc.rb#224
+  # pkg:gem/mdl#lib/mdl/doc.rb:224
   def matching_text_element_lines(regex, exclude_nested = T.unsafe(nil)); end
 
   # A list of raw markdown source lines. Note that the list is 0-indexed,
@@ -256,7 +253,7 @@ class MarkdownLint::Doc
   # subtract 1 from a line number to get the correct line. The element_line*
   # methods take care of this for you.
   #
-  # source://mdl//lib/mdl/doc.rb#14
+  # pkg:gem/mdl#lib/mdl/doc.rb:14
   def offset; end
 
   # A list of raw markdown source lines. Note that the list is 0-indexed,
@@ -264,7 +261,7 @@ class MarkdownLint::Doc
   # subtract 1 from a line number to get the correct line. The element_line*
   # methods take care of this for you.
   #
-  # source://mdl//lib/mdl/doc.rb#14
+  # pkg:gem/mdl#lib/mdl/doc.rb:14
   def parsed; end
 
   private
@@ -272,130 +269,129 @@ class MarkdownLint::Doc
   # Adds a 'level' and 'parent' option to all elements to show how nested they
   # are
   #
-  # source://mdl//lib/mdl/doc.rb#277
+  # pkg:gem/mdl#lib/mdl/doc.rb:301
   def add_annotations(elements, level = T.unsafe(nil), parent = T.unsafe(nil)); end
 
   class << self
     # Alternate 'constructor' passing in a filename
     #
-    # source://mdl//lib/mdl/doc.rb#48
+    # pkg:gem/mdl#lib/mdl/doc.rb:48
     def new_from_file(filename, ignore_front_matter = T.unsafe(nil)); end
   end
 end
 
 # defines a single rule
 #
-# source://mdl//lib/mdl/ruleset.rb#3
+# pkg:gem/mdl#lib/mdl/ruleset.rb:3
 class MarkdownLint::Rule
-  # @return [Rule] a new instance of Rule
-  #
-  # source://mdl//lib/mdl/ruleset.rb#6
-  def initialize(id, description, fallback_docs: T.unsafe(nil), &block); end
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:6
+  def initialize(id, description, fallback_docs: T.unsafe(nil), &_arg3); end
 
-  # source://mdl//lib/mdl/ruleset.rb#27
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:27
   def aliases(*aliases); end
 
-  # source://mdl//lib/mdl/ruleset.rb#17
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:17
   def check(&block); end
 
-  # Returns the value of attribute description.
-  #
-  # source://mdl//lib/mdl/ruleset.rb#4
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:4
   def description; end
 
-  # Sets the attribute description
-  #
-  # @param value the value to set the attribute description to.
-  #
-  # source://mdl//lib/mdl/ruleset.rb#4
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:4
   def description=(_arg0); end
 
-  # source://mdl//lib/mdl/ruleset.rb#37
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:37
   def docs(url = T.unsafe(nil), &block); end
 
-  # source://mdl//lib/mdl/ruleset.rb#48
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:48
   def docs_url; end
 
-  # Returns the value of attribute id.
-  #
-  # source://mdl//lib/mdl/ruleset.rb#4
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:4
   def id; end
 
-  # Sets the attribute id
-  #
-  # @param value the value to set the attribute id to.
-  #
-  # source://mdl//lib/mdl/ruleset.rb#4
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:4
   def id=(_arg0); end
 
-  # source://mdl//lib/mdl/ruleset.rb#32
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:32
   def params(params = T.unsafe(nil)); end
 
-  # source://mdl//lib/mdl/ruleset.rb#22
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:22
   def tags(*tags); end
 end
 
 # defines a ruleset
 #
-# source://mdl//lib/mdl/ruleset.rb#54
+# pkg:gem/mdl#lib/mdl/ruleset.rb:54
 class MarkdownLint::RuleSet
-  # @return [RuleSet] a new instance of RuleSet
-  #
-  # source://mdl//lib/mdl/ruleset.rb#57
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:57
   def initialize; end
 
-  # source://mdl//lib/mdl/ruleset.rb#71
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:71
   def docs(url = T.unsafe(nil), &block); end
 
-  # source://mdl//lib/mdl/ruleset.rb#66
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:66
   def load(rules_file); end
 
-  # source://mdl//lib/mdl/ruleset.rb#79
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:79
   def load_default; end
 
-  # source://mdl//lib/mdl/ruleset.rb#61
-  def rule(id, description, &block); end
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:61
+  def rule(id, description, &_arg2); end
 
-  # Returns the value of attribute rules.
-  #
-  # source://mdl//lib/mdl/ruleset.rb#55
+  # pkg:gem/mdl#lib/mdl/ruleset.rb:55
   def rules; end
 end
 
+# SARIF formatter
+#
+# @see https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html
+#
+# pkg:gem/mdl#lib/mdl/formatters/sarif.rb:7
+class MarkdownLint::SarifFormatter
+  class << self
+    # pkg:gem/mdl#lib/mdl/formatters/sarif.rb:9
+    def generate(rules, results); end
+
+    # pkg:gem/mdl#lib/mdl/formatters/sarif.rb:15
+    def generate_sarif(rules, results); end
+
+    # pkg:gem/mdl#lib/mdl/formatters/sarif.rb:63
+    def generate_sarif_results(rules, results); end
+
+    # pkg:gem/mdl#lib/mdl/formatters/sarif.rb:35
+    def generate_sarif_rules(rules); end
+  end
+end
+
 # defines a style
 #
-# source://mdl//lib/mdl/style.rb#5
+# pkg:gem/mdl#lib/mdl/style.rb:3
 class MarkdownLint::Style
-  # @return [Style] a new instance of Style
-  #
-  # source://mdl//lib/mdl/style.rb#8
+  # pkg:gem/mdl#lib/mdl/style.rb:6
   def initialize(all_rules); end
 
-  # source://mdl//lib/mdl/style.rb#24
+  # pkg:gem/mdl#lib/mdl/style.rb:22
   def all; end
 
-  # source://mdl//lib/mdl/style.rb#41
+  # pkg:gem/mdl#lib/mdl/style.rb:39
   def exclude_rule(id); end
 
-  # source://mdl//lib/mdl/style.rb#50
+  # pkg:gem/mdl#lib/mdl/style.rb:48
   def exclude_tag(tag); end
 
-  # source://mdl//lib/mdl/style.rb#28
+  # pkg:gem/mdl#lib/mdl/style.rb:26
   def rule(id, params = T.unsafe(nil)); end
 
-  # Returns the value of attribute rules.
-  #
-  # source://mdl//lib/mdl/style.rb#6
+  # pkg:gem/mdl#lib/mdl/style.rb:4
   def rules; end
 
-  # source://mdl//lib/mdl/style.rb#46
+  # pkg:gem/mdl#lib/mdl/style.rb:44
   def tag(tag); end
 
   class << self
-    # source://mdl//lib/mdl/style.rb#54
+    # pkg:gem/mdl#lib/mdl/style.rb:52
     def load(style_file, rules); end
   end
 end
 
-# source://mdl//lib/mdl/version.rb#2
+# pkg:gem/mdl#lib/mdl/version.rb:2
 MarkdownLint::VERSION = T.let(T.unsafe(nil), String)