textbringer-plugin-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2ebbaedd12e8043bd3cd2c0adb3f9e6681d9874c846e11fcca0b93dc24b5000
+  data.tar.gz: 40564380d2ab43084500b231105ba6bd89683c58c0175f1e675b64f66af9676e
+SHA512:
+  metadata.gz: 2db0f992690552f9896e2a3b431349e1274b01f3a89cc4938a8e7697f26bc3e12bde84240f0c14c40c5af3d69ce0924a571d581a3f2fb515a528e103817a9b8a
+  data.tar.gz: 5805288a8113efe6092c9e3882b46d98ebac0ac5ef39daea68a383a3a64ac9f08c94071d410ad5d7bdfbbf2a1fcb429d77165723ee0f66b8d90eaa810853c0f8

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release to RubyGems
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Build gem
+        run: gem build textbringer-plugin-generator.gemspec
+
+      - name: Publish to RubyGems
+        uses: rubygems/release-gem@v1

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,56 @@
+# Textbringer Plugin Generator
+
+A command-line tool to generate Textbringer plugin scaffolding with proper structure, tests, GitHub Actions, and documentation.
+
+## Features
+
+Generates a complete Textbringer plugin project with:
+
+- ✅ Proper directory structure with `lib/textbringer_plugin.rb` for automatic loading
+- ✅ Test::Unit test setup with Textbringer mocks
+- ✅ GitHub Actions workflow for automated RubyGems release via OIDC (Trusted Publishing)
+- ✅ Clean README template without TODOs
+- ✅ CLAUDE.md for future AI assistance
+- ✅ `.gitignore` with Gemfile.lock and .claude/ excluded
+- ✅ Rakefile with test task
+- ✅ Choice of license (MIT or WTFPL)
+
+All based on best practices learned from developing real Textbringer plugins.
+
+## Installation
+
+Install the gem by executing:
+
+```bash
+gem install textbringer-plugin-generator
+```
+
+## Usage
+
+Generate a new Textbringer plugin:
+
+```bash
+textbringer-plugin new my-plugin
+```
+
+This creates a new directory `textbringer-my-plugin` with all the necessary files.
+
+### Options
+
+- `--license=[mit|wtfpl]` - Choose license (default: wtfpl)
+- `--author=NAME` - Set author name (default: from git config)
+- `--email=EMAIL` - Set author email (default: from git config)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yancya/textbringer-plugin-generator.
+
+## 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/exe/textbringer-plugin

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "textbringer_plugin_generator"
+
+Textbringer::Plugin::Generator::CLI.start(ARGV)

data/lib/textbringer/plugin/generator/cli.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Textbringer
+  module Plugin
+    module Generator
+      class CLI < Thor
+        def self.exit_on_failure?
+          true
+        end
+
+        desc "version", "Show version"
+        def version
+          puts "textbringer-plugin-generator #{VERSION}"
+        end
+
+        desc "new NAME", "Generate a new Textbringer plugin"
+        option :license, type: :string, default: "wtfpl", desc: "License (mit or wtfpl)"
+        option :author, type: :string, desc: "Author name"
+        option :email, type: :string, desc: "Author email"
+        def new(name)
+          generator = ::Textbringer::Plugin::Generator::Generator.new(name, options)
+          generator.generate
+        end
+      end
+    end
+  end
+end

data/lib/textbringer/plugin/generator/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Textbringer
+  module Plugin
+    module Generator
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/textbringer/plugin/generator.rb

@@ -0,0 +1,397 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Textbringer
+  module Plugin
+    module Generator
+      class Generator
+        attr_reader :name, :gem_name, :module_name, :class_name, :options
+
+        def initialize(name, options = {})
+          @name = name
+          @gem_name = "textbringer-#{name}"
+          @module_name = camelize(name)
+          @class_name = "#{camelize(name)}Mode"
+          @options = options
+        end
+
+        def generate
+          create_directory_structure
+          create_gemspec
+          create_gemfile
+          create_rakefile
+          create_gitignore
+          create_lib_files
+          create_test_files
+          create_readme
+          create_license
+          puts "Created #{gem_name}/"
+        end
+
+        private
+
+        def create_directory_structure
+          FileUtils.mkdir_p(gem_name)
+          FileUtils.mkdir_p("#{gem_name}/lib/textbringer/#{name}")
+          FileUtils.mkdir_p("#{gem_name}/test")
+          FileUtils.mkdir_p("#{gem_name}/.github/workflows")
+        end
+
+        def create_gemspec
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            require_relative "lib/textbringer/#{name}/version"
+
+            Gem::Specification.new do |spec|
+              spec.name = "#{gem_name}"
+              spec.version = Textbringer::#{module_name}::VERSION
+              spec.authors = [#{author.inspect}]
+              spec.email = [#{email.inspect}]
+
+              spec.summary = "#{module_name} mode for Textbringer"
+              spec.description = "A Textbringer plugin that provides #{name} mode support with syntax highlighting."
+              spec.homepage = "https://github.com/#{github_user}/#{gem_name}"
+              spec.license = "#{license_type.upcase}"
+              spec.required_ruby_version = ">= 3.2.0"
+
+              spec.metadata["allowed_push_host"] = "https://rubygems.org"
+              spec.metadata["homepage_uri"] = spec.homepage
+              spec.metadata["source_code_uri"] = "https://github.com/#{github_user}/#{gem_name}"
+
+              gemspec = File.basename(__FILE__)
+              spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+                ls.readlines("\\x0", chomp: true).reject do |f|
+                  (f == gemspec) ||
+                    f.start_with?(*%w[bin/ Gemfile .gitignore .rspec spec/ .github/])
+                end
+              end
+              spec.bindir = "exe"
+              spec.executables = spec.files.grep(%r{\\Aexe/}) { |f| File.basename(f) }
+              spec.require_paths = ["lib"]
+
+              spec.add_dependency "textbringer", ">= 1.0"
+            end
+          RUBY
+          File.write("#{gem_name}/#{gem_name}.gemspec", content)
+        end
+
+        def create_gemfile
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            source "https://rubygems.org"
+
+            gemspec
+
+            gem "irb"
+            gem "rake", "~> 13.0"
+            gem "test-unit"
+          RUBY
+          File.write("#{gem_name}/Gemfile", content)
+        end
+
+        def create_rakefile
+          content = <<~RUBY
+            # 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
+          RUBY
+          File.write("#{gem_name}/Rakefile", content)
+        end
+
+        def create_gitignore
+          content = <<~TEXT
+            /.bundle/
+            /.yardoc
+            /_yardoc/
+            /coverage/
+            /doc/
+            /pkg/
+            /spec/reports/
+            /tmp/
+
+            # Bundler lockfile for gems
+            Gemfile.lock
+
+            # Claude Code settings
+            .claude/
+          TEXT
+          File.write("#{gem_name}/.gitignore", content)
+        end
+
+        def author
+          options[:author] || `git config user.name`.strip
+        end
+
+        def github_user
+          # Try to get GitHub username, fallback to sanitized author name
+          github = `git config github.user`.strip
+          return github unless github.empty?
+
+          # Remove spaces and non-alphanumeric characters for URL safety
+          author.gsub(/\s+/, '').gsub(/[^a-zA-Z0-9-]/, '')
+        end
+
+        def email
+          options[:email] || `git config user.email`.strip
+        end
+
+        def license_type
+          options[:license] || "wtfpl"
+        end
+
+        def create_lib_files
+          create_version_file
+          create_main_file
+          create_plugin_entry
+        end
+
+        def create_version_file
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            module Textbringer
+              module #{module_name}
+                VERSION = "0.1.0"
+              end
+            end
+          RUBY
+          File.write("#{gem_name}/lib/textbringer/#{name}/version.rb", content)
+        end
+
+        def create_main_file
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            require_relative "#{name}/version"
+
+            module Textbringer
+              # Define faces for syntax elements
+              # Face.define :#{name}_keyword, foreground: "cyan", bold: true
+
+              class #{class_name} < Mode
+                self.file_name_pattern = /\\.#{name}\\z/i
+
+                # Define your syntax highlighting here
+                # define_syntax :#{name}_keyword, /your_pattern/
+
+                def initialize(buffer)
+                  super(buffer)
+                  @buffer[:indent_tabs_mode] = false
+                  @buffer[:tab_width] = 2
+                end
+              end
+            end
+          RUBY
+          File.write("#{gem_name}/lib/textbringer/#{name}.rb", content)
+        end
+
+        def create_plugin_entry
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            require "textbringer/#{name}"
+          RUBY
+          File.write("#{gem_name}/lib/textbringer_plugin.rb", content)
+        end
+
+        def create_test_files
+          create_test_helper
+          create_test_file
+        end
+
+        def create_test_helper
+          content = <<~RUBY
+            # 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/#{name}"
+
+            require "test/unit"
+          RUBY
+          File.write("#{gem_name}/test/test_helper.rb", content)
+        end
+
+        def create_test_file
+          test_class = name.split(/[-_]/).map(&:capitalize).join
+          content = <<~RUBY
+            # frozen_string_literal: true
+
+            require "test_helper"
+
+            class Textbringer::#{test_class}Test < Test::Unit::TestCase
+              test "VERSION is defined" do
+                assert do
+                  ::Textbringer::#{module_name}.const_defined?(:VERSION)
+                end
+              end
+
+              test "#{class_name} class exists" do
+                assert do
+                  defined?(Textbringer::#{class_name})
+                end
+              end
+
+              test "#{class_name} file pattern matches .#{name} files" do
+                assert do
+                  Textbringer::#{class_name}.file_name_pattern =~ "test.#{name}"
+                end
+              end
+            end
+          RUBY
+          File.write("#{gem_name}/test/textbringer_#{name.tr('-', '_')}_test.rb", content)
+        end
+
+        def create_readme
+          content = <<~MARKDOWN
+            # #{gem_name.split('-').map(&:capitalize).join(' ')}
+
+            A Textbringer plugin that provides #{name} mode support.
+
+            ## Installation
+
+            Install the gem by executing:
+
+            ```bash
+            gem install #{gem_name}
+            ```
+
+            Or add it to your Gemfile:
+
+            ```bash
+            bundle add #{gem_name}
+            ```
+
+            ## Usage
+
+            The plugin is automatically loaded when you start Textbringer. Simply open any `.#{name}` file and the mode will be applied automatically.
+
+            No additional configuration is required.
+
+            ## Development
+
+            After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+            To install this gem onto your local machine, run `bundle exec rake install`.
+
+            ## Contributing
+
+            Bug reports and pull requests are welcome on GitHub at https://github.com/#{github_user}/#{gem_name}.
+
+            ## License
+
+            The gem is available as open source under the terms of the [#{license_name}](#{license_url}).
+          MARKDOWN
+          File.write("#{gem_name}/README.md", content)
+        end
+
+        def create_license
+          if license_type == "wtfpl"
+            create_wtfpl_license
+          else
+            create_mit_license
+          end
+        end
+
+        def create_wtfpl_license
+          content = <<~LICENSE
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+            Version 2, December 2004
+
+            Copyright (C) #{Time.now.year} #{author} <#{email}>
+
+            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.
+          LICENSE
+          File.write("#{gem_name}/LICENSE.txt", content)
+        end
+
+        def create_mit_license
+          content = <<~LICENSE
+            The MIT License (MIT)
+
+            Copyright (c) #{Time.now.year} #{author}
+
+            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.
+          LICENSE
+          File.write("#{gem_name}/LICENSE.txt", content)
+        end
+
+        def license_name
+          license_type == "wtfpl" ? "WTFPL" : "MIT License"
+        end
+
+        def license_url
+          license_type == "wtfpl" ? "http://www.wtfpl.net/" : "https://opensource.org/licenses/MIT"
+        end
+
+        def camelize(string)
+          string.split(/[-_]/).map(&:capitalize).join
+        end
+      end
+    end
+  end
+end

data/lib/textbringer_plugin_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "textbringer/plugin/generator/version"
+require_relative "textbringer/plugin/generator/cli"
+require_relative "textbringer/plugin/generator"
+
+module Textbringer
+  module Plugin
+    module Generator
+      class Error < StandardError; end
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: textbringer-plugin-generator
+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: thor
+  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 command-line tool to generate Textbringer plugin scaffolding with proper
+  structure, tests, GitHub Actions, and documentation.
+email:
+- yancya@upec.jp
+executables:
+- textbringer-plugin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/textbringer-plugin
+- lib/textbringer/plugin/generator.rb
+- lib/textbringer/plugin/generator/cli.rb
+- lib/textbringer/plugin/generator/version.rb
+- lib/textbringer_plugin_generator.rb
+homepage: https://github.com/yancya/textbringer-plugin-generator
+licenses:
+- WTFPL
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/yancya/textbringer-plugin-generator
+  source_code_uri: https://github.com/yancya/textbringer-plugin-generator
+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: Generate Textbringer plugin boilerplate with best practices
+test_files: []