From 3fdf0a33b06151995b1be7b76db36b6b31d0d852 Mon Sep 17 00:00:00 2001 From: Earlopain <14981592+Earlopain@users.noreply.github.com> Date: Fri, 14 Mar 2025 08:40:22 +0100 Subject: [PATCH] Document the current state of the project in the readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7528523c5..c2f06d994 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,11 @@ equivalent source code from Parser's ASTs. Sponsored by [Evil Martians](http://evilmartians.com). MacRuby and RubyMotion support sponsored by [CodeClimate](http://codeclimate.com). +> [!WARNING] +> The `parser` gem is only compatible with the syntax of Ruby 3.3 and lower. For Ruby 3.4 and later, please use the [`Prism::Translation::Parser`](https://github.com/ruby/prism/blob/main/docs/parser_translation.md) instead. +> Starting in Ruby 3.4, Prism is the parser used in Ruby itself and can produce AST that is identical to the output of the `parser` gem. If you only need to parse Ruby 3.3 (or greater) and don't require compatibility with the `parser` gem AST, also consider using the native Prism AST. +> See this [GitHub issue](https://github.com/whitequark/parser/issues/1046) for more details. + ## Installation $ gem install parser