Skip to content

docs: bring the README up to date - #61

Merged
amritk merged 1 commit into
mainfrom
claude/nice-ramanujan-l9i4fw
Nov 13, 2026
Merged

amritk merged 1 commit into
mainfrom
claude/nice-ramanujan-l9i4fw

Conversation

@amritk

@amritk amritk commented Nov 13, 2026

Copy link
Copy Markdown
Member

What & why

The root README had fallen behind the Ruby move to rbcop (#57) and a few other changes.

  • Package table: Ruby's reference column now reads rbcop instead of RuboCop (Layout). The paragraph below says the reference it is held to is still rubocop --autocorrect --only Layout.
  • Wording left from the CRuby VM: Usage no longer says format boots a Ruby VM, and the Ruby recycling caveat and the Swift comparison to "the Ruby VM" leaking are gone. Usage now notes that Ruby under Node needs no init() before formatSync.
  • PHP: it was described as "the one package with a synchronous entry point", but every package has formatSync now. It is now described as the one whose formatSync cannot run the module synchronously.
  • Kotlin: adds the missing Kotlin section (ktfmt 0.64, the two-step 1767/1767 check, the Node 24.15 minimum), taken from packages/kotlin/README.md.
  • Sizes: corrected to the committed artifacts (MiB, matching the rest of the table): Java 0.76 MB (was 0.77), Kotlin 0.81 MB (was 0.82), TeaVM runtime 17 KB (was 16 KB). The matching current-state figures in the Java and Kotlin package READMEs are updated too.
  • Development: the test:node note says 24.15+ for Java and Kotlin, not 24+ for Java.

Which packages

Docs only: README.md, packages/java/README.md, packages/kotlin/README.md.

Exactness

No output change. No status was changed. Ruby stays "exact by test", held by its conformance test against real RuboCop 1.92.2. The Usage example (x=[1,2,3].map{|n| n*2} → x = [1, 2, 3].map { |n| n * 2 }) was re-run through @scalar/ruby-fmt and matches.

How it was validated

  • bun run check
  • bun run types:check (no code changed)
  • bun run test (no code changed)
  • bun run test:node (n/a)
  • Rebuilt the wasm artifact and re-ran its conformance script (n/a)

Tool versions were checked against the build scripts, and sizes were measured from the committed .br files.

Changeset

  • Added a changeset (empty, docs only)

Generated by Claude Code

List rbcop as Ruby's reference in the package table, add the missing
Kotlin section, drop wording left over from the CRuby VM (boot, leaks,
recycling), note that Ruby under Node needs no init() for formatSync,
and correct the Java and Kotlin artifact sizes to the committed files.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01L7QsVKNxGFqNgbZxECZBkR
@amritk
amritk merged commit 801f378 into main Nov 13, 2026
8 checks passed
@amritk
amritk deleted the claude/nice-ramanujan-l9i4fw branch November 13, 2026 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants