Module: SyntaxTree::CLI

Defined in:

lib/syntax_tree/cli.rb

Overview

Syntax Tree ships with the ‘stree` CLI, which can be used to inspect and manipulate Ruby code. This module is responsible for powering that CLI.

Defined Under Namespace

Classes: AST, Action, Check, Color, Debug, Doc, FileItem, Format, Json, Match, STDINItem, Write

Constant Summary

HELP =

The help message displayed if the input arguments are not correctly ordered or formatted.

<<~HELP
  #{Color.bold("stree ast [--plugins=...] [--print-width=NUMBER] FILE")}
    Print out the AST corresponding to the given files

  #{Color.bold("stree check [--plugins=...] [--print-width=NUMBER] FILE")}
    Check that the given files are formatted as syntax tree would format them

  #{Color.bold("stree debug [--plugins=...] [--print-width=NUMBER] FILE")}
    Check that the given files can be formatted idempotently

  #{Color.bold("stree doc [--plugins=...] FILE")}
    Print out the doc tree that would be used to format the given files

  #{Color.bold("stree format [--plugins=...] [--print-width=NUMBER] FILE")}
    Print out the formatted version of the given files

  #{Color.bold("stree json [--plugins=...] FILE")}
    Print out the JSON representation of the given files

  #{Color.bold("stree match [--plugins=...] FILE")}
    Print out a pattern-matching Ruby expression that would match the given files

  #{Color.bold("stree help")}
    Display this help message

  #{Color.bold("stree lsp [--plugins=...] [--print-width=NUMBER]")}
    Run syntax tree in language server mode

  #{Color.bold("stree version")}
    Output the current version of syntax tree

  #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] FILE")}
    Read, format, and write back the source of the given files

  --plugins=...
    A comma-separated list of plugins to load.

  --print-width=NUMBER
    The maximum line width to use when formatting.
HELP

Class Method Summary

• .run(argv) ⇒ Object

  Run the CLI over the given array of strings that make up the arguments passed to the invocation.

Class Method Details

.run(argv) ⇒ Object

Run the CLI over the given array of strings that make up the arguments passed to the invocation.

# File 'lib/syntax_tree/cli.rb', line 268

def run(argv)
  name, *arguments = argv
  print_width = DEFAULT_PRINT_WIDTH

  while arguments.first&.start_with?("--")
    case (argument = arguments.shift)
    when /^--plugins=(.+)$/
      # If there are any plugins specified on the command line, then load
      # them by requiring them here. We do this by transforming something
      # like
      #
      #     stree format --plugins=haml template.haml
      #
      # into
      #
      #     require "syntax_tree/haml"
      #
      $1.split(",").each { |plugin| require "syntax_tree/#{plugin}" }
    when /^--print-width=(\d+)$/
      # If there is a print width specified on the command line, then
      # parse that out here and use it when formatting.
      print_width = Integer($1)
    else
      warn("Unknown CLI option: #{argument}")
      warn(HELP)
      return 1
    end
  end

  case name
  when "help"
    puts HELP
    return 0
  when "lsp"
    require "syntax_tree/language_server"
    LanguageServer.new(print_width: print_width).run
    return 0
  when "version"
    puts SyntaxTree::VERSION
    return 0
  end

  action =
    case name
    when "a", "ast"
      AST.new
    when "c", "check"
      Check.new(print_width: print_width)
    when "debug"
      Debug.new(print_width: print_width)
    when "doc"
      Doc.new
    when "j", "json"
      Json.new
    when "m", "match"
      Match.new
    when "f", "format"
      Format.new(print_width: print_width)
    when "w", "write"
      Write.new(print_width: print_width)
    else
      warn(HELP)
      return 1
    end

  # If we're not reading from stdin and the user didn't supply and
  # filepaths to be read, then we exit with the usage message.
  if $stdin.tty? && arguments.empty?
    warn(HELP)
    return 1
  end

  # We're going to build up a queue of items to process.
  queue = Queue.new

  # If we're reading from stdin, then we'll just add the stdin object to
  # the queue. Otherwise, we'll add each of the filepaths to the queue.
  if $stdin.tty? || arguments.any?
    arguments.each do |pattern|
      Dir
        .glob(pattern)
        .each do |filepath|
          queue << FileItem.new(filepath) if File.file?(filepath)
        end
    end
  else
    queue << STDINItem.new
  end

  # At the end, we're going to return whether or not this worker ever
  # encountered an error.
  if process_queue(queue, action)
    action.failure
    1
  else
    action.success
    0
  end
end