syntax_tree 6.1.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31a164da5fc7e3de4ae0d009993bd0d7b81ca0fd6d99dffe97e932321e122beb
-  data.tar.gz: d345c0e73f3286e5e8ade42d6c39646b2537a7b184fb14d4af4fdb031c8a9f8b
+  metadata.gz: 4d2e2bb8b41f091f6895ef5207081790c08ddaab126e8d5ddac324d9c13ea012
+  data.tar.gz: 9383e5f306415f9ad9e52c1cc58766fc629ae612644006a794229641a68cc7e7
 SHA512:
-  metadata.gz: fe70bcbd90253660d903278f23858a19fc9c644cb3f8b5fc1d8772be552f9cd594565445a3970dcec7374a27c3d087e3c772397d1ed9fb8bb86d616fa481ee06
-  data.tar.gz: 2d676538addd43745630e1721a4f059e3342d46902fbb25702b6daa16adae80c3f376444ddd67dd079569feeab8f0322ec9acef79a024789348372575263fbaf
+  metadata.gz: 1da6c505691e7a07716c26c57e536f38cae5b4c13a370a9e95e75aeda01e460bb6c9d7e21bc2cc8c226cdba412d064d4a386a8b6418e729af2243913b86c1087
+  data.tar.gz: b72d5dc5173edbeba46427278297f6b5c90d755f5806fa154084faef72978895e1a84ebb2cb3a52401b231b1c73e07c3f90f7268c14d115dc4036cee0632c0c2

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

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Dependabot metadata
         id: metadata
-        uses: dependabot/fetch-metadata@v1.3.6
+        uses: dependabot/fetch-metadata@v2.4.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       - name: Enable auto-merge for Dependabot PRs

data/.github/workflows/gh-pages.yml

@@ -5,8 +5,8 @@ on:
     branches:
       - main
 
-    # Allows you to run this workflow manually from the Actions tab
-    workflow_dispatch:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
@@ -25,9 +25,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v5
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -39,7 +39,7 @@ jobs:
           rdoc --main README.md --op _site --exclude={Gemfile,Rakefile,"coverage/*","vendor/*","bin/*","test/*","tmp/*"}
           cp -r doc _site/doc
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
 
   # Deployment job
   deploy:
@@ -51,4 +51,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

data/.github/workflows/main.yml

@@ -14,7 +14,8 @@ jobs:
         - '3.0'
         - '3.1'
         - '3.2'
-        - head
+        - '3.3'
+        - '3.4'
         - truffleruby-head
     name: CI
     runs-on: ubuntu-latest

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   SuggestExtensions: false
   TargetRubyVersion: 2.7
   Exclude:
-  - '{.git,.github,bin,coverage,pkg,sorbet,spec,test/fixtures,vendor,tmp}/**/*'
+  - '{.git,.github,.ruby-lsp,bin,coverage,doc,pkg,sorbet,spec,test/fixtures,vendor,tmp}/**/*'
   - test.rb
 
 Gemspec/DevelopmentDependencies:
@@ -136,6 +136,9 @@ Style/KeywordParametersOrder:
 Style/MissingRespondToMissing:
   Enabled: false
 
+Style/MultipleComparison:
+  Enabled: false
+
 Style/MutableConstant:
   Enabled: false
 
@@ -154,6 +157,12 @@ Style/ParallelAssignment:
 Style/PerlBackrefs:
   Enabled: false
 
+Style/RedundantArrayConstructor:
+  Enabled: false
+
+Style/RedundantParentheses:
+  Enabled: false
+
 Style/SafeNavigation:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,6 +6,30 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [6.3.0] - 2025-07-16
+
+### Added
+
+- The `--extension` command line option has been added to the CLI to specify what type of content is coming from stdin.
+- The `--config` command line option has been added to the CLI to specify the path to the configuration file.
+
+### Changed
+
+- Fix formatting of character literals when single quotes is enabled.
+- Pass ignore files option to the language server.
+- Hash keys should remain unchanged when there are any omitted values in the hash.
+- We now properly handle compilation errors in the parser.
+
+## [6.2.0] - 2023-09-20
+
+### Added
+
+- Fix `WithScope` for destructured post arguments.
+
+### Changed
+
+- Always use `do`/`end` for multi-line lambdas.
+
 ## [6.1.1] - 2023-03-21
 
 ### Changed
@@ -603,7 +627,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/v6.0.2...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.2.0...HEAD
+[6.2.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.1.1...v6.2.0
+[6.1.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.1.0...v6.1.1
+[6.1.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.0.2...v6.1.0
 [6.0.2]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.0.1...v6.0.2
 [6.0.1]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v6.0.0...v6.0.1
 [6.0.0]: https://github.com/ruby-syntax-tree/syntax_tree/compare/v5.3.0...v6.0.0

data/Gemfile

@@ -3,3 +3,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "fiddle"

data/Gemfile.lock

@@ -1,44 +1,53 @@
 PATH
   remote: .
   specs:
-    syntax_tree (6.1.1)
+    syntax_tree (6.3.0)
       prettier_print (>= 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    docile (1.4.0)
-    json (2.6.3)
-    minitest (5.18.0)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    ast (2.4.3)
+    docile (1.4.1)
+    fiddle (1.1.8)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
+      racc
     prettier_print (1.2.1)
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rubocop (1.48.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rubocop (1.78.0)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
-      parser (>= 3.2.1.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.4.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   arm64-darwin-21
@@ -49,6 +58,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  fiddle
   minitest
   rake
   rubocop

data/README.md

@@ -187,7 +187,7 @@ SyntaxTree::Binary[
 
 ### format
 
-This command will output the formatted version of each of the listed files. Importantly, it will not write that content back to the source files. It is meant to display the formatted version only.
+This command will output the formatted version of each of the listed files to stdout. Importantly, it will not write that content back to the source files – for that, you want [`write`](#write).
 
 ```sh
 stree format path/to/file.rb
@@ -297,7 +297,7 @@ Note that the output of the `match` CLI command creates a valid pattern that can
 
 ### write
 
-This command will format the listed files and write that formatted version back to the source files. Note that this overwrites the original content, to be sure to be using a version control system.
+This command will format the listed files and write that formatted version back to the source files. Note that this overwrites the original content, so be sure to be using a version control system.
 
 ```sh
 stree write path/to/file.rb
@@ -525,7 +525,7 @@ With visitors, you only define handlers for the nodes that you need. You can fin
 * call `visit(child)` with each child that you want to visit
 * call nothing if you're sure you don't want to descend further
 
-There are a couple of visitors that ship with Syntax Tree that can be used as examples. They live in the [lib/syntax_tree/visitor](lib/syntax_tree/visitor) directory.
+There are a couple of visitors that ship with Syntax Tree that can be used as examples. They live in the [lib/syntax_tree](lib/syntax_tree) directory.
 
 ### visit_method
 

data/lib/syntax_tree/cli.rb

@@ -63,12 +63,13 @@ module SyntaxTree
     class ScriptItem
       attr_reader :source
 
-      def initialize(source)
+      def initialize(source, extension)
         @source = source
+        @extension = extension
       end
 
       def handler
-        HANDLERS[".rb"]
+        HANDLERS[@extension]
       end
 
       def filepath
@@ -82,8 +83,12 @@ module SyntaxTree
 
     # An item of work that correspond to the content passed in via stdin.
     class STDINItem
+      def initialize(extension)
+        @extension = extension
+      end
+
       def handler
-        HANDLERS[".rb"]
+        HANDLERS[@extension]
       end
 
       def filepath
@@ -159,7 +164,7 @@ module SyntaxTree
       attr_reader :entries
 
       def initialize(options)
-        super(options)
+        super
         @entries = []
       end
 
@@ -450,14 +455,26 @@ module SyntaxTree
       #{Color.bold("stree write [--plugins=...] [--print-width=NUMBER] [-e SCRIPT] FILE")}
         Read, format, and write back the source of the given files
 
+      --ignore-files=...
+        A glob pattern to ignore files when processing. This can be specified
+        multiple times to ignore multiple patterns.
+
       --plugins=...
         A comma-separated list of plugins to load.
 
-      --print-width=NUMBER
+      --print-width=...
         The maximum line width to use when formatting.
 
-      -e SCRIPT
-        Parse an inline Ruby string.
+      -e ...
+        Parse an inline string.
+
+      --extension=...
+        A file extension matching the content passed in via STDIN or -e.
+        Defaults to '.rb'.
+
+      --config=...
+        Path to a configuration file. Defaults to .streerc in the current
+        working directory.
     HELP
 
     # This represents all of the options that can be passed to the CLI. It is
@@ -468,6 +485,7 @@ module SyntaxTree
                   :plugins,
                   :print_width,
                   :scripts,
+                  :extension,
                   :target_ruby_version
 
       def initialize
@@ -475,6 +493,7 @@ module SyntaxTree
         @plugins = []
         @print_width = DEFAULT_PRINT_WIDTH
         @scripts = []
+        @extension = ".rb"
         @target_ruby_version = DEFAULT_RUBY_VERSION
       end
 
@@ -523,6 +542,13 @@ module SyntaxTree
           # it and add it to the list of scripts to run.
           opts.on("-e SCRIPT") { |script| @scripts << script }
 
+          # If there is a extension specified, then parse it and use it for
+          # STDIN and scripts.
+          opts.on("--extension=EXTENSION") do |extension|
+            # Both ".rb" and "rb" are going to work
+            @extension = ".#{extension.delete_prefix(".")}"
+          end
+
           # 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|
@@ -546,8 +572,16 @@ module SyntaxTree
 
       attr_reader :filepath
 
-      def initialize
-        @filepath = File.join(Dir.pwd, FILENAME)
+      def initialize(filepath = nil)
+        if filepath
+          if File.readable?(filepath)
+            @filepath = filepath
+          else
+            raise ArgumentError, "Invalid configuration file: #{filepath}"
+          end
+        else
+          @filepath = File.join(Dir.pwd, FILENAME)
+        end
       end
 
       def exists?
@@ -565,8 +599,24 @@ module SyntaxTree
       def run(argv)
         name, *arguments = argv
 
-        config_file = ConfigFile.new
-        arguments.unshift(*config_file.arguments)
+        # First, we need to check if there's a --config option specified
+        # so we can use the custom config file path.
+        config_filepath = nil
+        arguments.each_with_index do |arg, index|
+          if arg.start_with?("--config=")
+            config_filepath = arg.split("=", 2)[1]
+            arguments.delete_at(index)
+            break
+          elsif arg == "--config" && arguments[index + 1]
+            config_filepath = arguments[index + 1]
+            arguments.delete_at(index + 1)
+            arguments.delete_at(index)
+            break
+          end
+        end
+
+        config_file = ConfigFile.new(config_filepath)
+        arguments = config_file.arguments.concat(arguments)
 
         options = Options.new
         options.parse(arguments)
@@ -593,7 +643,10 @@ module SyntaxTree
           when "j", "json"
             Json.new(options)
           when "lsp"
-            LanguageServer.new(print_width: options.print_width).run
+            LanguageServer.new(
+              print_width: options.print_width,
+              ignore_files: options.ignore_files
+            ).run
             return 0
           when "m", "match"
             Match.new(options)
@@ -630,9 +683,11 @@ module SyntaxTree
               end
           end
 
-          options.scripts.each { |script| queue << ScriptItem.new(script) }
+          options.scripts.each do |script|
+            queue << ScriptItem.new(script, options.extension)
+          end
         else
-          queue << STDINItem.new
+          queue << STDINItem.new(options.extension)
         end
 
         # At the end, we're going to return whether or not this worker ever