textbringer-markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60d17f89dfbd5f920a78c3e04bd03604129fedd62a0f975baa497d8511e84b98
+  data.tar.gz: 54ea71007ea98170ae782336a65a89dc0a102277d492fcf6c7c233afa0138d18
+SHA512:
+  metadata.gz: 238c540899297f066343656f8db3d2cff0dd09ba049501d39526c855562d8d95677d4090fe7d1a0213bfdf8483668f842e0a037bc02c603af07295ce476761ca
+  data.tar.gz: 388a48f423f5de5aa894cd0d49a42c1a8cd23fce67168c24e50cafb84e80fcc50bab969f4498a29e0156d64fc4a3fff54ee7f1179aac417e11ab902c26c0a08f

data/CLAUDE.md

@@ -0,0 +1,60 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Textbringer::Markdown is a Ruby gem that provides Markdown syntax highlighting for the Textbringer text editor. The implementation is compact (83 lines) and uses regex-based pattern matching to highlight Markdown elements like headings, bold, italic, code blocks, links, lists, and blockquotes.
+
+## Common Commands
+
+### Development Setup
+```bash
+bin/setup              # Install dependencies
+```
+
+### Testing
+```bash
+rake spec              # Run tests via RSpec
+rake                   # Default task (runs spec)
+```
+
+### Development Console
+```bash
+bin/console            # Interactive IRB prompt for experimentation
+```
+
+### Installation & Release
+```bash
+bundle exec rake install    # Install gem locally
+bundle exec rake release    # Release new version (updates version in version.rb first)
+```
+
+## Architecture
+
+### Core Implementation
+All functionality is in `lib/textbringer/markdown.rb` (83 lines):
+
+- **Face Definitions**: 10 color schemes for different Markdown elements (heading, bold, italic, code, code_block, link, url, quote, list, hr)
+- **Syntax Rules**: 10 regex-based patterns using Textbringer's `define_syntax` API
+- **File Pattern**: Matches `.md`, `.markdown`, `.mkd`, `.mdown`, `.mkdn`, `.mdwn` extensions
+- **Buffer Settings**: Disables tab mode (uses spaces), sets tab width to 4
+
+### Textbringer Integration
+- Inherits from `Textbringer::Mode` base class
+- Uses Textbringer's `Face.define` for color definitions
+- Uses `define_syntax` with regex patterns for syntax highlighting
+- Integrates automatically when matching file extensions are opened
+
+### Regex Pattern Priority
+Syntax rules are defined in order:
+1. Headings → 2. Horizontal rules → 3. Code blocks → 4. Inline code → 5. Bold → 6. Italic → 7. Links → 8. URLs → 9. Blockquotes → 10. Lists
+
+When modifying patterns, consider that earlier definitions may take precedence.
+
+## Key Design Decisions
+
+- **Single-file implementation**: All logic consolidated in one file for simplicity
+- **Regex-based parsing**: No complex AST parsing, uses straightforward pattern matching
+- **Minimal dependencies**: Only requires `textbringer >= 1.0`
+- **No tab mode**: Markdown convention prefers spaces (enforced in buffer initialization)

data/LICENSE.txt

@@ -0,0 +1,13 @@
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+Version 2, December 2004
+
+Copyright (C) 2026 yancya <yancya@upec.jp>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,39 @@
+# Textbringer::Markdown
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/textbringer/markdown`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/textbringer-markdown.
+
+## License
+
+The gem is available as open source under the terms of the [WTFPL](http://www.wtfpl.net/).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/textbringer/markdown/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Textbringer
+  module Markdown
+    VERSION = "0.1.0"
+  end
+end

data/lib/textbringer/markdown.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "markdown/version"
+
+# Markdown Mode Plugin for Textbringer
+# Provides syntax highlighting for Markdown files
+
+module Textbringer
+  # Define faces for Markdown syntax elements
+  Face.define :markdown_heading, foreground: "cyan", bold: true
+  Face.define :markdown_bold, foreground: "yellow", bold: true
+  Face.define :markdown_italic, foreground: "green"
+  Face.define :markdown_code, foreground: "magenta"
+  Face.define :markdown_code_block, foreground: "magenta", bold: true
+  Face.define :markdown_link, foreground: "blue", underline: true
+  Face.define :markdown_url, foreground: "blue"
+  Face.define :markdown_quote, foreground: "yellow"
+  Face.define :markdown_list, foreground: "cyan"
+  Face.define :markdown_hr, foreground: "white", bold: true
+
+  class MarkdownMode < Mode
+    self.file_name_pattern = /\.md\z/i
+
+    # Headings (# ## ### etc)
+    define_syntax :markdown_heading, /
+      ^ [ \t]* \#{1,6} [ \t]+ .+? $
+    /x
+
+    # Horizontal rules (--- or *** or ___)
+    define_syntax :markdown_hr, /
+      ^ [ \t]* (?: [-*_] [ \t]* ){3,} $
+    /x
+
+    # Code blocks (```...``` or indented by 4 spaces)
+    define_syntax :markdown_code_block, /
+      (?: ^ [ \t]* ``` .*? $ .*? ^ [ \t]* ``` [ \t]* $ ) |
+      (?: ^ [ \t]{4,} .+ $ )
+    /xm
+
+    # Inline code (`code`)
+    define_syntax :markdown_code, /
+      (?<!`) ` [^`\n]+ `(?!`)
+    /x
+
+    # Bold (**text** or __text__)
+    define_syntax :markdown_bold, /
+      (?: \*\* [^\*\n]+ \*\* ) |
+      (?: __ [^_\n]+ __ )
+    /x
+
+    # Italic (*text* or _text_)
+    define_syntax :markdown_italic, /
+      (?: (?<!\*) \* [^\*\n]+ \* (?!\*) ) |
+      (?: (?<!_) _ [^_\n]+ _ (?!_) )
+    /x
+
+    # Links ([text](url) or [text][ref])
+    define_syntax :markdown_link, /
+      \[ [^\]]+ \] (?: \( [^\)]+ \) | \[ [^\]]* \] )
+    /x
+
+    # URLs (http:// or https://)
+    define_syntax :markdown_url, /
+      https?:\/\/ [^\s<>]+
+    /x
+
+    # Blockquotes (> text)
+    define_syntax :markdown_quote, /
+      ^ [ \t]* > .*? $
+    /xm
+
+    # List markers (-, *, +, 1.)
+    define_syntax :markdown_list, /
+      ^ [ \t]* (?: [-*+] | \d+\. ) [ \t]+
+    /x
+
+    def initialize(buffer)
+      super(buffer)
+      @buffer[:indent_tabs_mode] = false
+      @buffer[:tab_width] = 4
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+# Mock Textbringer for testing without the actual dependency
+module Textbringer
+  class Face
+    def self.define(name, **options)
+      # Mock Face.define
+    end
+  end
+
+  class Mode
+    attr_reader :buffer
+
+    def initialize(buffer)
+      @buffer = buffer
+    end
+
+    def self.define_syntax(face, pattern)
+      # Mock define_syntax
+    end
+
+    def self.file_name_pattern
+      @file_name_pattern
+    end
+
+    def self.file_name_pattern=(pattern)
+      @file_name_pattern = pattern
+    end
+  end
+end
+
+require "textbringer/markdown"
+
+require "test/unit"

data/test/textbringer/markdown_test.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Textbringer::MarkdownTest < Test::Unit::TestCase
+  test "VERSION is defined" do
+    assert do
+      ::Textbringer::Markdown.const_defined?(:VERSION)
+    end
+  end
+
+  test "MarkdownMode class exists" do
+    assert do
+      defined?(Textbringer::MarkdownMode)
+    end
+  end
+
+  test "MarkdownMode file pattern matches .md files" do
+    assert do
+      Textbringer::MarkdownMode.file_name_pattern =~ "test.md"
+    end
+  end
+
+  test "MarkdownMode file pattern does not match .txt files" do
+    assert_nil(Textbringer::MarkdownMode.file_name_pattern =~ "test.txt")
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: textbringer-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yancya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: textbringer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Textbringer plugin that provides comprehensive Markdown syntax highlighting
+  with support for headings, code blocks, links, lists, and more.
+email:
+- yancya@upec.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CLAUDE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textbringer/markdown.rb
+- lib/textbringer/markdown/version.rb
+- test/test_helper.rb
+- test/textbringer/markdown_test.rb
+homepage: https://github.com/yancya/textbringer-markdown
+licenses:
+- WTFPL
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yancya/textbringer-markdown
+  source_code_uri: https://github.com/yancya/textbringer-markdown
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Markdown syntax highlighting mode for Textbringer
+test_files: []