syntax_tree 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e903c6474622266f71a8116d7a94a5a4cc437bb16bb7543f7c7de4d23ce15764
-  data.tar.gz: 33dd3eec6312d18285d7e1f5e04048fc0ac36dfb7fe51295ead1357f9d19c8e4
+  metadata.gz: 92ff69f19d5433566404bce6888eae08a442861821612c986489db05679ecd22
+  data.tar.gz: e05511cf866fa1e0cfde540f0a0bc84a88414b128583a37a68c73658ff667b16
 SHA512:
-  metadata.gz: 6cd1ea0a06ad365c1f7a24c0eefe0df70a7995d173c82c60fb3ec3a06c794960f7cabbbd6521c2b44b583227ed3cd27391ffbb0f8dd4812a4493606386b4355a
-  data.tar.gz: e42148794773a87f2dc862ff3ef346817074e6f67381cbaf248c53bbc3258d9062a073b5e5c3516ab21646276bc669adadf177d6879d862526d53d291c7be2cd
+  metadata.gz: 3d98f8b9a997ef9278ad2ea9c1600ee5abc52c646d157b0180f6cf6956ebde2ccc6d9ea917436231645a7d4bf58ce1627fbae393b89e81b683157bc5263d65e0
+  data.tar.gz: 924ccb54dec3055dca88aef5efe839d2c979abedfdf96f5e0996e18390b3e246b676cdb1c8aba6d51edfed42219bff3c80b4bfcead0eb3f6b926e585c96f0a1b

data/CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [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 +319,8 @@ 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.3.0...HEAD
+[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.3.0)
       prettier_print
 
 GEM

data/README.md

@@ -19,6 +19,7 @@ It is built with only standard library dependencies. It additionally ships with
   - [json](#json)
   - [match](#match)
   - [write](#write)
+  - [Configuration](#configuration)
 - [Library](#library)
   - [SyntaxTree.read(filepath)](#syntaxtreereadfilepath)
   - [SyntaxTree.parse(source)](#syntaxtreeparsesource)
@@ -231,6 +232,19 @@ 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.
+
 ## Library
 
 Syntax Tree can be used as a library to access the syntax tree underlying Ruby source code.
@@ -505,6 +519,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:

data/lib/syntax_tree/cli.rb

@@ -4,6 +4,8 @@ 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.
   module CLI
+    CONFIG_FILE = ".streerc"
+
     # A utility wrapper around colored strings in the output.
     class Color
       attr_reader :value, :code
@@ -269,6 +271,11 @@ module SyntaxTree
         name, *arguments = argv
         print_width = DEFAULT_PRINT_WIDTH
 
+        config_file = File.join(Dir.pwd, CONFIG_FILE)
+        if File.readable?(config_file)
+          arguments.unshift(*File.readlines(config_file, chomp: true))
+        end
+
         while arguments.first&.start_with?("--")
           case (argument = arguments.shift)
           when /^--plugins=(.+)$/

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

data/lib/syntax_tree/rake/check_task.rb

@@ -35,14 +35,20 @@ module SyntaxTree
       # Defaults to [].
       attr_accessor :plugins
 
+      # Max line length.
+      # Defaults to 80.
+      attr_accessor :print_width
+
       def initialize(
         name = :"stree:check",
         source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = []
+        plugins = [],
+        print_width = DEFAULT_PRINT_WIDTH
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
+        @print_width = print_width
 
         yield self if block_given?
         define_task
@@ -58,6 +64,9 @@ module SyntaxTree
       def run_task
         arguments = ["check"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+        if print_width != DEFAULT_PRINT_WIDTH
+          arguments << "--print-width=#{print_width}"
+        end
 
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end

data/lib/syntax_tree/rake/write_task.rb

@@ -35,14 +35,20 @@ module SyntaxTree
       # Defaults to [].
       attr_accessor :plugins
 
+      # Max line length.
+      # Defaults to 80.
+      attr_accessor :print_width
+
       def initialize(
         name = :"stree:write",
         source_files = ::Rake::FileList["lib/**/*.rb"],
-        plugins = []
+        plugins = [],
+        print_width = DEFAULT_PRINT_WIDTH
       )
         @name = name
         @source_files = source_files
         @plugins = plugins
+        @print_width = print_width
 
         yield self if block_given?
         define_task
@@ -58,6 +64,9 @@ module SyntaxTree
       def run_task
         arguments = ["write"]
         arguments << "--plugins=#{plugins.join(",")}" if plugins.any?
+        if print_width != DEFAULT_PRINT_WIDTH
+          arguments << "--print-width=#{print_width}"
+        end
 
         SyntaxTree::CLI.run(arguments + Array(source_files))
       end

data/lib/syntax_tree/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prettier_print