Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Unreleased

4.0.4 - 2023-12-12

Changed

#1413 - hrabe - Fix the cwd detection for mono-repos.

4.0.3 - 2023-11-27

Changed

#1406 - mikesea - Support running without the RBS or Haml plugins loaded.
#1407 - hrabe - Support shimmed Ruby versions.

4.0.2 - 2023-07-14

Changed

#1367 - kddnewton - Specify prettier as a peer dependency and not a runtime dependency.

4.0.1 - 2023-07-08

Changed

#1363 - mscrivo, kddnewton - Ensure all data is read from socket before attempting to parse to JSON.

4.0.0 - 2023-07-06

Added

#1283 - oriolgual - Use process.execPath instead of "node".
#1358 - davidalejandroaguilar - Add the rubyExecutablePath option.
#1359 - kddnewton - Inherit stderr from the parser process in order to provide better error messages when failing to spawn parser server. This will put out missing gem errors, for example.

Changed

#1360 - kddnewton - Require prettier v3.0.0+.

3.2.2 - 2022-09-20

Changed

#1276 - kddnewton - Fix the parsing for options being passed to the server process.

3.2.1 - 2022-09-19

Changed

#1274 - kddnewton - Support the next version of syntax_tree-haml.

3.2.0 - 2022-07-22

Added

#1250 - alexf101, kddnewton - Respect the tabWidth option.

Changed

#1255 - soberstadt - The rake task now runs check if write is false.
#1237 - boris-petrov - Disable the style rules associated with quotes.
#1248 - mhssmnn - Fix process waiting on STDIN.

3.1.2 - 2022-05-13

Changed

#1127 - mscrivo, kddnewton - Support passing the printWidth option.

3.1.1 - 2022-05-12

Changed

#1125 - kddnewton - Update the bundled rubocop config to be in sync with Syntax Tree.

3.1.0 - 2022-05-12

Added

#1224 - kddnewton - Support passing the rubyPlugins option to configure Syntax Tree.

3.0.0 - 2022-05-04

Added

#1190 - kddnewton - Encoding for source files is now guessed in a much better way.

Changed

#1198 - pas-f, kddnewton - Fix crashes on JRuby with do blocks.
#1131 - hyrious, kddnewton - Ensure zombie processes are not left around when the server exits.
#1206 - kddnewton - Switch back to plain JavaScript for development.
#1190 - kddnewton - Switch over to using Syntax Tree for the backend. This now requires that users install the necessary gems.

Removed

#1190 - kddnewton - The configuration options have been removed. Instead, configuration is to be done through modifying Syntax Tree.

2.1.0 - 2022-04-04

Added

#1065 - langalex, kddnewton - The ability to set the PRETTIER_RUBY_TIMEOUT_MS environment variable to control how long to wait for the parser server to spin up.
#1173 - dleavitt - Support for RBS 2.x on Ruby 3.1.

Changed

#1028 - levymetal, kddnewton - Fix up some nested formatting with very complicated RSpec assertions.
#1035 - qcn, kddnewton - Ensure we don't try to print return incorrectly when multiple statements are contained within parentheses.
#1048 - kddnewton - Completely refactor the Ruby parser to use classes instead of hashes. Also remove a lot of the body keys are replace them with actual names.
#1042 - JoshuaKGoldberg, kddnewton - Ensure blocks are printed correctly when there are trailing comments on the do keyword.
#1134 - mhssmnn - Fix piping for STDIN to the gem process.
#1167 - dleavitt - More consistent assignment indentation.
#1074 - wagenet, kddnewton - Fix up return when nodes return arrays of docs.

Removed

#1048 - kddnewton - Drop support for Ruby 2.5.

2.0.0 - 2021-10-28

Changed

#1018 - rindek, kddnewton - Ensure brackets are used when matching an array pattern with a single element.
#906 - Hansenq, kddnewton - Turn off the Style/MultilineBlockChain rubocop rule in our shipped configuration because multiple chained method calls with blocks can potentially conflict with rubocop's desired output.

2.0.0-rc4 - 2021-10-18

Added

#993 - kddnewton - Nicer error message if you don't have the necessary JavaScript files to run prettier.
#996 - nbudin - Allow @prettier/plugin-ruby to run in yarn's plug'n'play mode.

Changed

#1000 - nbudin, kddnewton - Fix for rescuing single top-level exceptions in rescue clauses.

2.0.0-rc3 - 2021-10-01

Changed

#987 - valscion - Ignore stderr when checking for node <-> ruby connection clients, restoring the behavior of v1.x
#989 - hubertjakubiak, kddnewton - Make sure comments after the keyword/lbrace are not moved inside the body of the statements of do and brace blocks.

2.0.0-rc2 - 2021-09-30

Added

#979 - ronocod, kddnewton - Alignment of to_not is explicitly allowed to not indent to better support rspec.
#894 - mister-what, kddnewton - Add a warning that this plugin will not function with the plug'n'play filesystem provided by yarn berry.

Changed

#943 - valscion, kddnewton - Trailing call operators that are followed by comments should stay on the first line.

2.0.0-rc1 - 2021-09-30

Added

#949 - kddnewton - Converted over to using TypeScript for development.

Changed

#958 - mharris-figma, kddnewton - Handle optional do keyword in for loop expressions.
#926 - jscheid, kddnewton - Better error handling in case certain expected keywords or operators are missing.
#819 - coisnepe, kddnewton - Ensure that comments placed immediately after the left parenthesis of a method definition are not moved into the body of the methods.
#957 - azz, kddnewton - Make it so that the format pragma does not have to be on the first line of the file.
#895 - rsslldnphy, kddnewton - Ensure quotes are properly escaped in the content of a hash value for HAML attributes.
#900 - rsslldnphy, kddnewton - Ensure that in a HAML line where you have interpolation inside of a tag content that you print it properly.
#929 - ryanb, kddnewton - Deeply nested blocks should not break their call chains.
#935 - nbudin, mlauter - Ensure embedded formatting heredocs are properly indented.
#975 - kddnewton - Refactor the way we determine how to connect to the parser server.

Removed

#976 - kddnewton - Remove the rubyNetcatCommand option, as it should no longer be necessary.

1.6.1 - 2021-06-30

Changed

#862 - azz, kddnewton - Group together .where.not calls in method chains.
#863 - azz, kddnewton - Fix up Sorbet sig block formatting when chaining method calls.
#908 - Hansenq, kddnewton - Method chains with blocks should be properly indented.
#916 - pbrisbin, kddnewton - Ensure all of the necessary files are present in the gem.
#917 - jscheid, kddnewton - Ensure hash keys with dynamic symbols don't strip their quotes.

1.6.0 - 2021-06-23

Added

#859 - azz, kddnewton - Support the --insert-pragma option for the incremental adoption workflow.
#904 - Hansenq, kddnewton - Support the %s symbol literal syntax.
#833 - kddnewton - Support for prettier >= v2.3.0.

Changed

#854 - jflinter, kddnewton - Parentheses should not be stripped from optional RBS union types.
#888 - MaxNotarangelo, kddnewton - Ensure parentheses wrap conditionals that get transformed into the modifier form when they're used within a binary node.
#874 - yratanov, kddnewton - Ensure that method calls chained onto the ends of blocks still print their arguments.
#897 - Hansenq - Reenable the Layout/LineLength rubocop rule in our shipped config so that line lengths for other cops are calculated correctly.

1.5.5 - 2021-03-25

Changed

#841 - LoganBarnett, kddnewton - Better error messaging for when unix sockets are not supported by netcat.
#844 - andyw8, kddnewton - Ensure we ship all of the parsers with the prettier gem so that rbprettier can parse other languages as well.
#847 - jflinter, kddnewton - Ensure parentheses are present on union return types in RBS.
#850 - maethub, kddnewton - Ensure double quotes are used even when single quotes are requested for HAML attribute values.
#849 - indirect, kddnewton - Support HAML version <= 5.1 multi-line attributes.
#810 - valscion, kddnewton - Make it so that brace blocks containing heredocs have the correct end line so that they format subsequent statements correctly.

1.5.4 - 2021-03-17

Changed

#835 - valscion, kddnewton - Array splat operator should not get moved by leading comments.
#836 - valscion, kddnewton - Array splat operator should not get moved by trailing comments.
#821 - jscheid, kddnewton - Better error handling when using GNU netcat.

1.5.3 - 2021-02-28

Changed

#812 - valscion, kddnewton - Splats and blocks within args that have comments attached should place their respective operators in the right place.
#816 - valscion - Document RuboCop's Style/Lambda should be disabled
#814 - jscheid, kddnewton - Provide better errors when the source location of the error is known.

1.5.2 - 2021-02-03

Changed

kddnewton - Fix up binary node comparison operators so that it will handle either Symbol literals or the @op nodes which are incorrectly coming from JRuby (jruby/jruby#6548).

1.5.1 - 2021-01-27

Changed

#799 - jscheid, kddnewton - Multi-byte characters shouldn't give invalid source string bounds.
#801 - jscheid, kddnewton - When converting a conditional to the modifier form, make sure to add parentheses if there is a chained method call.
#803 - jscheid, kddnewton - Fix formatWithCursor support to match new parser format.

1.5.0 - 2021-01-21

Added

kddnewton - Add .rbi as a file type that we support.

Changed

#795 djrodgerspryor, kddnewton - Trailing comments attached to empty arrays should not multiply.
#794 djrodgerspryor, kddnewton - Fix embedded parser parsing by stripping common leading whitespace before passing on the content.
#793 djrodgerspryor, kddnewton - Do not include trailing commas on arguments within arg_paren nodes if they could not be parsed with them (command and command_call).
#788 clarkdave, kddnewton - Break child hashes within a multi-line hash regardless of whether or not they can fit on one line.
kddnewton - Stop using ; to separate empty class definitions, module definitions, and loops.

1.4.0 - 2021-01-15

Added

ianks, kddnewton - Use netcat to communicate to a parser server for better performance when formatting multiple files.

Changed

jeffcarbs, kddnewton - Long strings with interpolated expressions should only break if the contents in the original source is broken.
johannesluedke, kddnewton - Fix for rescues with inline comments.
johncsnyder, kddnewton - Comments should not attach to nodes beyond a double newline.
blampe, kddnewton - Comments inside of a broken method chain get dropped.
clarkdave, kddnewton - Don't ignore Sorbet sig transformations.

1.3.0 - 2021-01-05

Added

kddnewton - Handling of the RBS language.
kddnewton - Incorporate the HAML plugin.

1.2.5 - 2021-01-04

Changed

nruth, kddnewton - Ensure unary operators on method calls that are sending operators get the correct scanner events.
cvoege, kddnewton - Do not add parentheses when they're not needed to non-breaking command_calls with ternary arguments.
valscion, kddnewton - Print method chains more nicely off array and hash literals.

1.2.4 - 2021-01-03

Added

andyw8 - Explain usage with Rubocop, as well as shipping a rubocop.yml config.

Changed

kddnewton - Reduce JSON size passing from Ruby process to node process by changing char_start -> sc, char_end -> ec, start -> sl, end -> el.
kddnewton - Up the max buffer size between the Ruby and node processes to 15K.

1.2.3 - 2021-01-02

Changed

lukyth, kddnewton - Ensure if a ternary breaks into an if..else..end within a command_call node that parentheses are added.
AlanFoster, kddnewton - Ensure you consume the optional do keyword on while and until loops so that it doesn't confuse the parser.
AlanFoster, kddnewton - Ensure key-value pairs split on line when the key has a comment attached within a hash.
AlanFoster, kddnewton - Fix for for loops that have multiple index variables.
AlanFoster, kddnewton - Fix parsing very large files by reducing the size of the JSON output from the parser.
AlanFoster, kddnewton - Ensure you don't skip parentheses if you're returning a value with the not unary operator.

1.2.2 - 2021-01-01

Changed

nathan-beam - Gem does not work with CMD/Powershell.
blampe, kddnewton - Comments inside keyword parameters in method declarations are not printed.
blampe, kddnewton - command_call nodes with unary operators incorrectly parse their operator.
blampe, kddnewton - Returning multiple values where the first has parentheses was incorrectly removing the remaining values.
johncsnyder, kddnewton - Call chains whose left-most receiver is a no-indent expression should not indent their entire chain.

1.2.1 - 2020-12-27

Changed

kddnewton - Handle single-line method definitions with parameters.
kddnewton - Handle hash and array patterns nested within find patterns.
kddnewton - Handle rightward assignment.
kddnewton - Handle find patterns with named boundaries.
kddnewton - Handle rightward assignment in conditionals.

1.2.0 - 2020-12-26

Added

kddnewton - Support for the fndptn node for Ruby 3.0 pattern matching.
kddnewton - Support for Ruby 3.0+ single-line method definitions.

1.1.0 - 2020-12-20

Added

kddnewton - Now that the comments are all fixed up, we can support # prettier-ignore comments.

Changed

rindek, kddnewton - Do not remove parentheses when receiver looks like a constant.
rindek, kddnewton - Do not remove parentheses when using the special call syntax with no arguments.
ykpythemind - Do not change regexp bounds if the body has certain content.
karanmandal, kddnewton - Correctly print for loops.
rafbm, kddnewton - If there are method chains with arguments only at the end, we should group the method chain and the method args.

1.0.1 - 2020-12-12

Changed

steobrien, kddnewton - Ensure leading comments in empty array and hash literals do not duplicate.

1.0.0 - 2020-12-11

Changed

kddnewton - Do not unescape double quotes in a single quote string.
kddnewton - Only force braces on regexp for spaces and equals if it's inside a command or command_call.
kddnewton - Leave Sorbet type annotations in place.
kddnewton - Don't group hash contents, just allow them to break with their parent node.
kddnewton - Honor the UTF-8 lang passed in through ENV vars.

1.0.0-rc2 - 2020-12-10

Changed

kddnewton - Print hashes with consistent keys (e.g., if one key cannot be a hash label, use all hash rockets).
kddnewton - Respect using o or not using o for octal numbers.
kddnewton - Ensure when clauses with multiple predicates that can be split into multiple lines are split correctly.
kddnewton - Ensure hash literal is split correctly when only its contents would fit on one line.
kddnewton - Simplify toProc checks by not calling if the option is disabled.
johncsnyder, kddnewton - Add method_add_block to the potential like of method calls that can be chained.
kddnewton - Add the rubyArrayLiteral option for disabling automatically turning into array literals.

1.0.0-rc1 - 2020-12-09

Changed

kddnewton - Rename options to prep for v1.0 release.
- addTrailingCommas -> trailingComma, "es5" means true
- inlineConditionals and inlineLoops -> rubyModifier
- preferHashLabels -> rubyHashLabel
- preferSingleQuotes -> rubySingleQuote
- toProcTransform -> rubyToProc
andyw8, kddnewton - Fix for Ruby 2.5.1 dyna_symbols. Turns out they were previously incorrectly reported as xstring nodes.
andyw8, kddnewton - Fix for plain rescue nodes with only comments in the body.
andyw8, kddnewton - Move declaration-type comments up to the line in the original source, as in:

def foo # :nodoc:
  bar
end

The comment in the above example should stay in place.

janklimo - Respect special call syntax, e.g., a.(1, 2, 3) should remain the same.
kddnewton - Fix up a bug with ensure being used in a bodystmt and not a begin.
kddnewton - Fix up a bug with negative ranges, e.g., -4..-3.
kddnewton - Fix up a bug with operator aliases, e.g., alias << push.
kddnewton - Fix up a bug with calls and unary nodes, e.g., !!foo&.bar.
kddnewton - Fix up a bug with multiple rescue clauses and comments, e.g.,

begin
rescue Foo, Bar
  # comment
end

kddnewton - Handle string literals that start with %Q.
kddnewton - Handle question method methods in the predicate of an if with a comment in the body.
kddnewton - Fix bare break with comments immediately after.
kddnewton - Fix for heredocs with comments immediately after the declaration.
kddnewton - Fix for comments when you're defining a method whose name overlaps with a keyword.
kddnewton - Don't automatically indent inside interpolated expressions from within a heredoc.
kddnewton - Don't convert into string literal arrays if the elements have brackets.
kddnewton - Ensure you break the parent when there is an assignment in the predicate of a loop.
kddnewton - Fix up a bug with keyword aliases, e.g., alias in within.
kddnewton - Force using braces for regex if a regex starts with a blank space.
kddnewton - Force using braces for regex if a regex starts with an equals sign.
kddnewton - Fix up a bug with constant aliases, e.g., alias in IN.
andyw8, kddnewton - Ensure rescue comments stay on the same line as their declaration.

0.22.0 - 2020-12-08

Changed

flyerhzm - Print method chains by one indentation.
mmcnl, kddnewton - Handle heredocs and blocks being passed to the same method.
johncsnyder, kddnewton - Ensure correct formatting when breaking up conditionals with inlineConditionals: false.
Rsullivan00 - Ensure that when ternaries as command arguments get broken into multiple lines we add the necessary parentheses.
jbielick - Maintain parse order during if/unless modifier expressions
flyerhzm - Slight prettifying of wrapped args if doc length is under a certain value.
github0013, kddnewton - Ensure not keeps parentheses if they are being used.
jbielick - Print heredocs consistently.
kddnewton - Completely revamp the way we handle comments.
kddnewton - Support hshptn and the remaining missing pattern matching syntax.

0.21.0 - 2020-12-02

Changed

kddnewton, ryan-hunter-pc - Explicitly handle break and next keyword parentheses.
jbielick, kddnewton - Don't convert between lambda {} and -> {}. Technically it's breaking the semantics of the program. Also because lambda method call arguments can't handle everything that stabby lambda can.
kddnewton - Turn off the Symbol#to_proc transform by default.
janklimo, kddnewton - Properly handle trailing commas on hash arguments.
coiti, kddnewton - Properly handle parentheses when necessary on if/unless statements and while/until loops.
Rsullivan00 - Prevent command and command_call nodes from being turned into ternaries.
kddnewton - Better handling of the alias node with and without comments.
kddnewton - Better handling of the BEGIN and END nodes with and without comments.
kddnewton - Much better handling of heredocs where now there is a consistent heredoc node instead of multiple.

0.20.1 - 2020-09-04

Changed

ftes, kddnewton - Properly escape HAML plain text statements that start with special HAML characters.

Removed

kddnewton - I'm stripping out the HAML plugin and putting it into its own package (@prettier/plugin-haml). It's become too difficult to maintain within this repo, and it's confusing for contributors because there are some things that work with Ruby and some things that don't. This is going to simplify maintenance. This should probably be a major version bump but since we're still pre 1.0 I'm going to leave it as a patch.

0.20.0 - 2020-08-28

Added

kddnewton - Allow embedded formatting on heredocs by the name placed at the start. For example,

javascript = <<~JAVASCRIPT
  const a=1;
  const b=2;
  return a+b;
JAVASCRIPT

Changed

mmainz - Fix the encoding setting such that we're not overwriting the entire set of environment variables.

0.19.1 - 2020-08-21

Changed

Rsullivan00 - Do not tranform word-literal arrays when there is an escape sequence.
steobrien, kddnewton - Do not indent heredocs with calls more than they should be.
jpickwell - Include .simplecov in filenames
github0013, kddnewton - Ensure we're parsing ruby files using UTF-8 regardless of the system encoding.

0.19.0 - 2020-07-03

Added

ryan-hunter-pc - Add the option to disable the Symbol#to_proc transform.
ryan-hunter-pc], [@SViccari, kddnewton - Disable Symbol#to_proc transform when used as a key inside of a hash where the key is either :if or :unless.

0.18.2 - 2020-05-01

Changed

alse - Support vscodeLanguageIds for HAML.
ShayDavidson, kddnewton - Don't allow replacing if/else with ternary if there's an assignment in the predicate.
janklimo - Do not add an empty line after rescue when the block is empty.

0.18.1 - 2020-04-05

Changed

petevk, kddnewton - Use braces for block format iff it was originally a brace block, otherwise you could be changing precedence. For example:

expect do
  field 1 do
    "foo"
  end
end.to raise_error

should maintain its do...end and not switch to inline braces otherwise the brace might get associated with the 1.

flyerhzm - Rewrite operators binary parser, as in:

[
  '1111111111111111111111111111111111111111111111111111111111111111111111111',
  222
] +
  [1]

ftes, kddnewton - When old-form dynamic attributes are added to a div tag in HAML, it was previously skipping printing the %div, which led to it being incorrectly displayed.
ftes, kddnewton - Previously if you had a long tag declaration with attributes that made it hit the line limit, then the content of the tag would be pushed to the next line but indented one character too many.
ftes, kddnewton - Don't explicitly require JSON if it has already been loaded, as this can lead to rubygems activation errors.
mmainz, kddnewton - Handle heredocs as the receivers of call nodes, as in:

foo = <<~TEXT.strip
  bar
TEXT

github0013, kddnewton - Leave parentheses in place if the value of a return node contains a binary with low operator precedence, as in:

return (a or b) if c?

0.18.0 - 2020-03-17

Added

kddnewton - Support for the nokw_param node for specifying when methods should no accept keywords, as in:

def foo(**nil)
end

kddnewton - Support for the args_forward node for forwarding all types of arguments, as in:

def foo(...)
  bar(...)
end

Changed

ftes, kddnewton - Handled 3 or more classes on a node in HAML, as in:

%table.table.is-striped.is-hoverable

ftes, kddnewton - Better handling of indentation of if/elsif/else, unless/elsif/else, and case/when branches, as in:

.column.is-12
  - if true
    TRUE
  - else
    FALSE

tobyndockerill - Format numbers with underscores after 4 digits, as opposed to 3.
ianks - Improve performance by using --disable-gems.
flyerhzm - Calls are grouped such that after an end parenthesis the following call will not be indented, as in:

Config::Download.new(
  'prettier',
  filename: 'prettier.yml', url: 'https://raw.githubusercontent.com/...'
)
  .perform

will now be printed as:

Config::Download.new(
  "prettier",
  filename: "prettier.yml",
  url: "https://raw.githubusercontent.com/..."
).perform

pje, kddnewton - Method definition bodies (on defs nodes) should dedent if a helper method is called. As in:

private def self.foo
          'bar'
        end

should instead be indented as:

private def self.foo
  'bar'
end

masqita, kddnewton - Inline variable assignment within a predicate should force the conditional to break, as in:

array.each do |element|
  if index = difference.index(element)
    difference.delete_at(index)
  end
end

hafley66, kddnewton - Handle empty while and until blocks.
Fruetel, kddnewton - Simplify string escape pattern by locking on any escape sequence.
flyerhzm, kddnewton - Properly handle string quotes on symbols in hash keys.

0.17.0 - 2019-12-12

Added

matt-wratt - Better support for explicit return nodes with empty arrays or arrays with a single element.
jrdioko, kddnewton - Alignment of not_to is explicitly allowed to not indent to better support rspec.

Changed

gin0606 - The max buffer being passed into the Ruby process is now up to 10MB.

0.16.0 - 2019-11-14

Added

mmainz, kddnewton - Support for extra commas in multiple assignment, as it changes the meaning. For example,

a, = [1, 2, 3]

would previously get printed as a = [1, 2, 3], which changes the value of a from 1 to the value of the entire array.

kddnewton - Experimental support for the HAMtemplate language.

Changed

github0013, kddnewton - Support proper string escaping when the original string in the source is wrapped in %q|...|. For example, %q|\'| should get printed as "\'", where previously it was dropping the backslash.
jamescostian, kddnewton - Force ternary breaking when using the lower-precendence operators and and or. For example,

if x.nil?
  puts 'nil' and return
else
  x
end

the previous expression was being transformed into a ternary which was invalid ruby. Instead it now stays broken out into an if/else block.

localhostdotdev], [@joeyjoejoejr], [@eins78, kddnewton - Better support for embedded expressions inside heredocs. For example,

<<-HERE
  foo bar baz
  #{qux}
  foo bar baz
HERE

should remain formatted as it is. Whereas previously due to the way the lines were split, you would sometimes end up with it breaking after #{.

jamescostian, kddnewton - Fix up return node printing. When returning multiple values, you need to return an array literal as opposed to using parentheses.

0.15.1 - 2019-11-05

Changed

AlanFoster - Add bin/lex for viewing the tokenized result of Ripper on Ruby code.
jakeprime, kddnewton - When predicates from within an if, unless, while, or until loop break the line, they should be aligned together. For example,

if foooooo || barrrrrr
  baz
end

If the line was set to very short, the binary node should be aligned to 3 spaces from the left of the file (which aligns with the if, it would be more for unless). So it would look like:

if foooooo ||
     barrrrrr
  baz
end

jamescostian], [@AlanFoster - Empty if, and unless conditionals are now handled gracefully:

if foo?
end

mmainz, kddnewton - Hash keys are not converted to keyword syntax if they would make invalid symbols. For example,

{ :[] => nil }

cannot be translated into []: as that is an invalid symbol. Instead, it stays with the hash rocket syntax.

cldevs, kddnewton - Do not attempt to format the insides of xstring literals (string that get sent to the command line surrounded by backticks or %x).
cldevs, kddnewton - When predicates for if, unless, while, or until nodes contain an assignment, we can't know for sure that it doesn't modify the body. In this case we need to always break and form a multi-line block.
MarcManiez, kddnewton - When the return value of if, unless, while, or until nodes are assigned to anything other than a local variable, we need to wrap them in parentheses if we're changing to the modifier form. This is because the following expressions have different semantic meaning:

hash[:key] = break :value while false
hash[:key] = while false do break :value end

The first one will not result in an empty hash, whereas the second one will result in { key: nil }. In this case what we need to do for the first expression to align is wrap it in parens, as in:

hash[:key] = (break :value while false)

That will guarantee that the expressions are equivalent.

AlanFoster - Fix crashes that were happening with ignored_nl nodes.

0.15.0 - 2019-08-06

Changed

dudeofawesome, kddnewton - If xstring literals (command line calls surrounded by backticks) break, then we indent and place the command on a new line. Previously, this was resulting in new lines getting added each time the code was formatted. Now this happens correctly.
krachtstefan, kddnewton - When a while or until loop modifies a begin...end statement, it must remain in the modifier form or else it changes sematic meaning. For example,

begin
  foo
end while bar

cannot be transformed into:

while bar
  foo
end

because that would never execute foo if bar is falsy, whereas in the initial example it would have.

jviney], kddnewton - When transforming a block into the Symbol#to_proc syntax from within a list of arguments inside of an aref node (i.e., foo[:bar.each), we can't put the block syntax inside the brackets.
jakeprime, kddnewton - Values for the return keyword that broke the line were previously just printed as they were, which breaks if you have a block expression like an if or while. For example,

return foo ? bar : baz

if the line was set to very short would be printed as:

return if foo
  bar
else
  baz
end

which wouldn't work. Instead, they now get printed with parentheses around the value, as in:

return(
  if foo
    bar
  else
    baz
  end
)

jakeprime, kddnewton - When switching from a double-quoted string to a single-quoted string that contained escaped double quotes, the backslashes would stay in the string. As in:

"Foo \"Bar\" Baz"

would get formatted as:

'Foo \"Bar\" Baz'

but now gets formatted as:

'Foo "Bar" Baz'

0.14.0 - 2019-07-17

Added

kddnewton - Support for pattern matching for variables and array patterns. Currently waiting on Ripper support for hash patterns. For examples, check out the test/js/patterns.test.js file.

Changed

jviney, kddnewton - if/else blocks that had method calls on the end of them that were also transformed into ternaries need to have parens added to them. For example,

if foo
  1
else
  2
end.to_s

now correctly gets transformed into:

(foo ? 1 : 2).to_s

acrewdson, kddnewton - Fixed a bug where multiple newlines at the end of the file would cause a crash.
jviney, kddnewton - If a variable is assigned inside of the predicate of a conditional, then we can't change it into the single-line version as this breaks. For example,

if foo = 1
  foo
end

must stay the same.

0.13.0 - 2019-07-05

Added

kddnewton - Added locStart and locEnd functions to support --cursor-offset.

Changed

xipgroc, kddnewton - Comments inside of do...end blocks that preceeded call nodes were associating the comment with the var_ref instead of the call itself. For example,

foo.each do |bar|
  # comment
  bar.baz
  bar.baz
end

would get printed as

foo.each do |bar|
  # comment
  bar
    .baz
  bar.baz
end

but now gets printed correctly.

petevk, kddnewton - Double splats inside a hash were previously failing to print. For example,

{ foo: "bar", **baz }

would fail to print, but now works.

0.12.3 - 2019-05-16

Changed

kddnewton - Move arg, assign, constant, flow, massign, operator, scope, and statement nodes into their own files.
kddnewton - Move @int, access_ctrl, assocsplat, block_var, else, number_arg, super, undef, var_ref, and var_ref as well as various call and symbol nodes into appropriate files.
kddnewton - Better support for excessed commas in block args. Previously proc { |x,| } would add an extra space, but now it does not.
kddnewton - Add a lot more documentation to the parser.
glejeune, kddnewton - Previously, the unary not operator inside a ternary (e.g., a ? not(b) : c) would break because it wouldn't add parentheses, but now it adds them.
kddnewton - if and unless nodes used to not be able to handle if a comment was the only statement in the body. For example,

if foo
  # comment
end

would get printed as

# comment if foo

Now the if and unless printers check for the presence of single comments.

JoshuaKGoldberg, kddnewton - Fixes an error where command nodes within def nodes would fail to format if it was only a single block argument. For example,

def curry(&block)
  new &block
end

would fail, but now works.

xipgroc, kddnewton - Comments on lines with array references were previously deleting the array references entirely. For example,

array[index] # comment

would previously result in array[], but now prints properly.

0.12.2 - 2019-04-30

Changed

kddnewton - When symbol literal hash keys end with =, they cannot be transformed into hash labels.
xipgroc, kddnewton - Fixed when blocks on methods with no arguments are transformed into to_proc syntax.

0.12.1 - 2019-04-22

Changed

kddnewton - If a lambda literal is nested under a command or command_call node anywhere in the heirarchy, then it needs to use the higher-precedence { ... } braces as opposed to the do ... end delimiters.
jpickwell, kddnewton - Calling super with a block and no args was causing the parser to fail when attempting to inspect lambda nodes.
kddnewton - Support better breaking within interpolation by grouping the interpolated content.

0.12.0 - 2019-04-18

Added

kddnewton - Automatically convert lambda { ... } method calls into -> { ... } literals.

0.11.0 - 2019-04-18

Added

kddnewton - Support for parsing things with a ruby shebang (e.g., #!/usr/bin/env ruby or #!/usr/bin/ruby).
kddnewton - Big tests refactor.
kddnewton - Make multiple when predicates break at 80 chars and then wrap to be inline with the other predicates.
kddnewton - Automatically add underscores in large numbers that aren't already formatted.
AlanFoster - Better support for inline access control modifiers.
jpickwell, kddnewton - Better support for heredocs in hash literals.
kddnewton - Better support for heredocs in array literals.
kddnewton - Support automatically transforming def/begin/rescue/end/end into def/rescue/end.

Changed

deecewan - Fixed support for dynamic string hash keys.
kddnewton - Moved case/when into its own file and added better documentation.
kddnewton - Moved begin/rescue into its own file.
AlanFoster - Automatically add newlines around access modifiers.
kddnewton - Alignment of command calls with arguments is fixed.
aaronjensen, kddnewton - Alignment of to is explicitly allowed to not indent to better support rspec.
kddnewton - Fix up the to_proc transform so that it works with other argument handling appropriately.
kddnewton - Fixed regression on regexp comments.
CodingItWrong, kddnewton - Fix up block delimiters when nested inside a command or command_call node.
kddnewton - Moved hashes into its own file.

0.10.0 - 2019-03-25

Added

kddnewton - Support for block-local variables.
kddnewton - Support for dyna-symbols that are using single quotes.

Changed

kddnewton - Force method calls after arrays, blocks, hashes, and xstrings to hang onto the end of the previous nodes.
kddnewton - Check before anything else for an invalid ruby version.

0.9.1 - 2019-03-24

Changed

kddnewton - Better support string quotes by favoring what the user chose if the string contains escape patterns.
kddnewton - Better support heredocs within method calls.

0.9.0 - 2019-03-18

Added

kddnewton - Support the hasPragma function.
kddnewton - Support the new number_arg node type in Ruby 2.7.

Changed

kddnewton - Limit the number of nodes that are allowed to turn into ternary expressions.

0.8.0 - 2019-03-08

Added

kddnewton - Add eslint and fix up existing violations.
AlanFoster - Add the infra for the prettier ruby gem.
kddnewton - Add a rake task for easier process integration for the ruby gem.
kddnewton - Handle direct interpolation of strings with %w array literals (i.e., ["#{foo}"] should not be transformed into a %w array).

Changed

kddnewton - Fix string escaping for hex digit bit patterns when there's only one character after the "x".
AlanFoster - Don't allow line breaks between brace block params.
johnschoeman - Switch over the array.rb test case to minitest.
AlanFoster - Test improvements to allow running in parallel.
johnschoeman - Switch over assign.rb test case to minitest.
AlanFoster - Add a contributing guide.
AlanFoster - Handle longer command nodes.
kddnewton - Changed the ruby executable within the prettier gem to rbprettier for easier autocomplete.

Removed

kddnewton - All instances of the spread (...) operator so that we can support older versions of node.

0.7.0 - 2019-02-24

Changed

kddnewton - Support checking for escaping within strings to force double quotes (e.g., "\n").
RossKinsella, kddnewton - Handle cases with empty class and module declarations that need to break.
AlanFoster - Align the bin/print and bin/sexp APto support bin/print taking a filepath.
AndrewRayCode, kddnewton - Support lambdas that don't break and are inline.
AlanFoster - Switch over the numbers.rb test to minitest.
AlanFoster - Switch over the kwargs.rb test to minitest.
AlanFoster - Bail out early if the Ruby input is invalid.
kddnewton - Support __END__ content.
AlanFoster - Fix up issue with whitespace being added within regexp that are multiline.
AlanFoster - Better support for destructuring within multi assignment.
kddnewton - Switch next test over to minitest.
kddnewton - Handle multiple arguments to next with a space between.
AndrewRayCode, kddnewton - Handle multi-line conditional predicate (should align with keyword).
aaronjensen, kddnewton - Properly support adding trailing commas with and without blocks.
AlanFoster, kddnewton - Fix regression of handling comments within arrays on array literals.
AlanFoster - Support multiple arguments to undef.

0.6.3 - 2019-02-18

Changed

kddnewton - Switch over binary fixture to minitest.
kddnewton - Reconfigure parser into multiple layer modules so that it's easier to understand and manage.
kddnewton - Handle comments from within begin, rescue, ensure, while, and until nodes.
kddnewton - Properly indent heredocs without taking into account current indentation level.

0.6.2 - 2019-02-17

Changed

AlanFoster - Handle regexp suffixes.
kddnewton - Add support for testing the test fixtures with minitest.
kddnewton - Switch over alias and regexp tests to minitest.
aaronjensen, kddnewton - Break up method args to split into multiple lines.
christoomey, kddnewton - Handle blocks args when trailing commas are on.

0.6.1 - 2019-02-15

Changed

meleyal, kddnewton - Fix Ruby 2.5 inline comments on args_add_block nodes.
meleyal, kddnewton - Support passing super() explicitly with no arguments.

0.6.0 - 2019-02-14

Added

kddnewton - Handle non UTF-8 comments.
kddnewton - Handle non UTF-8 identifiers.
kddnewton - Handle non UTF-8 strings.
kddnewton - Handle empty parens.
kddnewton - Handle rescue with splats preceeding the exception names.

Changed

kddnewton - Use JSON::fast_generate to get the s-expressions back from the parser.
NoahTheDuke, kddnewton - Handle broken lambdas from within command and command_call nodes.

0.5.2 - 2019-02-13

Changed

kddnewton - Support embedded expressions within strings that contain only keywords, as in "#{super}".

0.5.1 - 2019-02-13

Changed

yuki24, kddnewton - Force do blocks that we know have to be do blocks to break.
kmcq, kddnewton - Handle command and command_call nodes do blocks by forcing them to break.
ashfurrow, kddnewton - Attach comments to full hash association nodes, not just the value.

0.5.0 - 2019-02-13

Added

kddnewton - Automatically convert arrays of all string literals to %w arrays.
kddnewton - Automatically convert arrays of all symbol literals to %i arrays.

Changed

kddnewton - Move the args_add and args_new handling into the parser.
uri, kddnewton - Change command_call nodes to properly indent when broken and to not add a trailing comma.
kddnewton - Rename the trailingComma option to addTrailingCommas to not conflict with the JS option.

0.4.1 - 2019-02-12

Changed

kddnewton - Provide the makeList utility for the nodes that are lists from within ripper.
awinograd, kddnewton - Again, this time for real, properly escape strings.
kddnewton - Fix up trailing commas on command calls.

0.4.0 - 2019-02-12

Added

Overload119, kddnewton - Support the trailingComma configuration option (defaults to false).

Changed

NoahTheDuke, kddnewton - Pass the code to be formatted over stdin.

0.3.7 - 2019-02-11

Changed

kddnewton - Split up statements even if they started on the same line with ;s unless they are within an embedded expression.
kddnewton - Properly handle escaped quotes within strings.

0.3.6 - 2019-02-10

Changed

AlanFoster, kddnewton - Support the not operator properly.
AlanFoster, kddnewton - Handle comments properly inside if, unless, and when nodes.

0.3.5 - 2019-02-09

Changed

kddnewton - Handle lonely operators in Ruby 2.5.

0.3.4 - 2019-02-09

Changed

kddnewton - Comments are now properly attached inside defs nodes.
kddnewton - Support multiple inline comments on nodes.
kddnewton - Support inline comments from within the EXPR_END|EXPR_LABEL lexer state.
cbothner - Stop transforming multistatement blocks with to_proc.
kddnewton - do blocks necessarily need to break their parent nodes.
eins78, kddnewton - Handle next node edge case with args_add as the body.

0.3.3 - 2019-02-09

Changed

bugthing, kddnewton - Command nodes within conditionals now break parents to disallow them from being turned into ternary expressions.
awinograd, kddnewton - Properly escape double quotes when using preferSingleQuotes: false.

0.3.2 - 2019-02-09

Changed

kddnewton - Don't define duplicated methods in the parser.
kddnewton - Let prettier know about .rb and .rake files so you don't have to specify the parser when running.
kddnewton - Renamed the package to @prettier/plugin-ruby.

0.3.1 - 2019-02-07

Changed

kddnewton - Automatically add parens to method declarations.
kddnewton - Handle comments on bare hash assocs.
kddnewton - Handle method_add_block nodes where the statements may be nested one more level.
kddnewton - Handle heredocs nested no matter how many levels deep.

0.3.0 - 2019-02-07

Added

kddnewton - Support squiggly heredocs.
kddnewton - Support straight heredocs.

Changed

kddnewton - Ignore current indentation when creating embdocs so that =begin is always at the beginning of the line.
kddnewton - Move regexp_add and regexp_new handling into the parser.
kddnewton - Move xstring_add and xstring_new handling into the parser.
kddnewton - Move string_add and string_content handling into the parser.
kddnewton - Move mrhs_add and mrhs_new handling into the parser.
kddnewton - Move mlhs_add and mlhs_new handling into the parser.

0.2.1 - 2019-02-06

Changed

kddnewton - Handle brace blocks on commands properly.
kddnewton - Break parent and return do blocks when called from a command node.
kddnewton - Handle edge cases with if statements where there is no body of the if (so it can't be converted to a ternary).

0.2.0 - 2019-02-06

Added

kddnewton - Handle methref nodes from Ruby 2.7.
kddnewton - Allow module nodes to shorten using ; when the block is empty.

Changed

kddnewton - Handle splat within an array, as in [1, 2, *foo].
kddnewton - Disallow comments from being attached to intermediary regex nodes.
kddnewton - Fix to_proc transforms to reference the method called as opposed to the parameter name.
kddnewton - Change statement lists to be generated within the parser instead of the printer, thereby allowing finer control over comments.
kddnewton - Completely revamp comment parsing by switching off the internal lexer state from ripper. This should drastically increase accuracy of comment parsing in general, and set us up for success in the future.
kddnewton - Allow comments to be attached to CHAR nodes.
kddnewton - Disallow comments from being attached to args_new nodes.
kddnewton - Track start and end lines so we can better insert block comments.
kddnewton - Handle intermediary array nodes in the parse for better comment handling.

0.1.2 - 2019-02-05

Changed

kddnewton - Handle guard clauses that return with no parens.

0.1.1 - 2019-02-05

Changed

kddnewton - Handle class method calls with the :: operator.
kddnewton - Handle strings with apostrophes when using preferSingleQuote.
kddnewton - Have travis run multiple ruby versions.
kddnewton - Explicitly fail if ruby version is < 2.5.
kddnewton - Disallow comments from being attached to intermediary string nodes.

0.1.0 - 2019-02-04

Added

Initial release 🎉

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

Unreleased

4.0.4 - 2023-12-12

Changed

4.0.3 - 2023-11-27

Changed

4.0.2 - 2023-07-14

Changed

4.0.1 - 2023-07-08

Changed

4.0.0 - 2023-07-06

Added

Changed

3.2.2 - 2022-09-20

Changed

3.2.1 - 2022-09-19

Changed

3.2.0 - 2022-07-22

Added

Changed

3.1.2 - 2022-05-13

Changed

3.1.1 - 2022-05-12

Changed

3.1.0 - 2022-05-12

Added

3.0.0 - 2022-05-04

Added

Changed

Removed

2.1.0 - 2022-04-04

Added

Changed

Removed

2.0.0 - 2021-10-28

Changed

2.0.0-rc4 - 2021-10-18

Added

Changed

2.0.0-rc3 - 2021-10-01

Changed

2.0.0-rc2 - 2021-09-30

Added

Changed

2.0.0-rc1 - 2021-09-30

Added

Changed

Removed

1.6.1 - 2021-06-30

Changed

1.6.0 - 2021-06-23

Added

Changed

1.5.5 - 2021-03-25

Changed

1.5.4 - 2021-03-17

Changed

1.5.3 - 2021-02-28

Changed

1.5.2 - 2021-02-03

Changed

1.5.1 - 2021-01-27

Changed

1.5.0 - 2021-01-21

Added

Changed

1.4.0 - 2021-01-15

Added

Changed

1.3.0 - 2021-01-05

Added

1.2.5 - 2021-01-04

Changed

1.2.4 - 2021-01-03