mdlint 0.1.0 → 0.2.0

data/sig/mdlint.rbs

@@ -0,0 +1,107 @@
+module Mdlint
+  class Error < StandardError
+  end
+
+  type options = Hash[Symbol, untyped]
+
+  def self.format: (String source, ?options options) -> String
+  def self.update_toc: (String source, ?options options) -> String
+  def self.html: (String source, ?options options) -> String
+  def self.parse: (String source, ?options options) -> Array[Token]
+  def self.fix: (String source, ?options options) -> String
+  def self.format_file: (String path, ?options options) -> (String | bool)
+  def self.lint: (String source, ?options options) -> Array[Linter::Violation]
+  def self.lint_file: (String path, ?options options) -> Array[Linter::Violation]
+
+  VERSION: String
+
+  class Dialect
+    attr_reader name: Symbol
+    attr_reader features: Array[Symbol]
+    def initialize: (?Symbol | String name, ?features: Array[Symbol]) -> void
+    def gfm?: () -> bool
+    def feature?: (Symbol feature) -> bool
+    def to_sym: () -> Symbol
+    def self.features: () -> Hash[Symbol, Array[Symbol]]
+    def self.resolve: (untyped value) -> Dialect
+    def self.register: (Symbol | String name, ?features: Array[Symbol]) -> Symbol
+    def self.registered: () -> Array[Symbol]
+  end
+
+  module Plugin
+    class Error < Mdlint::Error
+    end
+    def self.register_rule: (Class rule_class) -> Class
+    def self.register_dialect: (Symbol | String name, ?features: Array[Symbol]) -> Symbol
+    def self.unregister_rule: (Class rule_class) -> void
+    def self.load: (String path) -> untyped
+  end
+
+  module Parser
+    def self.parse: (String source, ?options options) -> Array[Token]
+  end
+
+  module Renderer
+    def self.render: (Array[Token] tokens, ?options options) -> String
+    def self.render_html: (Array[Token] tokens, ?options options) -> String
+  end
+
+  module Toc
+    def self.update: (String source, ?options options) -> String
+  end
+
+  class Token
+    attr_accessor type: Symbol
+    attr_accessor tag: String?
+    attr_accessor nesting: Integer
+    attr_accessor level: Integer
+    attr_accessor content: String
+    attr_accessor markup: String
+    attr_accessor info: String
+    attr_accessor meta: Hash[Symbol, untyped]
+    attr_accessor map: Array[Integer]?
+    attr_accessor children: Array[Token]
+    attr_accessor attrs: Hash[Symbol, untyped]
+    def initialize: (type: Symbol, **untyped) -> void
+    def opening?: () -> bool
+    def closing?: () -> bool
+    def self_closing?: () -> bool
+    def block?: () -> bool
+    def inline?: () -> bool
+  end
+
+  module Linter
+    def self.fix: (String source, ?options options) -> String
+    def self.check: (String source, ?options options) -> Array[Violation]
+
+    class Violation
+      attr_reader rule_id: String
+      attr_reader message: String
+      attr_reader line: Integer
+      attr_reader column: Integer?
+      attr_reader severity: Symbol
+      attr_reader fixable: bool
+      def initialize: (rule_id: String, message: String, line: Integer, ?column: Integer?, ?severity: Symbol, ?fixable: bool) -> void
+      def to_s: () -> String
+      def to_h: () -> Hash[Symbol, untyped]
+      def fixable?: () -> bool
+      def error?: () -> bool
+      def warning?: () -> bool
+      def info?: () -> bool
+    end
+
+    class Rule
+      def initialize: (?options options) -> void
+      def check: (Array[Token] tokens, String source) -> Array[Violation]
+      def fix: (Array[Token] tokens, String source) -> String
+    end
+
+    class RuleRegistry
+      def self.all: () -> Array[singleton(Rule)]
+      def self.find: (String rule_id) -> singleton(Rule)?
+    def self.register: (singleton(Rule) rule_class) -> void
+    def self.unregister: (Class rule_class) -> void
+      def self.normalize_id: (String rule_id) -> String
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdlint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -19,31 +19,55 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".pre-commit-hooks.yaml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
+- action.yml
+- benchmark/compare.rb
+- benchmark/format.rb
 - exe/mdlint
 - lib/mdlint.rb
+- lib/mdlint/cache_store.rb
 - lib/mdlint/cli.rb
+- lib/mdlint/cli/output_formatter.rb
 - lib/mdlint/config.rb
+- lib/mdlint/dialect.rb
 - lib/mdlint/linter.rb
+- lib/mdlint/linter/directive_filter.rb
 - lib/mdlint/linter/rule.rb
 - lib/mdlint/linter/rule_engine.rb
+- lib/mdlint/linter/rules/code_block_syntax.rb
 - lib/mdlint/linter/rules/first_line_heading.rb
 - lib/mdlint/linter/rules/heading_increment.rb
 - lib/mdlint/linter/rules/heading_style.rb
+- lib/mdlint/linter/rules/japanese.rb
+- lib/mdlint/linter/rules/line_length.rb
+- lib/mdlint/linter/rules/link_check.rb
 - lib/mdlint/linter/rules/no_multiple_blanks.rb
 - lib/mdlint/linter/rules/no_trailing_spaces.rb
+- lib/mdlint/linter/rules/source_style.rb
 - lib/mdlint/linter/violation.rb
+- lib/mdlint/lsp.rb
+- lib/mdlint/parallel_runner.rb
 - lib/mdlint/parser.rb
 - lib/mdlint/parser/block_parser.rb
 - lib/mdlint/parser/inline_parser.rb
 - lib/mdlint/parser/state.rb
+- lib/mdlint/plugin.rb
 - lib/mdlint/renderer.rb
+- lib/mdlint/renderer/html_renderer.rb
 - lib/mdlint/renderer/md_renderer.rb
+- lib/mdlint/text_width.rb
+- lib/mdlint/toc.rb
 - lib/mdlint/token.rb
 - lib/mdlint/version.rb
+- script/commonmark_compatibility.rb
+- script/fetch_commonmark_spec.rb
+- sig/internal.rbs
+- sig/mdlint.rbs
 homepage: https://github.com/ydah/mdlint
 licenses:
 - MIT
@@ -67,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Pure Ruby Markdown linter and formatter
 test_files: []