beid 0.1.0

data/lib/beid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Beid
+  VERSION = "0.1.0"
+end

data/lib/beid.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "beid/version"
+require_relative "beid/node"
+require_relative "beid/directive"
+require_relative "beid/inline_parser"
+require_relative "beid/parser"
+require_relative "beid/document"
+require_relative "beid/editing"
+
+module Beid
+  class Error < StandardError; end
+end

data/sig/beid.rbs

@@ -0,0 +1,51 @@
+module Beid
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class Node
+    attr_reader type: Symbol
+    attr_reader attributes: Hash[Symbol, untyped]
+    attr_reader children: Array[Node]
+    attr_reader range: Range[Integer]
+    attr_reader marker: String?
+
+    def initialize: (type: Symbol, ?attributes: Hash[Symbol, untyped], ?children: Array[Node], range: Range[Integer], ?marker: String?) -> void
+    def text: () -> String?
+  end
+
+  class Document
+    attr_reader source: String
+    attr_reader root: Node
+    attr_reader front_matter: String?
+    attr_reader options: Hash[Symbol, bool]
+    attr_reader diagnostics: Array[String]
+
+    def self.parse: (String text, ?gfm: bool, ?front_matter: bool) -> Document
+    def nodes_at: (Integer offset) -> Array[Node]
+    def node_at: (Integer offset) -> Node?
+    def range_of: (Node node) -> Range[Integer]
+    def position_at: (Integer offset) -> [ Integer, Integer ]
+    def utf16_position_at: (Integer offset) -> [ Integer, Integer ]
+    def valid?: () -> bool
+    def to_s: () -> String
+    def include_node?: (Node node) -> bool
+  end
+
+  module Directive
+    def self.parse: (String html_comment) -> Hash[String, String]?
+    def self.render: (Hash[String, String] values) -> String
+  end
+
+  module Editing
+    def self.replace: (Document document, Node node, String markdown) -> Document
+    def self.replace_text: (Document document, Node node, String text) -> Document
+    def self.insert_after: (Document document, Node node, String markdown) -> Document
+    def self.insert_before: (Document document, Node node, String markdown) -> Document
+    def self.remove: (Document document, Node node) -> Document
+    def self.set_attribute: (Document document, Node node, String | Symbol key, untyped value) -> Document
+    def self.set_directive: (Document document, Node node, String | Symbol key, String value) -> Document
+    def self.move: (Document document, Node node, ?before: Node?, ?after: Node?) -> Document
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: beid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Parse Markdown into source-positioned nodes and edit byte ranges without
+  rewriting untouched syntax.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- docs/adr/001-byte-range-edits.md
+- docs/adr/002-html-comment-directives.md
+- lib/beid.rb
+- lib/beid/directive.rb
+- lib/beid/document.rb
+- lib/beid/editing.rb
+- lib/beid/inline_parser.rb
+- lib/beid/node.rb
+- lib/beid/parser.rb
+- lib/beid/version.rb
+- sig/beid.rbs
+homepage: https://github.com/noxdea/beid
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/noxdea/beid
+  source_code_uri: https://github.com/noxdea/beid/tree/main
+  changelog_uri: https://github.com/noxdea/beid/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Source-preserving Markdown parser and editor
+test_files: []