mirror of
https://github.com/ruby/ruby.git
synced 2025-08-15 21:49:06 +02:00
f64ba0fadd
Due to a problem with ripper we do not recognize `break` as invalid code. It's confusing that "Syntax OK" is output in that case.
When there's no syntax error, the algorithm should not say anything. The exception is in the CLI and that's for compatibility with `ruby -wc`
```
$ cat /tmp/break.rb
break
⛄️ 3.1.2 🚀 /Users/rschneeman/Documents/projects/syntax_suggest (schneems/no-syntax-not-okay-break)
$ ruby -wc /tmp/break.rb
Syntax OK
```
> Note that this is invalid, running this code will raise a Syntax error.
```
$ exe/syntax_suggest /tmp/break.rb
Syntax OK
```
Close https://github.com/ruby/syntax_suggest/pull/157
d7bd8f03a2
130 lines
3.1 KiB
Ruby
130 lines
3.1 KiB
Ruby
# frozen_string_literal: true
|
||
|
||
require "pathname"
|
||
require "optparse"
|
||
|
||
module SyntaxSuggest
|
||
# All the logic of the exe/syntax_suggest CLI in one handy spot
|
||
#
|
||
# Cli.new(argv: ["--help"]).call
|
||
# Cli.new(argv: ["<path/to/file>.rb"]).call
|
||
# Cli.new(argv: ["<path/to/file>.rb", "--record=tmp"]).call
|
||
# Cli.new(argv: ["<path/to/file>.rb", "--terminal"]).call
|
||
#
|
||
class Cli
|
||
attr_accessor :options
|
||
|
||
# ARGV is Everything passed to the executable, does not include executable name
|
||
#
|
||
# All other intputs are dependency injection for testing
|
||
def initialize(argv:, exit_obj: Kernel, io: $stdout, env: ENV)
|
||
@options = {}
|
||
@parser = nil
|
||
options[:record_dir] = env["SYNTAX_SUGGEST_RECORD_DIR"]
|
||
options[:record_dir] = "tmp" if env["DEBUG"]
|
||
options[:terminal] = SyntaxSuggest::DEFAULT_VALUE
|
||
|
||
@io = io
|
||
@argv = argv
|
||
@exit_obj = exit_obj
|
||
end
|
||
|
||
def call
|
||
if @argv.empty?
|
||
# Display help if raw command
|
||
parser.parse! %w[--help]
|
||
return
|
||
else
|
||
# Mutates @argv
|
||
parse
|
||
return if options[:exit]
|
||
end
|
||
|
||
file_name = @argv.first
|
||
if file_name.nil?
|
||
@io.puts "No file given"
|
||
@exit_obj.exit(1)
|
||
return
|
||
end
|
||
|
||
file = Pathname(file_name)
|
||
if !file.exist?
|
||
@io.puts "file not found: #{file.expand_path} "
|
||
@exit_obj.exit(1)
|
||
return
|
||
end
|
||
|
||
@io.puts "Record dir: #{options[:record_dir]}" if options[:record_dir]
|
||
|
||
display = SyntaxSuggest.call(
|
||
io: @io,
|
||
source: file.read,
|
||
filename: file.expand_path,
|
||
terminal: options.fetch(:terminal, SyntaxSuggest::DEFAULT_VALUE),
|
||
record_dir: options[:record_dir]
|
||
)
|
||
|
||
if display.document_ok?
|
||
@io.puts "Syntax OK"
|
||
@exit_obj.exit(0)
|
||
else
|
||
@exit_obj.exit(1)
|
||
end
|
||
end
|
||
|
||
def parse
|
||
parser.parse!(@argv)
|
||
|
||
self
|
||
end
|
||
|
||
def parser
|
||
@parser ||= OptionParser.new do |opts|
|
||
opts.banner = <<~EOM
|
||
Usage: syntax_suggest <file> [options]
|
||
|
||
Parses a ruby source file and searches for syntax error(s) such as
|
||
unexpected `end', expecting end-of-input.
|
||
|
||
Example:
|
||
|
||
$ syntax_suggest dog.rb
|
||
|
||
# ...
|
||
|
||
❯ 10 defdog
|
||
❯ 15 end
|
||
|
||
ENV options:
|
||
|
||
SYNTAX_SUGGEST_RECORD_DIR=<dir>
|
||
|
||
Records the steps used to search for a syntax error
|
||
to the given directory
|
||
|
||
Options:
|
||
EOM
|
||
|
||
opts.version = SyntaxSuggest::VERSION
|
||
|
||
opts.on("--help", "Help - displays this message") do |v|
|
||
@io.puts opts
|
||
options[:exit] = true
|
||
@exit_obj.exit
|
||
end
|
||
|
||
opts.on("--record <dir>", "Records the steps used to search for a syntax error to the given directory") do |v|
|
||
options[:record_dir] = v
|
||
end
|
||
|
||
opts.on("--terminal", "Enable terminal highlighting") do |v|
|
||
options[:terminal] = true
|
||
end
|
||
|
||
opts.on("--no-terminal", "Disable terminal highlighting") do |v|
|
||
options[:terminal] = false
|
||
end
|
||
end
|
||
end
|
||
end
|
||
end
|