llms-txt-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59e6ef21e4d8e7cfad82d91a1d0c6eede9528850622efef8738b718bbbe0ea43
-  data.tar.gz: 0247ceaaed63bea7ba5d86753cd77e19e032ec31561ab6fbfe35874d875cbda6
+  metadata.gz: 678093f3878f75c9f39c21f009b279e95e20c62a7dcbbc72de5499305a73bf6f
+  data.tar.gz: a2406c0e8fada1bf1e0134acae4adfe3859d1af83d4d5286cb4207d2dde92f64
 SHA512:
-  metadata.gz: 13bcd98389bbfd2193e1d21b3b5372bd1656145aec325a0f1456ce95cb699106008c35914cdab9c6ed4e7cefa4c955791347179e003def2a8569ab267c387abc
-  data.tar.gz: 4115db81602c0137224f7e5c8b9c536b5684776c3398e04893d6f1e0b2a327af71918d34c661d83eae9e773654ef282947fcd231af0a3c4cfe8263f085455381
+  metadata.gz: dc062480b41973112b8e0e860b1605cd4b51a3f9d8b41af490fee57ae3b286722dcfac1fe07bfe80baca624647dde37e7fffbf7f2a34e9d2ca2b32b25550f2e1
+  data.tar.gz: b7600d18d1ecded87cd64c6e5022a20915abe02d716fd53d033abfd35136b7514b4b7f7c4e1b9e3f9018cb6c2358ac0692c4cdd5b8d115788e8287d836af5268

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.1.2 (2025-10-07)
+- [Fix] Fixed CLI error handling to use correct `LlmsTxt::Errors::BaseError` instead of non-existent `LlmsTxt::Error`.
+- [Enhancement] Extracted CLI class to `lib/llms_txt/cli.rb` for better testability.
+- [Enhancement] Added comprehensive CLI error handling specs.
+
 ## 0.1.1 (2025-10-07)
 - [Change] Updated repository metadata to use `master` branch instead of `main`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    llms-txt-ruby (0.1.1)
+    llms-txt-ruby (0.1.2)
       zeitwerk (~> 2.6)
 
 GEM

data/bin/llms-txt

@@ -1,242 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'optparse'
 require 'llms_txt'
+require 'llms_txt/cli'
 
-module LlmsTxt
-  class CLI
-    def self.run(argv = ARGV)
-      new.run(argv)
-    end
-
-    def run(argv)
-      options = parse_options(argv)
-
-      case options[:command]
-      when 'generate', nil
-        generate(options)
-      when 'transform'
-        transform(options)
-      when 'bulk-transform'
-        bulk_transform(options)
-      when 'parse'
-        parse(options)
-      when 'validate'
-        validate(options)
-      when 'version'
-        show_version
-      else
-        puts "Unknown command: #{options[:command]}"
-        puts "Run 'llms-txt --help' for usage information"
-        exit 1
-      end
-    rescue LlmsTxt::Error => e
-      puts "Error: #{e.message}"
-      exit 1
-    rescue StandardError => e
-      puts "Unexpected error: #{e.message}"
-      puts e.backtrace.join("\n") if options&.fetch(:verbose, false)
-      exit 1
-    end
-
-    private
-
-    def parse_options(argv)
-      options = {
-        command: argv.first&.match?(/^[a-z-]+$/) ? argv.shift : nil
-      }
-
-      OptionParser.new do |opts|
-        opts.banner = "llms-txt - Simple tool for generating llms.txt from markdown documentation\n\nUsage: llms-txt [command] [options]\n\nFor advanced configuration (base_url, title, description, convert_urls), use a config file."
-
-        opts.separator ''
-        opts.separator 'Commands:'
-        opts.separator '  generate       Generate llms.txt from documentation (default)'
-        opts.separator '  transform      Transform a markdown file to be AI-friendly'
-        opts.separator '  bulk-transform Transform all markdown files in directory'
-        opts.separator '  parse          Parse existing llms.txt file'
-        opts.separator '  validate       Validate llms.txt file'
-        opts.separator '  version        Show version'
-
-        opts.separator ''
-        opts.separator 'Options:'
-
-        opts.on('-c', '--config PATH', 'Configuration file path (default: llms-txt.yml)') do |path|
-          options[:config] = path
-        end
-
-        opts.on('-d', '--docs PATH', 'Path to documentation directory or file') do |path|
-          options[:docs] = path
-        end
-
-        opts.on('-o', '--output PATH', 'Output file path') do |path|
-          options[:output] = path
-        end
-
-        opts.on('-v', '--verbose', 'Verbose output') do
-          options[:verbose] = true
-        end
-
-        opts.on('-h', '--help', 'Show this message') do
-          puts opts
-          exit
-        end
-
-        opts.on('--version', 'Show version') do
-          show_version
-          exit
-        end
-      end.parse!(argv)
-
-      options[:file_path] = argv.first if argv.any?
-      options
-    end
-
-    def generate(options)
-      # Load config and merge with CLI options
-      config = LlmsTxt::Config.new(options[:config])
-      merged_options = config.merge_with_options(options)
-
-      docs_path = merged_options[:docs]
-
-      unless File.exist?(docs_path)
-        puts "Documentation path not found: #{docs_path}"
-        exit 1
-      end
-
-      puts "Generating llms.txt from #{docs_path}..." if merged_options[:verbose]
-
-      content = LlmsTxt.generate_from_docs(docs_path, merged_options)
-      output_path = merged_options[:output]
-
-      File.write(output_path, content)
-      puts "Successfully generated #{output_path}"
-
-      if merged_options[:verbose]
-        validator = LlmsTxt::Validator.new(content)
-        if validator.valid?
-          puts "Valid llms.txt format"
-        else
-          puts "Validation warnings:"
-          validator.errors.each { |error| puts "  - #{error}" }
-        end
-      end
-    end
-
-    def transform(options)
-      # Load config and merge with CLI options
-      config = LlmsTxt::Config.new(options[:config])
-      merged_options = config.merge_with_options(options)
-
-      file_path = options[:file_path]
-
-      unless file_path
-        puts "File path required for transform command"
-        exit 1
-      end
-
-      unless File.exist?(file_path)
-        puts "File not found: #{file_path}"
-        exit 1
-      end
-
-      puts "Transforming #{file_path}..." if merged_options[:verbose]
-
-      content = LlmsTxt.transform_markdown(file_path, merged_options)
-
-      if merged_options[:output] && merged_options[:output] != 'llms.txt'
-        File.write(merged_options[:output], content)
-        puts "Transformed content saved to #{merged_options[:output]}"
-      else
-        puts content
-      end
-    end
-
-    def bulk_transform(options)
-      # Load config and merge with CLI options
-      config = LlmsTxt::Config.new(options[:config])
-      merged_options = config.merge_with_options(options)
-
-      docs_path = merged_options[:docs]
-
-      unless File.exist?(docs_path)
-        puts "Documentation path not found: #{docs_path}"
-        exit 1
-      end
-
-      unless File.directory?(docs_path)
-        puts "Path must be a directory for bulk transformation: #{docs_path}"
-        exit 1
-      end
-
-      puts "Bulk transforming markdown files in #{docs_path}..." if merged_options[:verbose]
-      puts "Using suffix: #{merged_options[:suffix]}" if merged_options[:verbose]
-      puts "Excludes: #{merged_options[:excludes].join(', ')}" if merged_options[:verbose] && !merged_options[:excludes].empty?
-
-      begin
-        transformed_files = LlmsTxt.bulk_transform(docs_path, merged_options)
-
-        if transformed_files.empty?
-          puts "No markdown files found to transform"
-        else
-          puts "Successfully transformed #{transformed_files.size} files:"
-          transformed_files.each { |file| puts "  #{file}" } unless merged_options[:verbose] # verbose mode already shows progress
-        end
-      rescue LlmsTxt::Error => e
-        puts "Error during bulk transformation: #{e.message}"
-        exit 1
-      end
-    end
-
-    def parse(options)
-      file_path = options[:file_path] || 'llms.txt'
-
-      unless File.exist?(file_path)
-        puts "File not found: #{file_path}"
-        exit 1
-      end
-
-      parsed = LlmsTxt.parse(file_path)
-
-      if options[:verbose]
-        puts "Title: #{parsed.title}"
-        puts "Description: #{parsed.description}"
-        puts "Documentation Links: #{parsed.documentation_links.size}"
-        puts "Example Links: #{parsed.example_links.size}" if parsed.respond_to?(:example_links)
-        puts "Optional Links: #{parsed.optional_links.size}" if parsed.respond_to?(:optional_links)
-      else
-        puts parsed.to_xml if parsed.respond_to?(:to_xml)
-      end
-    end
-
-    def validate(options)
-      file_path = options[:file_path] || 'llms.txt'
-
-      unless File.exist?(file_path)
-        puts "File not found: #{file_path}"
-        exit 1
-      end
-
-      content = File.read(file_path)
-      valid = LlmsTxt.validate(content)
-
-      if valid
-        puts 'Valid llms.txt file'
-      else
-        puts 'Invalid llms.txt file'
-        puts "\nErrors:"
-        LlmsTxt::Validator.new(content).errors.each do |error|
-          puts "  - #{error}"
-        end
-        exit 1
-      end
-    end
-
-    def show_version
-      puts "llms-txt version #{LlmsTxt::VERSION}"
-    end
-  end
-end
-
-LlmsTxt::CLI.run # if $PROGRAM_NAME == __FILE__
+LlmsTxt::CLI.run

data/lib/llms_txt/cli.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module LlmsTxt
+  class CLI
+    def self.run(argv = ARGV)
+      new.run(argv)
+    end
+
+    def run(argv)
+      options = parse_options(argv)
+
+      case options[:command]
+      when 'generate', nil
+        generate(options)
+      when 'transform'
+        transform(options)
+      when 'bulk-transform'
+        bulk_transform(options)
+      when 'parse'
+        parse(options)
+      when 'validate'
+        validate(options)
+      when 'version'
+        show_version
+      else
+        puts "Unknown command: #{options[:command]}"
+        puts "Run 'llms-txt --help' for usage information"
+        exit 1
+      end
+    rescue LlmsTxt::Errors::BaseError => e
+      puts "Error: #{e.message}"
+      exit 1
+    rescue StandardError => e
+      puts "Unexpected error: #{e.message}"
+      puts e.backtrace.join("\n") if options&.fetch(:verbose, false)
+      exit 1
+    end
+
+    private
+
+    def parse_options(argv)
+      options = {
+        command: argv.first&.match?(/^[a-z-]+$/) ? argv.shift : nil
+      }
+
+      OptionParser.new do |opts|
+        opts.banner = "llms-txt - Simple tool for generating llms.txt from markdown documentation\n\nUsage: llms-txt [command] [options]\n\nFor advanced configuration (base_url, title, description, convert_urls), use a config file."
+
+        opts.separator ''
+        opts.separator 'Commands:'
+        opts.separator '  generate       Generate llms.txt from documentation (default)'
+        opts.separator '  transform      Transform a markdown file to be AI-friendly'
+        opts.separator '  bulk-transform Transform all markdown files in directory'
+        opts.separator '  parse          Parse existing llms.txt file'
+        opts.separator '  validate       Validate llms.txt file'
+        opts.separator '  version        Show version'
+
+        opts.separator ''
+        opts.separator 'Options:'
+
+        opts.on('-c', '--config PATH', 'Configuration file path (default: llms-txt.yml)') do |path|
+          options[:config] = path
+        end
+
+        opts.on('-d', '--docs PATH', 'Path to documentation directory or file') do |path|
+          options[:docs] = path
+        end
+
+        opts.on('-o', '--output PATH', 'Output file path') do |path|
+          options[:output] = path
+        end
+
+        opts.on('-v', '--verbose', 'Verbose output') do
+          options[:verbose] = true
+        end
+
+        opts.on('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+
+        opts.on('--version', 'Show version') do
+          show_version
+          exit
+        end
+      end.parse!(argv)
+
+      options[:file_path] = argv.first if argv.any?
+      options
+    end
+
+    def generate(options)
+      # Load config and merge with CLI options
+      config = LlmsTxt::Config.new(options[:config])
+      merged_options = config.merge_with_options(options)
+
+      docs_path = merged_options[:docs]
+
+      unless File.exist?(docs_path)
+        puts "Documentation path not found: #{docs_path}"
+        exit 1
+      end
+
+      puts "Generating llms.txt from #{docs_path}..." if merged_options[:verbose]
+
+      content = LlmsTxt.generate_from_docs(docs_path, merged_options)
+      output_path = merged_options[:output]
+
+      File.write(output_path, content)
+      puts "Successfully generated #{output_path}"
+
+      if merged_options[:verbose]
+        validator = LlmsTxt::Validator.new(content)
+        if validator.valid?
+          puts "Valid llms.txt format"
+        else
+          puts "Validation warnings:"
+          validator.errors.each { |error| puts "  - #{error}" }
+        end
+      end
+    end
+
+    def transform(options)
+      # Load config and merge with CLI options
+      config = LlmsTxt::Config.new(options[:config])
+      merged_options = config.merge_with_options(options)
+
+      file_path = options[:file_path]
+
+      unless file_path
+        puts "File path required for transform command"
+        exit 1
+      end
+
+      unless File.exist?(file_path)
+        puts "File not found: #{file_path}"
+        exit 1
+      end
+
+      puts "Transforming #{file_path}..." if merged_options[:verbose]
+
+      content = LlmsTxt.transform_markdown(file_path, merged_options)
+
+      if merged_options[:output] && merged_options[:output] != 'llms.txt'
+        File.write(merged_options[:output], content)
+        puts "Transformed content saved to #{merged_options[:output]}"
+      else
+        puts content
+      end
+    end
+
+    def bulk_transform(options)
+      # Load config and merge with CLI options
+      config = LlmsTxt::Config.new(options[:config])
+      merged_options = config.merge_with_options(options)
+
+      docs_path = merged_options[:docs]
+
+      unless File.exist?(docs_path)
+        puts "Documentation path not found: #{docs_path}"
+        exit 1
+      end
+
+      unless File.directory?(docs_path)
+        puts "Path must be a directory for bulk transformation: #{docs_path}"
+        exit 1
+      end
+
+      puts "Bulk transforming markdown files in #{docs_path}..." if merged_options[:verbose]
+      puts "Using suffix: #{merged_options[:suffix]}" if merged_options[:verbose]
+      puts "Excludes: #{merged_options[:excludes].join(', ')}" if merged_options[:verbose] && !merged_options[:excludes].empty?
+
+      begin
+        transformed_files = LlmsTxt.bulk_transform(docs_path, merged_options)
+
+        if transformed_files.empty?
+          puts "No markdown files found to transform"
+        else
+          puts "Successfully transformed #{transformed_files.size} files:"
+          transformed_files.each { |file| puts "  #{file}" } unless merged_options[:verbose] # verbose mode already shows progress
+        end
+      rescue LlmsTxt::Errors::BaseError => e
+        puts "Error during bulk transformation: #{e.message}"
+        exit 1
+      end
+    end
+
+    def parse(options)
+      file_path = options[:file_path] || 'llms.txt'
+
+      unless File.exist?(file_path)
+        puts "File not found: #{file_path}"
+        exit 1
+      end
+
+      parsed = LlmsTxt.parse(file_path)
+
+      if options[:verbose]
+        puts "Title: #{parsed.title}"
+        puts "Description: #{parsed.description}"
+        puts "Documentation Links: #{parsed.documentation_links.size}"
+        puts "Example Links: #{parsed.example_links.size}" if parsed.respond_to?(:example_links)
+        puts "Optional Links: #{parsed.optional_links.size}" if parsed.respond_to?(:optional_links)
+      else
+        puts parsed.to_xml if parsed.respond_to?(:to_xml)
+      end
+    end
+
+    def validate(options)
+      file_path = options[:file_path] || 'llms.txt'
+
+      unless File.exist?(file_path)
+        puts "File not found: #{file_path}"
+        exit 1
+      end
+
+      content = File.read(file_path)
+      valid = LlmsTxt.validate(content)
+
+      if valid
+        puts 'Valid llms.txt file'
+      else
+        puts 'Invalid llms.txt file'
+        puts "\nErrors:"
+        LlmsTxt::Validator.new(content).errors.each do |error|
+          puts "  - #{error}"
+        end
+        exit 1
+      end
+    end
+
+    def show_version
+      puts "llms-txt version #{LlmsTxt::VERSION}"
+    end
+  end
+end

data/lib/llms_txt/version.rb

@@ -2,5 +2,5 @@
 
 module LlmsTxt
   # Current version of the LlmsTxt gem
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/llms_txt.rb

@@ -5,6 +5,7 @@ require 'pathname'
 require 'find'
 
 loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect('cli' => 'CLI')
 loader.setup
 
 module LlmsTxt

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: llms-txt-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -121,6 +121,7 @@ files:
 - bin/llms-txt
 - lib/llms_txt.rb
 - lib/llms_txt/bulk_transformer.rb
+- lib/llms_txt/cli.rb
 - lib/llms_txt/config.rb
 - lib/llms_txt/errors.rb
 - lib/llms_txt/generator.rb