jruby-prism-parser 0.24.0-java → 1.4.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b82c0b2353ff110c8e7658a168f76c1a5c3b8fee6ee4d0a5bd8fab2d9641aa2
-  data.tar.gz: bbee6337a99636cf0a96bffa752f1534c4f4eb7baf07e349f597817e6a4eaf33
+  metadata.gz: c4143efc7a4fbdbcaddb7220dcd86685476c6c585b85679f7eb83ead2b10dd44
+  data.tar.gz: 1e437320584d92b228bfee57490b0946ccd69b44e1dbc12609b722de16bcfa29
 SHA512:
-  metadata.gz: 1706d4053f73739e5d6ebd413b94d16065a9b20132a1aeca50104543f05b802f2658111564bde5969621e07453bdb7bc7c9f38de4150df3351905fc23f2ab5a9
-  data.tar.gz: 78d26fb025d9f3480e9daffeea8e26860743db628640bbbc39c8a78bb78394e11cf26357a377a9d2b950f43a1205dfa8d83fe569a2724bb84e24a32a97954b65
+  metadata.gz: bfb3232c63c08d7283ca928654c615a8d4c41d553dd322d63272ffd8f8bd707f017862c94b06a2bd2a807d6a9552f9014209ed811a48ad8117b6da7822f8f4e3
+  data.tar.gz: 2f361f6732c10b3b7519732891c789f1d80434afdc635794b9b9ee2e6d63708cb07f03c727ec4d4566fdc94ae00b62d5a890e5189cefa86027e68e3c015d8719

data/BSDmakefile

@@ -0,0 +1,58 @@
+# GNU makefile proxy script for BSD make
+#
+# Written and maintained by Mahmoud Al-Qudsi <mqudsi@neosmart.net>
+# Copyright NeoSmart Technologies <https://neosmart.net/> 2014-2019
+# Obtain updates from <https://github.com/neosmart/gmake-proxy>
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+JARG =
+GMAKE = "gmake"
+# When gmake is called from another make instance, -w is automatically added
+# which causes extraneous messages about directory changes to be emitted.
+# Running with --no-print-directory silences these messages.
+GARGS = "--no-print-directory"
+
+.if "$(.MAKE.JOBS)" != ""
+    JARG = -j$(.MAKE.JOBS)
+.endif
+
+# bmake prefers out-of-source builds and tries to cd into ./obj (among others)
+# where possible. GNU Make doesn't, so override that value.
+.OBJDIR: ./
+
+# The GNU convention is to use the lowercased `prefix` variable/macro to
+# specify the installation directory. Humor them.
+GPREFIX = ""
+.if defined(PREFIX) && ! defined(prefix)
+    GPREFIX = 'prefix = "$(PREFIX)"'
+.endif
+
+.BEGIN: .SILENT
+	which $(GMAKE) || printf "Error: GNU Make is required!\n\n" 1>&2 && false
+
+.PHONY: FRC
+$(.TARGETS): FRC
+	$(GMAKE) $(GPREFIX) $(GARGS) $(.TARGETS:S,.DONE,,) $(JARG)
+
+.DONE .DEFAULT: .SILENT
+	$(GMAKE) $(GPREFIX) $(GARGS) $(.TARGETS:S,.DONE,,) $(JARG)

data/CHANGELOG.md

@@ -6,6 +6,263 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.4.0] - 2025-03-18
+
+### Added
+
+- Support `3.5` as a version option.
+- Many, many compatibility fixes for the parser translation layer.
+- Handle escapes in named capture names.
+- The `freeze` option is added to the various `Prism::` APIs to deeply freeze the AST.
+- Properly support `it` for the parser and ruby_parser translation layers.
+- Track the `then` keyword on `rescue` nodes.
+- Add a `multiple_statements?` flag to parentheses nodes to support desired `defined?` behavior.
+
+### Changed
+
+- The strings used in the AST are now frozen.
+- Fixed handling escaped characters after control sequences in character literals.
+- Fix reading off the end of an unterminated global variable.
+- Raise a syntax error for defining `[]=` with endless method syntax.
+- Increase value of `PRISM_DEPTH_MAXIMUM` to `10000`.
+- Freeze `Prism::VERSION`.
+- Fix up rescue modifier precedence.
+
+## [1.3.0] - 2024-12-21
+
+### Added
+
+- Introduce `Prism::StringQuery`.
+- Introduce `Prism::Relocation`.
+- Track `do` keyword for `WhileNode` and `UntilNode`.
+- Change the way the gem is built to rely on `mkmf` instead of `make`.
+- Lots more documentation on node fields.
+
+### Changed
+
+- Properly add an error for `def @foo; end`.
+- Properly add an error for `foo(**, *)`.
+- Fix up regression in string parsing in `RubyParser` translation.
+- Reject invalid dot method call after match expression.
+- Reject invalid operator after match expression.
+- Fix up %-literals delimited by newlines.
+- Properly add an error for `-> { _1; -> { _1 } }`.
+- Reject blocks and keywords in index writes.
+
+## [1.2.0] - 2024-10-10
+
+### Added
+
+- Introduce `Prism::CodeUnitsCache`.
+
+### Changed
+
+- Properly handle lexing global variables that begin with `$-`.
+- Properly reject invalid multi writes within parentheses.
+- Fix unary `*` binding power.
+- Set `contains_keywords` flag for implicit `gets` calls when `-p` is used.
+- Properly reject invalid non-associative operator patterns.
+- Do not warn about unused variables declared on negative lines.
+
+## [1.1.0] - 2024-10-02
+
+### Added
+
+- Explicitly type each child node field in the Ruby API.
+- Add the `main_script` option to the parse APIs, which controls whether or not shebangs are considered.
+- Add the `partial_script` options to the parse APIs, which controls whether or not jumps that would otherwise be considered invalid are allowed. This is useful for parsing things like ERB sources, where you know it will be evaluated in a different context. Note that this functionality is replacing the previous idiom of passing in a list of scopes to indicate an `eval` context, because that behavior has changed upstream in `ruby/ruby`.
+- Add `ArgumentsNode#contains_multiple_splats?`.
+- Add `ArgumentsNode#contains_forwarding?`.
+- Accept all valid Ruby versions for the `version` option on parse APIs.
+- Accept version shorthands like `"3.3"` and `"3.4"` for the `version` option on parse APIs.
+- Support a max depth to protect against malicious payloads without hitting the stack limit.
+
+### Changed
+
+- Fix some token incompatibilities in the `parser` translation.
+- Fix up parsing tempfiles on Windows.
+- Fix up handling UTF-8 characters in file paths on Windows.
+- Do not warn for a `\r` at the end of a shebang on Windows.
+- Properly handle erroring for parsing a directory on Windows.
+- When a numbered reference is out of range, warn instead of raise.
+- Allow returns in default parameter values.
+- Reject many more invalid syntax patterns.
+
+## [1.0.0] - 2024-08-28
+
+### Added
+
+- Add `Node#breadth_first_search`.
+- Add `Node#node_id`.
+- Add `ArgumentsNode#contains_splat?`.
+- Passing the special value `false` for the `encoding` option tells Prism to ignore magic encoding comments.
+- Expose flags on every node type (allows checking static literal and newline).
+- Implement mismatched indentation warning.
+- Add C API for receiving a callback when parsing shebangs with additional flags.
+
+### Changed
+
+- **BREAKING**: Some fields are renamed that had illogical names. The previous names all now emit deprecation warnings.
+  - `CaseMatchNode#consequent` was renamed to `CaseMatchNode#else_clause`
+  - `CaseNode#consequent` was renamed to `CaseNode#else_clause`
+  - `IfNode#consequent` was renamed to `IfNode#subsequent`
+  - `RescueNode#consequent` was renamed to `RescueNode#subsequent`
+  - `UnlessNode#consequent` was renamed to `UnlessNode#else_clause`
+- Block exits are now allowed in loop predicates (e.g., `while _ && break do end`).
+- Multi-writes are now disallowed when not at the statement level.
+- Ensure that range operators are non-associative.
+- (JavaScript) Correctly deserialize encoded strings.
+- Properly support parsing regular expressions in extended mode.
+- Use gmake on FreeBSD.
+- Parsing streams now handles NUL bytes in the middle of the stream.
+- Properly detect invalid returns.
+
+## [0.30.0] - 2024-06-07
+
+### Added
+
+- More correctly raise mixed encoding errors.
+- Implement ambiguous binary operator warning.
+- Fix up regexp escapes with control and meta characters.
+- Fix up support for the `it` implicit local variable.
+- Heredoc identifiers now properly disallow CLRF.
+- Errors added for void value expressions in begin clauses.
+- Many updates to more closely match the `parser` gem in parser translation.
+- Many errors added for invalid regular expressions.
+
+### Changed
+
+- Handle parser translation missing the `parser` gem.
+- Handle ruby_parser translation missing the `ruby_parser` gem.
+- Various error messages have been updated to more closely match CRuby.
+- `RationalNode` now has a `numerator` and `denominator` field instead of a `numeric` field. For the Ruby API we provide a `RationalNode#numeric` method for backwards-compatibility.
+
+## [0.29.0] - 2024-05-10
+
+### Added
+
+- Added `Prism::CallNode#full_message_loc`, which gives the location including the `=` if there is one.
+- A warning for when `# shareable_constant_value` is not used on its own line.
+- An error for invalid implicit local variable writes.
+- Implicit hash patterns in array patterns are disallowed.
+- We now validate that Unicode escape sequences are not surrogates.
+
+### Changed
+
+- All fields named `operator` have been renamed to `binary_operator` for `*OperatorWriteNode` nodes. This is to make it easier to provide C++ support. In the Ruby API, the old fields are aliased to the new fields with a deprecation warning.
+- Many updated error messages to more closely match CRuby.
+- We ensure keyword parameters do not end in `!` or `?`.
+- Fixed some escaping in string literals with control sequences and hex escapes.
+- Fix a bug with RBS types when used outside the `ruby/prism` codebase.
+
+## [0.28.0] - 2024-05-03
+
+### Added
+
+- Nested hashes will now warn for duplicated keys, as in: `{ foo: 1, **{ foo: 2 } }`.
+- `Prism::ReturnNode` now has a flag on it to indicate if it is redundant.
+- `Prism::Location#slice_lines` and `Prism::Node#slice_lines` are now provided to slice the source code of a node including the content before the node on the same line that it starts on and the content after the node on the same line that it ends on.
+- Symbols with invalid byte sequences now give errors.
+- You can now pass `"3.3.1"` to the `version:` parameter on all `Prism.*` APIs.
+- `Prism::Source#lines`, `Prism::Location#source_lines`, `Prism::Node#source_lines`, and `Prism::Node#script_lines` are now provided, which will all return the source code of the source as an array of strings.
+- `Prism::ASCIISource` is now provided, which is a subclass of `Prism::Source` but specialized to increase performance when the source is entirely ASCII.
+- Prism now provides errors when parsing Ruby 3.4+ syntax for index expressions with keywords or blocks.
+- Prism now provides an error when `**nil` is used after other keyword parameters.
+- Prism now provides errors when safe navigation is used in call target expressions, e.g., `foo&.bar, = 1`.
+- `Prism::Node#tunnel` is now provided, which returns an array of nodes starting at the current node that contain a given line and column.
+
+### Changed
+
+- All translation layers now assume an eval context, which means they will not return errors for invalid jumps like `yield`.
+- `Prism::Node#inspect` now uses a queue instead of recursion to avoid stack overflows.
+- Prism now more closely mirrors CRuby interpolation semantics, which means you could potentially have a static literal string that directly interpolates another static literal string.
+- The shipped RBI sorbet types no longer use generics.
+- `Prism::ConstantPathNode#child` and `Prism::ConstantTargetNode#child` are now deprecated, replaced by two new fields on these nodes: `name` and `name_loc`.
+
+## [0.27.0] - 2024-04-23
+
+### Added
+
+- Implemented `===` for each of the nodes, which will check if equality but ignore the specific ranges of locations.
+
+### Changed
+
+- Fix translation of `ItParametersNode` for parser translation.
+- Fix translation of `dstr` for ruby_parser translation.
+- Do not allow omitted hash values whose keys end with `!` or `?`.
+- Split up `Prism::ParseResult` into `Prism::Result` with subclasses `Prism::ParseResult`, `Prism::LexResult`, `Prism::ParseLexResult`, and `Prism::LexCompat::Result`.
+- Change reflection classes to have only a single `IntegerField` class and rename `DoubleField` to `FloatField`.
+- Fall back to default `AR` and `CC` in `Makefile`.
+- Use GC-able symbols for the syntax tree to avoid adding to the global symbol table.
+- Fix a bug with karatsuba_multiply that would result in a stack overflow.
+- Fix parser translation when looking for tokens with `srange_find`.
+
+## [0.26.0] - 2024-04-18
+
+### Added
+
+- Add `Prism::Node::fields`, which returns a list of `Prism::Reflection::Field` objects representing the fields of the node class. This is useful in metaprogramming contexts.
+- `Prism::Location#chop`, for removing the last byte from a location.
+- The void statement warning is now implemented.
+- The unreachable statement warning is now implemented.
+- A syntax error has been added for block arguments on yields, e.g., `yield(&foo)`.
+
+### Changed
+
+- Better fidelity to `parser` when translating heredocs with interpolation.
+- Fixed `RBI` and `RBS` types for `Prism::parse_*` signatures.
+- Remove some incorrect warnings about unused local variables.
+- More closely match CRuby error messages for global variables.
+- Fix an issue with `parser` translation when line continuations are found in string literals.
+
+## [0.25.0] - 2024-04-05
+
+### Added
+
+- `Prism::Translation::Ripper` is now able to mirror all of the Ripper APIs.
+- `Prism::Location#leading_comments` and `Prism::Location#trailing_comments` is added.
+- `Prism::Comment#slice` is added.
+- Warn for writing literal values in conditional predicates.
+- Check for `_POSIX_MAPPED_FILES` before using `mmap`.
+- `Prism::ItParametersNode` is added, to support `-> { it }`.
+- Parse integer and float literal values onto the tree.
+- Warn on duplicated hash keys and duplicated when clauses.
+- Ship much improved `RBI` and `RBS` types.
+- Support for the `-p`, `-n`, `-a`, and `-l` command line switches.
+- Warn on integer literals in flip-flops.
+- Support BSD make.
+- Add `Prism::WhenNode#then_keyword_loc`.
+- Support custom allocation functions through the `PRISM_XALLOCATOR` define.
+- Warn for certain keywrods at the end of the line.
+- Provide `pm_visit_node`, a C visitor API.
+- `Prism::parse_stream` is added, which works for any Ruby `IO` object.
+- Provide flags for regular expression literals for their derived encoding.
+- Provide flags for whether or not an interpolated string literal is frozen.
+- Add `Prism::StringNode.mutable?` for when a string is explicitly mutable, to support delineating chilled strings.
+- Warn for incorrect character literal syntax.
+- Warn for chained comparison operators.
+- Warn for `**` interpreted as an argument prefix.
+- Warn for `&` interpreted as an argument prefix.
+- `Prism::ShareableConstantNode` added to support ractors.
+- Warn for frozen string literals found after tokens.
+- Support `PRISM_BUILD_MINIMAL` to provide only the minimal necessary functionality to reduce the binary size.
+- Handle CLRF inside heredocs, strings, and regular expressions.
+- Mark inner strings in interpolated strings as frozen.
+- Support the `-x` command line switch.
+- Error messages now much more closely mirror CRuby.
+- Provide syntax errors for invalid block exits (`break`, `next`, `retry`, and `yield`).
+- Warn on unused local variables.
+- Do not syntax error on default parameter values that only write to the parameter.
+
+### Changed
+
+- Many improvements to the compatibility with the `whitequark/parser` translation.
+- Accept newlines before pattern terminators `)` or `]`.
+- `Prism::Node#start_offset` and `Prism::Node#end_offset` are now much more efficient.
+- Read files using `fread` instead of `mmap` when we're going to keep around the source through the Ruby API.
+- Fix `Sexp#line_max` setting in the `seattlerb/ruby_parser` translation layer.
+- Allow spaces before the encoding comment.
+
 ## [0.24.0] - 2024-02-15
 
 ### Added
@@ -392,7 +649,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby/prism/compare/v0.24.0...HEAD
+[unreleased]: https://github.com/ruby/prism/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/ruby/prism/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/ruby/prism/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/ruby/prism/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/ruby/prism/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/ruby/prism/compare/v0.30.0...v1.0.0
+[0.30.0]: https://github.com/ruby/prism/compare/v0.29.0...v0.30.0
+[0.29.0]: https://github.com/ruby/prism/compare/v0.28.0...v0.29.0
+[0.28.0]: https://github.com/ruby/prism/compare/v0.27.0...v0.28.0
+[0.27.0]: https://github.com/ruby/prism/compare/v0.26.0...v0.27.0
+[0.26.0]: https://github.com/ruby/prism/compare/v0.25.0...v0.26.0
+[0.25.0]: https://github.com/ruby/prism/compare/v0.24.0...v0.25.0
 [0.24.0]: https://github.com/ruby/prism/compare/v0.23.0...v0.24.0
 [0.23.0]: https://github.com/ruby/prism/compare/v0.22.0...v0.23.0
 [0.22.0]: https://github.com/ruby/prism/compare/v0.21.0...v0.22.0

data/CONTRIBUTING.md

@@ -10,10 +10,6 @@ The discussions page on the GitHub repository are open. If you have a question o
 
 If you want to contribute code, please first open or contribute to a discussion. A lot of the project is in flux, and we want to make sure that you are contributing to the right place. Once you have a discussion going, you can open a pull request with your changes. We will review your code and get it merged in.
 
-### Ruby Features
-
-Pattern matching and endless method definitions should be avoided as long as the latest TruffleRuby release does not support it.
-
 ## Tests
 
 We could always use more tests! One of the biggest challenges of this project is building up a big test suite. If you want to contribute tests, feel free to open a pull request. These will get merged in as soon as possible.

data/Makefile

@@ -6,17 +6,21 @@ Q1 = $(V:1=)
 Q = $(Q1:0=@)
 ECHO1 = $(V:1=@ :)
 ECHO = $(ECHO1:0=@ echo)
-FUZZ_OUTPUT_DIR = $(shell pwd)/fuzz/output
+FUZZ_OUTPUT_DIR = $(CURDIR)/fuzz/output
 
-SOEXT := $(shell ruby -e 'puts RbConfig::CONFIG["SOEXT"]')
+SOEXT ?= $(shell ruby -e 'puts RbConfig::CONFIG["SOEXT"]')
 
-CPPFLAGS := -Iinclude
-CFLAGS := -g -O2 -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -Wno-missing-braces -fPIC -fvisibility=hidden
-CC := cc
+CPPFLAGS := -Iinclude $(CPPFLAGS)
+CFLAGS := -g -O2 -std=c99 -Wall -Werror -Wextra -Wpedantic -Wundef -Wconversion -Wno-missing-braces -fPIC -fvisibility=hidden -Wimplicit-fallthrough $(CFLAGS)
+CC ?= cc
+AR ?= ar
 WASI_SDK_PATH := /opt/wasi-sdk
 
-HEADERS := $(shell find include -name '*.h')
-SOURCES := $(shell find src -name '*.c')
+MAKEDIRS ?= mkdir -p
+RMALL ?= rm -f -r
+
+HEADERS := $(wildcard include/*.h include/*/*.h include/*/*/*.h')
+SOURCES := $(wildcard src/*.c src/*/*.c)
 SHARED_OBJECTS := $(subst src/,build/shared/,$(SOURCES:.c=.o))
 STATIC_OBJECTS := $(subst src/,build/static/,$(SOURCES:.c=.o))
 
@@ -28,11 +32,11 @@ wasm: javascript/src/prism.wasm
 java-wasm: java-wasm/src/test/resources/prism.wasm
 
 build/libprism.$(SOEXT): $(SHARED_OBJECTS)
-	$(ECHO) "linking $@"
+	$(ECHO) "linking $@ with $(CC)"
 	$(Q) $(CC) $(DEBUG_FLAGS) $(CFLAGS) -shared -o $@ $(SHARED_OBJECTS)
 
 build/libprism.a: $(STATIC_OBJECTS)
-	$(ECHO) "building $@"
+	$(ECHO) "building $@ with $(AR)"
 	$(Q) $(AR) $(ARFLAGS) $@ $(STATIC_OBJECTS) $(Q1:0=>/dev/null)
 
 javascript/src/prism.wasm: Makefile $(SOURCES) $(HEADERS)
@@ -45,17 +49,17 @@ java-wasm/src/test/resources/prism.wasm: Makefile $(SOURCES) $(HEADERS)
 
 build/shared/%.o: src/%.c Makefile $(HEADERS)
 	$(ECHO) "compiling $@"
-	$(Q) mkdir -p $(@D)
+	$(Q) $(MAKEDIRS) $(@D)
 	$(Q) $(CC) $(DEBUG_FLAGS) -DPRISM_EXPORT_SYMBOLS $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
 
 build/static/%.o: src/%.c Makefile $(HEADERS)
 	$(ECHO) "compiling $@"
-	$(Q) mkdir -p $(@D)
+	$(Q) $(MAKEDIRS) $(@D)
 	$(Q) $(CC) $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) -c -o $@ $<
 
 build/fuzz.%: $(SOURCES) fuzz/%.c fuzz/fuzz.c
 	$(ECHO) "building $* fuzzer"
-	$(Q) mkdir -p $(@D)
+	$(Q) $(MAKEDIRS) $(@D)
 	$(ECHO) "building main fuzz binary"
 	$(Q) AFL_HARDEN=1 afl-clang-lto $(DEBUG_FLAGS) $(CPPFLAGS) $(CFLAGS) $(FUZZ_FLAGS) -O0 -fsanitize-ignorelist=fuzz/asan.ignore -fsanitize=fuzzer,address -ggdb3 -std=c99 -Iinclude -o $@ $^
 	$(ECHO) "building cmplog binary"
@@ -66,7 +70,7 @@ build/fuzz.heisenbug.%: $(SOURCES) fuzz/%.c fuzz/heisenbug.c
 
 fuzz-debug:
 	$(ECHO) "entering debug shell"
-	$(Q) docker run -it --rm -e HISTFILE=/prism/fuzz/output/.bash_history -v $(shell pwd):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz
+	$(Q) docker run -it --rm -e HISTFILE=/prism/fuzz/output/.bash_history -v $(CURDIR):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz
 
 fuzz-docker-build: fuzz/docker/Dockerfile
 	$(ECHO) "building docker image"
@@ -76,17 +80,17 @@ fuzz-run-%: FORCE fuzz-docker-build
 	$(ECHO) "generating templates"
 	$(Q) bundle exec rake templates
 	$(ECHO) "running $* fuzzer"
-	$(Q) docker run --rm -v $(shell pwd):/prism prism/fuzz /bin/bash -c "FUZZ_FLAGS=\"$(FUZZ_FLAGS)\" make build/fuzz.$*"
+	$(Q) docker run --rm -v $(CURDIR):/prism prism/fuzz /bin/bash -c "FUZZ_FLAGS=\"$(FUZZ_FLAGS)\" make build/fuzz.$*"
 	$(ECHO) "starting AFL++ run"
-	$(Q) mkdir -p $(FUZZ_OUTPUT_DIR)/$*
-	$(Q) docker run -it --rm -v $(shell pwd):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz /bin/bash -c "./fuzz/$*.sh /fuzz_output/$*"
+	$(Q) $(MAKEDIRS) $(FUZZ_OUTPUT_DIR)/$*
+	$(Q) docker run -it --rm -v $(CURDIR):/prism -v $(FUZZ_OUTPUT_DIR):/fuzz_output prism/fuzz /bin/bash -c "./fuzz/$*.sh /fuzz_output/$*"
 FORCE:
 
 fuzz-clean:
-	$(Q) rm -f -r fuzz/output
+	$(Q) $(RMALL) fuzz/output
 
 clean:
-	$(Q) rm -f -r build
+	$(Q) $(RMALL) build
 
 .PHONY: clean fuzz-clean
 
@@ -94,6 +98,9 @@ all-no-debug: DEBUG_FLAGS := -DNDEBUG=1
 all-no-debug: OPTFLAGS := -O3
 all-no-debug: all
 
+minimal: CFLAGS := $(CFLAGS) -DPRISM_BUILD_MINIMAL
+minimal: all
+
 run: Makefile $(STATIC_OBJECTS) $(HEADERS) test.c
 	$(ECHO) "compiling test.c"
 	$(Q) $(CC) $(CPPFLAGS) $(CFLAGS) $(STATIC_OBJECTS) test.c

data/README.md

@@ -3,7 +3,7 @@
   <img alt="Prism Ruby parser" height="256px" src="https://github.com/ruby/prism/blob/main/doc/images/prism.png?raw=true">
 </div>
 
-This is a parser for the Ruby programming language. It is designed to be portable, error tolerant, and maintainable. It is written in C99 and has no dependencies. It is currently being integrated into [CRuby](https://github.com/ruby/ruby), [JRuby](https://github.com/jruby/jruby), [TruffleRuby](https://github.com/oracle/truffleruby), [Sorbet](https://github.com/sorbet/sorbet), and [Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree).
+This is a parser for the Ruby programming language. It is designed to be portable, error tolerant, and maintainable. It is written in C99 and has no dependencies.
 
 ## Overview
 
@@ -15,27 +15,35 @@ The repository contains the infrastructure for both a shared library (libprism)
 ├── Rakefile              configuration to compile the native extension and run the Ruby tests
 ├── bin
 │   ├── lex               runs the lexer on a file or string, prints the tokens, and compares to ripper
-│   └── parse             runs the parser on a file or string and prints the syntax tree
+│   ├── parse             runs the parse on a file or string and prints the AST
+│   └── prism             a CLI for development and debugging
 ├── config.yml            specification for tokens and nodes in the tree
-├── docs                  documentation about the project
+├── doc                   documentation website
+├── docs                  markdown documentation about the project
 ├── ext
 │   └── prism
 │       ├── extconf.rb    configuration to generate the Makefile for the native extension
 │       └── extension.c   the native extension that interacts with libprism
 ├── fuzz                  files related to fuzz testing
+├── gemfiles              gemfiles used by different Ruby versions in CI
 ├── include
 │   ├── prism             header files for the shared library
 │   └── prism.h           main header file for the shared library
 ├── java                  Java bindings for the shared library
+├── java-wasm             Java WASM bindings for the shared library
+├── javascript            JavaScript WASM bindings for the shared library
 ├── lib
 │   ├── prism             Ruby library files
 │   └── prism.rb          main entrypoint for the Ruby library
 ├── rakelib               various Rake tasks for the project
+├── rbi                   RBI type signatures for the Ruby library
 ├── rust
 │   ├── ruby-prism        Rustified crate for the shared library
 │   └── ruby-prism-sys    FFI binding for Rust
+├── sample
+│   └── prism             Sample code that uses the Ruby API for documentation purposes
+├── sig                   RBS type signatures for the Ruby library
 ├── src
-│   ├── enc               various encoding files
 │   ├── util              various utility files
 │   └── prism.c           main entrypoint for the shared library
 ├── templates             contains ERB templates generated by templates/template.rb
@@ -51,7 +59,7 @@ The repository contains the infrastructure for both a shared library (libprism)
 To compile the shared library, you will need:
 
 * C99 compiler
-* make
+* GNU make
 * Ruby 2.7.0 or later
 
 Once you have these dependencies, run:
@@ -91,8 +99,51 @@ See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information. We additio
 * [Parser translation](docs/parser_translation.md)
 * [Parsing rules](docs/parsing_rules.md)
 * [Releasing](docs/releasing.md)
-* [Ripper](docs/ripper.md)
+* [Ripper translation](docs/ripper_translation.md)
 * [Ruby API](docs/ruby_api.md)
 * [RubyParser translation](docs/ruby_parser_translation.md)
 * [Serialization](docs/serialization.md)
 * [Testing](docs/testing.md)
+
+## Examples
+
+Prism has been integrated into the majority of Ruby runtimes, many libraries, and some applications. Below is a list of some of the projects that use Prism:
+
+### Runtimes
+
+* [CRuby](https://github.com/ruby/ruby/pull/7964) (via C)
+* [Garnet](https://github.com/camertron/garnet-js) (via WASM)
+* [JRuby](https://github.com/jruby/jruby/pull/8103) (via Java)
+* [Natalie](https://github.com/natalie-lang/natalie/pull/1213) (via C++ and Ruby)
+* [Opal](https://github.com/opal/opal/pull/2642) (via Ruby and WASM)
+* [TruffleRuby](https://github.com/oracle/truffleruby/issues/3117) (via Java)
+
+### Libraries
+
+* [dispersion](https://github.com/joeldrapper/dispersion)
+* [minifyrb](https://github.com/koic/minifyrb)
+* [packwerk](https://github.com/Shopify/packwerk/pull/388) (via parser translator)
+* [rbi](https://github.com/Shopify/rbi)
+* [rails](https://github.com/rails/rails)
+  * [parsing renders](https://github.com/rails/rails/pull/49438)
+  * [parsing rdoc](https://github.com/rails/rails/pull/50870)
+  * [parsing tests](https://github.com/rails/rails/pull/51006)
+* [repl_type_completor](https://github.com/ruby/repl_type_completor)
+* [rubocop](https://docs.rubocop.org/rubocop/configuration.html#setting-the-parser-engine) (via parser translator)
+* [ruby-lsp](https://github.com/Shopify/ruby-lsp)
+* [smart_todo](https://github.com/Shopify/smart_todo/pull/69)
+* [sorbet-eraser](https://github.com/kddnewton/sorbet-eraser/pull/25)
+* [synvert](https://github.com/xinminlabs/synvert-core-ruby)
+* [typeprof](https://github.com/ruby/typeprof)
+
+### Applications
+
+* [gem.sh](https://github.com/marcoroth/gem.sh/pull/96)
+
+### JRuby gem stuff
+
+- fetch upstream to main in this repository
+- merge to main
+- merge to jruby_gem branch with last released tag
+- update lib/prism/version.rb to match version
+- re-run bundler to kill conflicts in Gemfile.lock