ruby / ruby/prism

Release official Java API

Open
#4,018 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

java
Dominant language
C
Stars
1k
Forks
194
Avg merge
2d 6h
Merged PRs (30d)
15

Description

This is a parent issue for all tasks needed to declare the Java API "official" and release it for the general JVM public.

Subtasks:

  • Split artifact into share API, native backend, WASM backend, and WASM backend with full non-semantic data (see discussions in #3962).
  • Consider depending on jcodings Encoding to align with CRuby's supported encodings (Java's default set of Charsets does not cover all cases).
  • Consider storing regular expressions as compiled JOni Regex to verify them at parse time.
  • Consider shifting to or adding a zero-allocation protobuf-style API.
  • Documentation.
  • Bump version to 1.0.0.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation files or tests are named. Review the unchecked subtasks and the discussions in #3962 first, then determine the remaining work for encoding support, parse-time regex compilation, documentation, and the 1.0.0 version bump; the parent issue is done when these tasks are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, wasm
Domain
api, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.