markdown_to_mrkdwn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93c4327078bb8105c71a63757fa465e5b2015d71a80fd38cc1ea96f7182a353b
+  data.tar.gz: 58f95cd43167a151be124472dd127abcdd49ea4f6fdae8ef2e9920020c61d4a1
+SHA512:
+  metadata.gz: 1af92c26cb7090bcefa93c89effb2bb78ea1cb22f5e61c4d0b0aa7791ecdd502d13d3f34191945855acf203fbc7da17fba30110ffceada014fb77c3cb67a5a7a
+  data.tar.gz: 78b86e0059b240908028cc52c679739f254333582628276e225503db4959600a270426a469aa42327d15086b55f408b2c92b0b62391be052288063d24b7fb2cc

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial implementation
+- CLI tool for converting Markdown to Slack mrkdwn
+- Ruby library API for programmatic conversion
+- Support for headings, bold, italic, strikethrough, code blocks, links, and images
+- Command-line options for customizing conversion behavior
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [0.1.0] - 2024-09-14
+
+### Added
+
+- Initial release of markdown_to_mrkdwn
+- Basic Markdown to Slack mrkdwn conversion functionality
+- Command-line interface
+- Ruby library interface
+
+[Unreleased]: https://github.com/emp823/markdown_to_mrkdwn/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/emp823/markdown_to_mrkdwn/releases/tag/v0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Erik Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,100 @@
+# markdown_to_mrkdwn
+
+[![CI](https://github.com/emp823/markdown_to_mrkdwn/actions/workflows/ci.yml/badge.svg)](https://github.com/emp823/markdown_to_mrkdwn/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/emp823/markdown_to_mrkdwn/branch/main/graph/badge.svg)](https://codecov.io/gh/emp823/markdown_to_mrkdwn)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.1-ruby.svg)](https://www.ruby-lang.org/)
+
+Convert Markdown to Slack mrkdwn (lightweight, no dependencies).
+
+## Installation
+
+Install the gem:
+
+```bash
+gem install markdown_to_mrkdwn
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "markdown_to_mrkdwn"
+```
+
+For development, clone and setup:
+
+```bash
+git clone https://github.com/emp823/markdown_to_mrkdwn.git
+cd markdown_to_mrkdwn
+bin/setup
+```
+
+## Usage
+
+### Ruby API
+
+````ruby
+require "markdown_to_mrkdwn"
+
+mrkdwn = MarkdownToMrkdwn.convert(<<~MARKDOWN)
+  # Heading
+
+  **Bold** and *italic* and ~~strike~~ and `code`.
+
+  ```ruby
+  puts "hello"
+````
+
+![Alt](https://example.com/img.png)
+MARKDOWN
+
+puts mrkdwn
+
+````
+
+### Command Line
+
+```bash
+# Convert from stdin
+echo "# Title\n**bold** and _italic_." | markdown_to_mrkdwn
+
+# Convert a file
+markdown_to_mrkdwn README.md
+
+# Use options
+markdown_to_mrkdwn --plain-headings README.md
+````
+
+## What’s converted
+
+- Headings `#`..`######` → bold line (or plain with `--plain-headings`).
+- Bold `**text**` or `__text__` → `*text*`.
+- Italic `*text*` or `_text_` → `_text_`.
+- Strikethrough `~~text~~` → `~text~`.
+- Inline code `` `code` `` → `` `code` `` (unchanged).
+- Fenced code blocks `lang ... ` → `...` (language hint removed).
+- Links `[label](url)` → `<url|label>`.
+- Images `![alt](url)` → `<url|alt>`.
+- Horizontal rules → em dash line (or keep with `--keep-hr`).
+
+Notes:
+
+- Lists, blockquotes, and paragraphs are mostly compatible with Slack already and are left as-is.
+- Code (inline and blocks) is protected from other conversions.
+- This is a pragmatic converter; edge cases of Markdown are not fully supported.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-new-feature`)
+3. Make your changes and add tests
+4. Run the test suite (`bundle exec rake test`)
+5. Ensure code style passes (`bundle exec rubocop`)
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin feature/my-new-feature`)
+8. Create a Pull Request
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+## License
+
+MIT - See [LICENSE](LICENSE) file for details.

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "markdown_to_mrkdwn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/markdown_to_mrkdwn

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+
+begin
+  require_relative "../lib/markdown_to_mrkdwn"
+rescue LoadError
+  warn "Could not load markdown_to_mrkdwn library. Ensure you're running from the gem root or installed the gem."
+  exit 1
+end
+
+options = {
+  heading: :bold,
+  keep_hr: false
+}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: markdown_to_mrkdwn [options] [FILE]"
+  opts.separator ""
+  opts.separator "Convert Markdown to Slack mrkdwn format"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("--plain-headings", "Do not bold headings") { options[:heading] = :plain }
+  opts.on("--keep-hr", "Keep horizontal rules as --- or ***") { options[:keep_hr] = true }
+  opts.on("-v", "--version", "Show version") do
+    puts "markdown_to_mrkdwn #{MarkdownToMrkdwn::VERSION}"
+    exit 0
+  end
+  opts.on("-h", "--help", "Show this help") do
+    puts opts
+    exit 0
+  end
+
+  opts.separator ""
+  opts.separator "Examples:"
+  opts.separator "  echo '# Title' | markdown_to_mrkdwn"
+  opts.separator "  markdown_to_mrkdwn README.md"
+  opts.separator "  markdown_to_mrkdwn --plain-headings file.md"
+end
+
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption => e
+  warn "Error: #{e.message}"
+  warn "Use --help for usage information"
+  exit 1
+end
+
+input = begin
+  if ARGV[0]
+    unless File.exist?(ARGV[0])
+      warn "Error: File '#{ARGV[0]}' not found"
+      exit 1
+    end
+    unless File.readable?(ARGV[0])
+      warn "Error: File '#{ARGV[0]}' is not readable"
+      exit 1
+    end
+    File.read(ARGV[0])
+  else
+    $stdin.read
+  end
+rescue StandardError => e
+  warn "Error reading input: #{e.message}"
+  exit 1
+end
+
+begin
+  result = MarkdownToMrkdwn.convert(input, **options)
+  puts result
+rescue StandardError => e
+  warn "Error converting markdown: #{e.message}"
+  exit 1
+end

data/bin/setup

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  FileUtils.rm_f Dir.glob("*.gem")
+  FileUtils.rm_rf "pkg/"
+
+  puts "\n== Running tests =="
+  system! "bundle exec rake test"
+
+  puts "\n== All set! =="
+end

data/lib/markdown_to_mrkdwn/converter.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module MarkdownToMrkdwn
+  class Converter
+    SENTINEL = "§"
+    # Options:
+    # - heading: :bold (default) or :plain
+    # - keep_hr: true to keep --- as is (default false -> replace with an em dash line)
+    def initialize(heading: :bold, keep_hr: false)
+      @heading_style = heading
+      @keep_hr = keep_hr
+    end
+
+    def convert(markdown)
+      return "" if markdown.nil? || markdown.empty?
+
+      text = markdown.dup
+
+      # 1) Extract fenced code blocks and inline code to protect from further processing
+      blocks = {}
+      text = extract_fenced_code_blocks(text, blocks)
+      text = extract_inline_code(text, blocks)
+
+      # 2) Images: ![alt](url) -> <url|alt>
+      text.gsub!(/!\[(.*?)\]\((\S+?)(?:\s+".*?")?\)/) do
+        alt = Regexp.last_match(1)
+        url = Regexp.last_match(2)
+        "<#{url}|#{alt}>"
+      end
+
+      # 3) Links: [text](url) -> <url|text>
+      text.gsub!(/\[(.*?)\]\((\S+?)(?:\s+".*?")?\)/) do
+        label = Regexp.last_match(1)
+        url = Regexp.last_match(2)
+        "<#{url}|#{label}>"
+      end
+
+      # 4) Strikethrough: ~~text~~ -> ~text~
+      text.gsub!(/~~(.*?)~~/, '~\1~')
+
+      # 5) Italic: *text* or _text_ -> _text_
+      # Run italics BEFORE bold so that bold remains asterisks in Slack.
+      # Only match single markers, not double.
+      text.gsub!(/(?<!\*)\*(?!\*)(.+?)(?<!\*)\*(?!\*)/, '_\1_')
+      text.gsub!(/(?<!_)_(?!_)(.+?)(?<!_)_(?!_)/, '_\1_')
+
+      # 6) Bold: **text** or __text__ -> *text*
+      text.gsub!(/\*\*(.+?)\*\*/, '*\1*')
+      text.gsub!(/__(.+?)__/, '*\1*')
+
+      # 7) Headings: # H -> *H*
+      text = convert_headings(text)
+
+      # 8) Horizontal rules
+      text.gsub!(/^\s*([-*_])\s*\1\s*\1\s*$/, @keep_hr ? '\0' : "—\n")
+
+      # 9) Restore protected code segments
+      restore_placeholders(text, blocks)
+    end
+
+    private
+
+    def extract_fenced_code_blocks(text, store)
+      idx = 0
+      text.gsub(/```([a-zA-Z0-9_+-]*)\n([\s\S]*?)\n```/) do
+        Regexp.last_match(1)
+        body = Regexp.last_match(2)
+        key = "#{SENTINEL}MRKDWNBLOCK_#{idx += 1}#{SENTINEL}"
+        # Slack ignores the language hint; keep pure triple backticks
+        store[key] = "```\n#{body}\n```"
+        key
+      end
+    end
+
+    def extract_inline_code(text, store)
+      idx = store.size
+      text.gsub(/`([^`\n]+)`/) do
+        body = Regexp.last_match(1)
+        key = "#{SENTINEL}MRKDWNBLOCK_#{idx += 1}#{SENTINEL}"
+        store[key] = "`#{body}`"
+        key
+      end
+    end
+
+    def restore_placeholders(text, store)
+      return text if store.empty?
+
+      loop do
+        before = text.dup
+        store.each { |k, v| text = text.gsub(k, v) }
+        break if text == before
+      end
+      text
+    end
+
+    def convert_headings(text)
+      text.lines.map do |line|
+        if (m = line.match(/^(\s{0,3})(#{Regexp.escape("#")}{1,6})\s+(.*)$/))
+          indent = m[1]
+          content = m[3].strip
+          case @heading_style
+          when :bold
+            "#{indent}*#{content}*\n"
+          else
+            "#{indent}#{content}\n"
+          end
+        else
+          line
+        end
+      end.join
+    end
+  end
+end

data/lib/markdown_to_mrkdwn/version.rb

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

data/lib/markdown_to_mrkdwn.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "markdown_to_mrkdwn/version"
+require_relative "markdown_to_mrkdwn/converter"
+
+module MarkdownToMrkdwn
+  def self.convert(markdown, **options)
+    Converter.new(**options).convert(markdown)
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: markdown_to_mrkdwn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Pearson
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Lightweight converter for common Markdown to Slack mrkdwn syntax with
+  a simple CLI. No dependencies, fast conversion.
+email:
+- emp823@icloud.com
+executables:
+- markdown_to_mrkdwn
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/console
+- bin/markdown_to_mrkdwn
+- bin/setup
+- lib/markdown_to_mrkdwn.rb
+- lib/markdown_to_mrkdwn/converter.rb
+- lib/markdown_to_mrkdwn/version.rb
+homepage: https://github.com/emp823/markdown_to_mrkdwn
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/emp823/markdown_to_mrkdwn/issues
+  changelog_uri: https://github.com/emp823/markdown_to_mrkdwn/blob/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/markdown_to_mrkdwn
+  homepage_uri: https://github.com/emp823/markdown_to_mrkdwn
+  source_code_uri: https://github.com/emp823/markdown_to_mrkdwn
+  wiki_uri: https://github.com/emp823/markdown_to_mrkdwn/wiki
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Convert Markdown to Slack mrkdwn
+test_files: []