syntax_tree 3.2.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e903c6474622266f71a8116d7a94a5a4cc437bb16bb7543f7c7de4d23ce15764
-  data.tar.gz: 33dd3eec6312d18285d7e1f5e04048fc0ac36dfb7fe51295ead1357f9d19c8e4
+  metadata.gz: f4410889ecf31d320edb7e45b5491c97ec1af42f782e486cf946cad4672ee5cd
+  data.tar.gz: c81d09784f746b0b115af55409196a640d17d972a91e7d116a45b9b69bcb7c14
 SHA512:
-  metadata.gz: 6cd1ea0a06ad365c1f7a24c0eefe0df70a7995d173c82c60fb3ec3a06c794960f7cabbbd6521c2b44b583227ed3cd27391ffbb0f8dd4812a4493606386b4355a
-  data.tar.gz: e42148794773a87f2dc862ff3ef346817074e6f67381cbaf248c53bbc3258d9062a073b5e5c3516ab21646276bc669adadf177d6879d862526d53d291c7be2cd
+  metadata.gz: 1c6badd15f529d426d771679f3e8ebbd690a705f66027caa6510bf01c2788b3968fd1c3523bfa3534d3dd048604b968c8c01059e5a2c6d2148130aebd77d8530
+  data.tar.gz: e4567e0f5259ceb1b840f4c10c50fac526e972932e22340a5456fc1f394872c04b5f5651b63859bff40fc4e40da19e9040db6c51a70b6beb27559fcbe1597987

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/main.yml

@@ -1,14 +1,14 @@
 name: Main
 on:
 - push
-- pull_request_target
+- pull_request
 jobs:
   ci:
     strategy:
       fail-fast: false
       matrix:
         ruby:
-        - '2.7'
+        - '2.7.0'
         - '3.0'
         - '3.1'
         - head
@@ -40,20 +40,3 @@ jobs:
       run: |
         bundle exec rake stree:check
         bundle exec rubocop
-
-  automerge:
-    name: AutoMerge
-    needs:
-    - ci
-    - check
-    runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
-    steps:
-    - uses: actions/github-script@v3
-      with:
-        script: |
-          github.pulls.merge({
-            owner: context.payload.repository.owner.login,
-            repo: context.payload.repository.name,
-            pull_number: context.payload.pull_request.number
-          })

data/.rubocop.yml

@@ -44,7 +44,7 @@ Style/ExplicitBlockArgument:
   Enabled: false
 
 Style/FormatString:
-  EnforcedStyle: percent
+  Enabled: false
 
 Style/GuardClause:
   Enabled: false

data/CHANGELOG.md

@@ -6,6 +6,38 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.5.0] - 2022-08-26
+
+### Added
+
+- [#148](https://github.com/ruby-syntax-tree/syntax_tree/pull/148) - Support Ruby 2.7.0 (previously we only supported back to 2.7.3).
+- [#152](https://github.com/ruby-syntax-tree/syntax_tree/pull/152) - Support the `-e` inline script option for the `stree` CLI.
+
+### Changed
+
+- [#141](https://github.com/ruby-syntax-tree/syntax_tree/pull/141) - Use `q.format` for `SyntaxTree.format` so that the main node gets pushed onto the stack for checking parent nodes.
+- [#147](https://github.com/ruby-syntax-tree/syntax_tree/pull/147) - Fix rightward assignment token management such that `in` and `=>` stay the same regardless of their context.
+
+## [3.4.0] - 2022-08-19
+
+### Added
+
+- [#127](https://github.com/ruby-syntax-tree/syntax_tree/pull/127) - Allow the language server to handle other file extensions if it is activated for those extensions.
+- [#133](https://github.com/ruby-syntax-tree/syntax_tree/pull/133) - Add documentation on supporting vim and neovim.
+
+### Changed
+
+- [#132](https://github.com/ruby-syntax-tree/syntax_tree/pull/132) - Provide better error messages when end quotes and end keywords are missing from tokens.
+- [#134](https://github.com/ruby-syntax-tree/syntax_tree/pull/134) - Ensure the correct `end` keyword is getting removed by `begin..rescue` clauses.
+- [#137](https://github.com/ruby-syntax-tree/syntax_tree/pull/137) - Better support regular expressions with no ending token.
+
+## [3.3.0] - 2022-08-02
+
+### Added
+
+- [#123](https://github.com/ruby-syntax-tree/syntax_tree/pull/123) - Allow the rake tasks to configure print width.
+- [#125](https://github.com/ruby-syntax-tree/syntax_tree/pull/125) - Add support for an `.streerc` file in the current working directory to configure the CLI.
+
 ## [3.2.1] - 2022-07-22
 
 ### Changed
@@ -312,7 +344,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.1...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.5.0...HEAD
+[3.5.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.4.0...v3.5.0
+[3.4.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.3.0...v3.4.0
+[3.3.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.1...v3.3.0
 [3.2.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.2.0...v3.2.1
 [3.2.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v3.0.1...v3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree (3.2.1)
+    syntax_tree (3.5.0)
       prettier_print
 
 GEM
@@ -10,26 +10,26 @@ GEM
     ast (2.4.2)
     docile (1.4.0)
     json (2.6.2)
-    minitest (5.16.2)
+    minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     prettier_print (0.1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.32.0)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)

data/README.md

@@ -19,6 +19,8 @@ It is built with only standard library dependencies. It additionally ships with
   - [json](#json)
   - [match](#match)
   - [write](#write)
+  - [Configuration](#configuration)
+  - [Globbing](#globbing)
 - [Library](#library)
   - [SyntaxTree.read(filepath)](#syntaxtreereadfilepath)
   - [SyntaxTree.parse(source)](#syntaxtreeparsesource)
@@ -43,7 +45,7 @@ It is built with only standard library dependencies. It additionally ships with
 - [Integration](#integration)
   - [Rake](#rake)
   - [RuboCop](#rubocop)
-  - [VSCode](#vscode)
+  - [Editors](#editors)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -231,6 +233,37 @@ To change the print width that you are writing with, specify the `--print-width`
 stree write --print-width=100 path/to/file.rb
 ```
 
+### Configuration
+
+Any of the above CLI commands can also read configuration options from a `.streerc` file in the directory where the commands are executed.
+
+This should be a text file with each argument on a separate line.
+
+```txt
+--print-width=100
+--plugins=plugin/trailing_comma
+```
+
+If this file is present, it will _always_ be used for CLI commands. You can also pass options from the command line as in the examples above. The options in the `.streerc` file are passed to the CLI first, then the arguments from the command line. In the case of exclusive options (e.g. `--print-width`), this means that the command line options override what's in the config file. In the case of options that can take multiple inputs (e.g. `--plugins`), the effect is additive. That is, the plugins passed from the command line will be loaded _in addition to_ the plugins in the config file.
+
+### Globbing
+
+When running commands with `stree`, it's common to pass in lists of files. For example:
+
+```sh
+stree write 'lib/*.rb' 'test/*.rb'
+```
+
+The commands in the CLI accept any number of arguments. This means you _could_ pass `**/*.rb` (note the lack of quotes). This would make your shell expand out the file paths listed according to its own rules. (For example, [here](https://www.gnu.org/software/bash/manual/html_node/Filename-Expansion.html) are the rules for GNU bash.)
+
+However, it's recommended to instead use quotes, which means that Ruby is responsible for performing the file path expansion instead. This ensures a consistent experience across different environments and shells. The globs must follow the Ruby-specific globbing syntax as specified in the documentation for [Dir](https://ruby-doc.org/core-3.1.1/Dir.html#method-c-glob).
+
+Baked into this syntax is the ability to provide exceptions to file name patterns as well. For example, if you are in a Rails app and want to exclude files named `schema.rb` but write all other Ruby files, you can use the following syntax:
+
+```shell
+stree write "**/{[!schema]*,*}.rb"
+```
+
 ## Library
 
 Syntax Tree can be used as a library to access the syntax tree underlying Ruby source code.
@@ -505,6 +538,16 @@ SyntaxTree::Rake::WriteTask.new do |t|
 end
 ```
 
+#### `print_width`
+
+If you want to use a different print width from the default (80), you can pass that to the `print_width` field, as in:
+
+```ruby
+SyntaxTree::Rake::WriteTask.new do |t|
+  t.print_width = 100
+end
+```
+
 #### `plugins`
 
 If you're running Syntax Tree with plugins (either your own or the pre-built ones), you can pass that to the `plugins` field, as in:
@@ -524,9 +567,11 @@ inherit_gem:
   syntax_tree: config/rubocop.yml
 ```
 
-### VSCode
+### Editors
 
-To integrate Syntax Tree into VSCode, you should use the official VSCode extension [ruby-syntax-tree/vscode-syntax-tree](https://github.com/ruby-syntax-tree/vscode-syntax-tree).
+* [Neovim](https://neovim.io/) - [neovim/nvim-lspconfig](https://github.com/neovim/nvim-lspconfig).
+* [Vim](https://www.vim.org/) - [dense-analysis/ale](https://github.com/dense-analysis/ale).
+* [VSCode](https://code.visualstudio.com/) - [ruby-syntax-tree/vscode-syntax-tree](https://github.com/ruby-syntax-tree/vscode-syntax-tree).
 
 ## Contributing
 

data/Rakefile

@@ -12,8 +12,17 @@ end
 
 task default: :test
 
-SOURCE_FILES =
-  FileList[%w[Gemfile Rakefile syntax_tree.gemspec lib/**/*.rb test/*.rb]]
+configure = ->(task) do
+  task.source_files =
+    FileList[%w[Gemfile Rakefile syntax_tree.gemspec lib/**/*.rb test/*.rb]]
 
-SyntaxTree::Rake::CheckTask.new { |t| t.source_files = SOURCE_FILES }
-SyntaxTree::Rake::WriteTask.new { |t| t.source_files = SOURCE_FILES }
+  # Since Syntax Tree supports back to Ruby 2.7.0, we need to make sure that we
+  # format our code such that it's compatible with that version. This actually
+  # has very little effect on the output, the only change at the moment is that
+  # Ruby < 2.7.3 didn't allow a newline before the closing brace of a hash
+  # pattern.
+  task.target_ruby_version = Gem::Version.new("2.7.0")
+end
+
+SyntaxTree::Rake::CheckTask.new(&configure)
+SyntaxTree::Rake::WriteTask.new(&configure)

data/lib/syntax_tree/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "optparse"
+
 module SyntaxTree
   # 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.
@@ -51,23 +53,34 @@ module SyntaxTree
       end
     end
 
-    # An item of work that corresponds to the stdin content.
-    class STDINItem
+    # An item of work that corresponds to a script content passed via the
+    # command line.
+    class ScriptItem
+      FILEPATH = :script
+
+      attr_reader :source
+
+      def initialize(source)
+        @source = source
+      end
+
       def handler
         HANDLERS[".rb"]
       end
 
       def filepath
-        :stdin
-      end
-
-      def source
-        $stdin.read
+        FILEPATH
       end
     end
 
     # The parent action class for the CLI that implements the basics.
     class Action
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
       def run(item)
       end
 
@@ -91,15 +104,9 @@ module SyntaxTree
       class UnformattedError < StandardError
       end
 
-      attr_reader :print_width
-
-      def initialize(print_width:)
-        @print_width = print_width
-      end
-
       def run(item)
         source = item.source
-        if source != item.handler.format(source, print_width)
+        if source != item.handler.format(source, options.print_width)
           raise UnformattedError
         end
       rescue StandardError
@@ -122,19 +129,13 @@ module SyntaxTree
       class NonIdempotentFormatError < StandardError
       end
 
-      attr_reader :print_width
-
-      def initialize(print_width:)
-        @print_width = print_width
-      end
-
       def run(item)
         handler = item.handler
 
         warning = "[#{Color.yellow("warn")}] #{item.filepath}"
-        formatted = handler.format(item.source, print_width)
+        formatted = handler.format(item.source, options.print_width)
 
-        if formatted != handler.format(formatted, print_width)
+        if formatted != handler.format(formatted, options.print_width)
           raise NonIdempotentFormatError
         end
       rescue StandardError
@@ -164,14 +165,8 @@ module SyntaxTree
 
     # An action of the CLI that formats the input source and prints it out.
     class Format < Action
-      attr_reader :print_width
-
-      def initialize(print_width:)
-        @print_width = print_width
-      end
-
       def run(item)
-        puts item.handler.format(item.source, print_width)
+        puts item.handler.format(item.source, options.print_width)
       end
     end
 
@@ -195,19 +190,13 @@ module SyntaxTree
     # An action of the CLI that formats the input source and writes the
     # formatted output back to the file.
     class Write < Action
-      attr_reader :print_width
-
-      def initialize(print_width:)
-        @print_width = print_width
-      end
-
       def run(item)
         filepath = item.filepath
         start = Time.now
 
         source = item.source
-        formatted = item.handler.format(source, print_width)
-        File.write(filepath, formatted) if filepath != :stdin
+        formatted = item.handler.format(source, options.print_width)
+        File.write(filepath, formatted) if item.filepath != :script
 
         color = source == formatted ? Color.gray(filepath) : filepath
         delta = ((Time.now - start) * 1000).round
@@ -222,25 +211,25 @@ module SyntaxTree
     # The help message displayed if the input arguments are not correctly
     # ordered or formatted.
     HELP = <<~HELP
-      #{Color.bold("stree ast [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree ast [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Print out the AST corresponding to the given files
 
-      #{Color.bold("stree check [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree check [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Check that the given files are formatted as syntax tree would format them
 
-      #{Color.bold("stree debug [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree debug [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Check that the given files can be formatted idempotently
 
-      #{Color.bold("stree doc [--plugins=...] FILE")}
+      #{Color.bold("stree doc [--plugins=...] [-e SCRIPT] FILE")}
         Print out the doc tree that would be used to format the given files
 
-      #{Color.bold("stree format [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree format [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Print out the formatted version of the given files
 
-      #{Color.bold("stree json [--plugins=...] FILE")}
+      #{Color.bold("stree json [--plugins=...] [-e SCRIPT] FILE")}
         Print out the JSON representation of the given files
 
-      #{Color.bold("stree match [--plugins=...] FILE")}
+      #{Color.bold("stree match [--plugins=...] [-e SCRIPT] FILE")}
         Print out a pattern-matching Ruby expression that would match the given files
 
       #{Color.bold("stree help")}
@@ -252,7 +241,7 @@ module SyntaxTree
       #{Color.bold("stree version")}
         Output the current version of syntax tree
 
-      #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] FILE")}
+      #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Read, format, and write back the source of the given files
 
       --plugins=...
@@ -260,71 +249,138 @@ module SyntaxTree
 
       --print-width=NUMBER
         The maximum line width to use when formatting.
+
+      -e SCRIPT
+        Parse an inline Ruby string.
     HELP
 
+    # This represents all of the options that can be passed to the CLI. It is
+    # responsible for parsing the list and then returning the file paths at the
+    # end.
+    class Options
+      attr_reader :plugins, :print_width, :scripts, :target_ruby_version
+
+      def initialize(print_width: DEFAULT_PRINT_WIDTH)
+        @plugins = []
+        @print_width = print_width
+        @scripts = []
+        @target_ruby_version = nil
+      end
+
+      # TODO: This function causes a couple of side-effects that I really don't
+      # like to have here. It mutates the global state by requiring the plugins,
+      # and mutates the global options hash by adding the target ruby version.
+      # That should be done on a config-by-config basis, not here.
+      def parse(arguments)
+        parser.parse!(arguments)
+      end
+
+      private
+
+      def parser
+        OptionParser.new do |opts|
+          # 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"
+          #
+          opts.on("--plugins=PLUGINS") do |plugins|
+            @plugins = plugins.split(",")
+            @plugins.each { |plugin| require "syntax_tree/#{plugin}" }
+          end
+
+          # If there is a print width specified on the command line, then
+          # parse that out here and use it when formatting.
+          opts.on("--print-width=NUMBER", Integer) do |print_width|
+            @print_width = print_width
+          end
+
+          # If there is a script specified on the command line, then parse
+          # it and add it to the list of scripts to run.
+          opts.on("-e SCRIPT") { |script| @scripts << script }
+
+          # If there is a target ruby version specified on the command line,
+          # parse that out and use it when formatting.
+          opts.on("--target-ruby-version=VERSION") do |version|
+            @target_ruby_version = Gem::Version.new(version)
+            Formatter::OPTIONS[:target_ruby_version] = @target_ruby_version
+          end
+        end
+      end
+    end
+
+    # We allow a minimal configuration file to act as additional command line
+    # arguments to the CLI. Each line of the config file should be a new
+    # argument, as in:
+    #
+    #     --plugins=plugin/single_quote
+    #     --print-width=100
+    #
+    # When invoking the CLI, we will read this config file and then parse it if
+    # it exists in the current working directory.
+    class ConfigFile
+      FILENAME = ".streerc"
+
+      attr_reader :filepath
+
+      def initialize
+        @filepath = File.join(Dir.pwd, FILENAME)
+      end
+
+      def exists?
+        File.readable?(filepath)
+      end
+
+      def arguments
+        exists? ? File.readlines(filepath, chomp: true) : []
+      end
+    end
+
     class << self
       # Run the CLI over the given array of strings that make up the arguments
       # passed to the invocation.
       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
+        config_file = ConfigFile.new
+        arguments.unshift(*config_file.arguments)
+
+        options = Options.new
+        options.parse(arguments)
 
         action =
           case name
           when "a", "ast"
-            AST.new
+            AST.new(options)
           when "c", "check"
-            Check.new(print_width: print_width)
+            Check.new(options)
           when "debug"
-            Debug.new(print_width: print_width)
+            Debug.new(options)
           when "doc"
-            Doc.new
+            Doc.new(options)
+          when "help"
+            puts HELP
+            return 0
           when "j", "json"
-            Json.new
+            Json.new(options)
+          when "lsp"
+            require "syntax_tree/language_server"
+            LanguageServer.new(print_width: options.print_width).run
+            return 0
           when "m", "match"
-            Match.new
+            Match.new(options)
           when "f", "format"
-            Format.new(print_width: print_width)
+            Format.new(options)
+          when "version"
+            puts SyntaxTree::VERSION
+            return 0
           when "w", "write"
-            Write.new(print_width: print_width)
+            Write.new(options)
           else
             warn(HELP)
             return 1
@@ -332,7 +388,7 @@ module SyntaxTree
 
         # 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?
+        if $stdin.tty? && arguments.empty? && options.scripts.empty?
           warn(HELP)
           return 1
         end
@@ -342,7 +398,7 @@ module SyntaxTree
 
         # 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?
+        if $stdin.tty? && (arguments.any? || options.scripts.any?)
           arguments.each do |pattern|
             Dir
               .glob(pattern)
@@ -350,8 +406,9 @@ module SyntaxTree
                 queue << FileItem.new(filepath) if File.file?(filepath)
               end
           end
+          options.scripts.each { |script| queue << ScriptItem.new(script) }
         else
-          queue << STDINItem.new
+          queue << ScriptItem.new($stdin.read)
         end
 
         # At the end, we're going to return whether or not this worker ever

data/lib/syntax_tree/formatter.rb

@@ -14,7 +14,11 @@ module SyntaxTree
     # Note that we're keeping this in a global-ish hash instead of just
     # overriding methods on classes so that other plugins can reference this if
     # necessary. For example, the RBS plugin references the quote style.
-    OPTIONS = { quote: "\"", trailing_comma: false }
+    OPTIONS = {
+      quote: "\"",
+      trailing_comma: false,
+      target_ruby_version: Gem::Version.new(RUBY_VERSION)
+    }
 
     COMMENT_PRIORITY = 1
     HEREDOC_PRIORITY = 2
@@ -23,14 +27,15 @@ module SyntaxTree
 
     # These options are overridden in plugins to we need to make sure they are
     # available here.
-    attr_reader :quote, :trailing_comma
+    attr_reader :quote, :trailing_comma, :target_ruby_version
     alias trailing_comma? trailing_comma
 
     def initialize(
       source,
       *args,
       quote: OPTIONS[:quote],
-      trailing_comma: OPTIONS[:trailing_comma]
+      trailing_comma: OPTIONS[:trailing_comma],
+      target_ruby_version: OPTIONS[:target_ruby_version]
     )
       super(*args)
 
@@ -40,13 +45,14 @@ module SyntaxTree
       # Memoizing these values per formatter to make access faster.
       @quote = quote
       @trailing_comma = trailing_comma
+      @target_ruby_version = target_ruby_version
     end
 
     def self.format(source, node)
-      formatter = new(source, [])
-      node.format(formatter)
-      formatter.flush
-      formatter.output.join
+      q = new(source, [])
+      q.format(node)
+      q.flush
+      q.output.join
     end
 
     def format(node, stackable: true)

data/lib/syntax_tree/language_server.rb

@@ -56,7 +56,7 @@ module SyntaxTree
           store.delete(uri)
         in { method: "textDocument/formatting", id:, params: { textDocument: { uri: } } }
           contents = store[uri]
-          write(id: id, result: contents ? [format(store[uri])] : nil)
+          write(id: id, result: contents ? [format(store[uri], uri.split(".").last)] : nil)
         in { method: "textDocument/inlayHint", id:, params: { textDocument: { uri: } } }
           contents = store[uri]
           write(id: id, result: contents ? inlay_hints(store[uri]) : nil)
@@ -86,7 +86,9 @@ module SyntaxTree
       }
     end
 
-    def format(source)
+    def format(source, extension)
+      text = SyntaxTree::HANDLERS[".#{extension}"].format(source, print_width)
+
       {
         range: {
           start: {
@@ -98,7 +100,7 @@ module SyntaxTree
             character: 0
           }
         },
-        newText: SyntaxTree.format(source, print_width)
+        newText: text
       }
     end
 
@@ -117,5 +119,9 @@ module SyntaxTree
       output.print("Content-Length: #{response.bytesize}\r\n\r\n#{response}")
       output.flush
     end
+
+    def log(message)
+      write(method: "window/logMessage", params: { type: 4, message: message })
+    end
   end
 end

data/lib/syntax_tree/node.rb

@@ -1978,7 +1978,7 @@ module SyntaxTree
         # If we hit a statements, then we're safe to use whatever since we
         # know for certain we're going to get split over multiple lines
         # anyway.
-        break false if parent.is_a?(Statements)
+        break false if parent.is_a?(Statements) || parent.is_a?(ArgParen)
 
         [Command, CommandCall].include?(parent.class)
       end
@@ -2132,8 +2132,7 @@ module SyntaxTree
         in [
              Paren[
                contents: {
-                 body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array]
-               }
+                 body: [ArrayLiteral[contents: { parts: [_, _, *] }] => array] }
              ]
            ]
           # Here we have a single argument that is a set of parentheses wrapping
@@ -5116,8 +5115,13 @@ module SyntaxTree
           q.breakable
           contents.call
         end
-        q.breakable
-        q.text("}")
+
+        if q.target_ruby_version < Gem::Version.new("2.7.3")
+          q.text(" }")
+        else
+          q.breakable
+          q.text("}")
+        end
       end
     end
   end
@@ -5204,8 +5208,7 @@ module SyntaxTree
             false
           in {
                statements: { body: [truthy] },
-               consequent: Else[statements: { body: [falsy] }]
-             }
+               consequent: Else[statements: { body: [falsy] }] }
             ternaryable?(truthy) && ternaryable?(falsy)
           else
             false

data/lib/syntax_tree/parser.rb

@@ -57,6 +57,26 @@ module SyntaxTree
       end
     end
 
+    # This represents all of the tokens coming back from the lexer. It is
+    # replacing a simple array because it keeps track of the last deleted token
+    # from the list for better error messages.
+    class TokenList < SimpleDelegator
+      attr_reader :last_deleted
+
+      def initialize(object)
+        super
+        @last_deleted = nil
+      end
+
+      def delete(value)
+        @last_deleted = super || @last_deleted
+      end
+
+      def delete_at(index)
+        @last_deleted = super
+      end
+    end
+
     # [String] the source being parsed
     attr_reader :source
 
@@ -124,7 +144,7 @@ module SyntaxTree
       # Most of the time, when a parser event consumes one of these events, it
       # will be deleted from the list. So ideally, this list stays pretty short
       # over the course of parsing a source string.
-      @tokens = []
+      @tokens = TokenList.new([])
 
       # Here we're going to build up a list of SingleByteString or
       # MultiByteString objects. They're each going to represent a string in the
@@ -174,6 +194,33 @@ module SyntaxTree
       line[column].to_i - line.start
     end
 
+    # Returns the current location that is being looked at for the parser for
+    # the purpose of locating the error.
+    def find_token_error(location)
+      if location
+        # If we explicitly passed a location into this find_token_error method,
+        # that means that's the source of the error, so we'll use that
+        # information for our error object.
+        lineno = location.start_line
+        [lineno, location.start_char - line_counts[lineno - 1].start]
+      elsif lineno && column
+        # If there is a line number associated with the current ripper state,
+        # then we'll use that information to generate the error.
+        [lineno, column]
+      elsif (location = tokens.last_deleted&.location)
+        # If we've already deleted a token from the list of tokens that we are
+        # consuming, then we'll fall back to that token's location.
+        lineno = location.start_line
+        [lineno, location.start_char - line_counts[lineno - 1].start]
+      else
+        # Finally, it's possible that when we hit this error the parsing thread
+        # for ripper has died. In that case, lineno and column both return nil.
+        # So we're just going to set it to line 1, column 0 in the hopes that
+        # that makes any sense.
+        [1, 0]
+      end
+    end
+
     # As we build up a list of tokens, we'll periodically need to go backwards
     # and find the ones that we've already hit in order to determine the
     # location information for nodes that use them. For example, if you have a
@@ -201,14 +248,7 @@ module SyntaxTree
         unless index
           token = value == :any ? type.name.split("::", 2).last : value
           message = "Cannot find expected #{token}"
-
-          if location
-            lineno = location.start_line
-            column = location.start_char - line_counts[lineno - 1].start
-            raise ParseError.new(message, lineno, column)
-          else
-            raise ParseError.new(message, lineno, column)
-          end
+          raise ParseError.new(message, *find_token_error(location))
         end
 
         tokens.delete_at(index)
@@ -677,8 +717,7 @@ module SyntaxTree
       else
         keyword = find_token(Kw, "begin")
         end_location =
-          if bodystmt.rescue_clause || bodystmt.ensure_clause ||
-               bodystmt.else_clause
+          if bodystmt.else_clause
             bodystmt.location
           else
             find_token(Kw, "end").location
@@ -871,7 +910,12 @@ module SyntaxTree
           location: keyword.location.to(consequent.location)
         )
       else
-        operator = find_token(Kw, "in", consume: false) || find_token(Op, "=>")
+        operator =
+          if (keyword = find_token(Kw, "in", consume: false))
+            tokens.delete(keyword)
+          else
+            find_token(Op, "=>")
+          end
 
         RAssign.new(
           value: value,
@@ -2798,14 +2842,21 @@ module SyntaxTree
     # :call-seq:
     #   on_regexp_literal: (
     #     RegexpContent regexp_content,
-    #     RegexpEnd ending
+    #     (nil | RegexpEnd) ending
     #   ) -> RegexpLiteral
     def on_regexp_literal(regexp_content, ending)
+      location = regexp_content.location
+
+      if ending.nil?
+        message = "Cannot find expected regular expression ending"
+        raise ParseError.new(message, *find_token_error(location))
+      end
+
       RegexpLiteral.new(
         beginning: regexp_content.beginning,
         ending: ending.value,
         parts: regexp_content.parts,
-        location: regexp_content.location.to(ending.location)
+        location: location.to(ending.location)
       )
     end
 

data/lib/syntax_tree/rake/check_task.rb

@@ -35,14 +35,26 @@ module SyntaxTree
       # Defaults to [].
       attr_accessor :plugins
 
+      # Max line length.
+      # Defaults to 80.
+      attr_accessor :print_width
+
+      # The target Ruby version to use for formatting.
+      # Defaults to Gem::Version.new(RUBY_VERSION).
+      attr_accessor :target_ruby_version
+
       def initialize(
         name = :"stree:check",
         source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = []
+        plugins = [],
+        print_width = DEFAULT_PRINT_WIDTH,
+        target_ruby_version = Gem::Version.new(RUBY_VERSION)
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
+        @print_width = print_width
+        @target_ruby_version = target_ruby_version
 
         yield self if block_given?
         define_task
@@ -59,6 +71,14 @@ module SyntaxTree
         arguments = ["check"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
 
+        if print_width != DEFAULT_PRINT_WIDTH
+          arguments << "--print-width=#{print_width}"
+        end
+
+        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
+          arguments << "--target-ruby-version=#{target_ruby_version}"
+        end
+
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end
     end

data/lib/syntax_tree/rake/write_task.rb

@@ -35,14 +35,26 @@ module SyntaxTree
       # Defaults to [].
       attr_accessor :plugins
 
+      # Max line length.
+      # Defaults to 80.
+      attr_accessor :print_width
+
+      # The target Ruby version to use for formatting.
+      # Defaults to Gem::Version.new(RUBY_VERSION).
+      attr_accessor :target_ruby_version
+
       def initialize(
         name = :"stree:write",
         source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = []
+        plugins = [],
+        print_width = DEFAULT_PRINT_WIDTH,
+        target_ruby_version = Gem::Version.new(RUBY_VERSION)
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
+        @print_width = print_width
+        @target_ruby_version = target_ruby_version
 
         yield self if block_given?
         define_task
@@ -59,6 +71,14 @@ module SyntaxTree
         arguments = ["write"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
 
+        if print_width != DEFAULT_PRINT_WIDTH
+          arguments << "--print-width=#{print_width}"
+        end
+
+        if target_ruby_version != Gem::Version.new(RUBY_VERSION)
+          arguments << "--target-ruby-version=#{target_ruby_version}"
+        end
+
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end
     end

data/lib/syntax_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SyntaxTree
-  VERSION = "3.2.1"
+  VERSION = "3.5.0"
 end

data/lib/syntax_tree.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "delegate"
 require "etc"
 require "json"
 require "pp"

data/syntax_tree.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
         .reject { |f| f.match(%r{^(test|spec|features)/}) }
     end
 
-  spec.required_ruby_version = ">= 2.7.3"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print
@@ -103,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/gh-pages.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
@@ -153,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="