Upgrade JLine to 3.30.6 and Jansi to 2.4.2 by jamesfredley · Pull Request #15367 · apache/grails-core

jamesfredley · 2026-01-30T23:57:44Z

Summary

Closes #13752

This PR upgrades JLine from 2.14.6 to 3.30.6 and Jansi from 1.18 to 2.4.2, migrating all CLI code to the JLine 3 API.

Commits

Upgrade JLine to 3.30.6 and Jansi to 2.4.2 - Core migration of all JLine 2 code to JLine 3 API
Add comprehensive test coverage for JLine 3 completers - ~100+ new test cases for completer functionality
Improve LineReader completer updates and CTRL+C handling - Performance and UX improvements

Changes

Dependency Updates

jline.version: 2.14.6 → 3.30.6 (now org.jline:jline)
jansi.version: 1.18 → 2.4.2
Added jline2.version: '2.14.6' for Groovy 4.x compatibility

JLine 3 Migration

Migrated from jline.console.ConsoleReader to org.jline.reader.LineReader / org.jline.terminal.Terminal
Updated all Completer implementations to use new signature: complete(LineReader, ParsedLine, List<Candidate>)
Replaced CharSequence candidates with Candidate objects
Updated terminal creation to use TerminalBuilder
Fixed history handling to properly attach to LineReader via builder
Fixed completion candidates to use full names (flags, profiles, features)
Fixed dumb terminal detection using "dumb".equals(terminal.getType())
Implemented AggregateCompleter to support multiple completers in GrailsConsole

Performance & UX Improvements

Efficient completer updates: Use updateCompleter() instead of rebuilding LineReader when adding completers
Auto-complete common prefix: CandidateListCompletionHandler now auto-completes the common prefix in the buffer
Improved CTRL+C handling: Better cancellation support during command execution by masking terminal interrupt and polling for keypress

Groovy 4.x Compatibility

Retained JLine 2 (jline:jline:2.14.6) as a dependency for groovy-groovysh compatibility
Groovy 4.x's groovysh module still requires JLine 2
Both JLine versions coexist (different package namespaces: jline.* vs org.jline.*)
Added TODO comments marking JLine 2 dependencies for removal when upgrading to Groovy 5

Files Modified

44 files across grails-bootstrap, grails-shell-cli, grails-console, grails-gradle/model, and build configuration

New Test Coverage (~100+ test cases)

New Test Specifications:

StringsCompleterSpec - 20+ tests for string-based completion (edge cases, unicode, special characters)
SortedAggregateCompleterSpec - 10 tests for aggregate completer functionality
ClosureCompleterSpec - 8 tests for closure-based completion (lazy evaluation, caching)
EscapingFileNameCompletorSpec - 10 tests for file name completion with whitespace escaping
SimpleOrFileNameCompletorSpec - 12 tests for combined fixed options + file completion
CommandCompleterSpec - 12 tests for command completion delegation
CandidateListCompletionHandlerSpec - 20+ tests for completion handler and common prefix detection
GrailsConsoleCompleterSpec - 15+ tests for console completer management

Enhanced Existing Tests:

RegexCompletorSpec - Added 10+ edge case tests for regex-based completion

Testing Verification

All existing tests pass
All new tests pass (102 tests in grails-shell-cli, 100+ in grails-bootstrap)
Checkstyle and CodeNarc pass
Build verified: classes, test, installDist, grails-gradle build, grails-forge classes

Stats

44 files changed, 2703 insertions(+), 352 deletions(-)

Copilot

Pull request overview

This PR upgrades JLine from version 2.14.6 to 3.27.1 and Jansi from 1.18 to 2.4.1, requiring a comprehensive migration of all CLI-related code to the JLine 3 API. The changes address Java 24 compatibility warnings related to restricted method calls in the legacy Jansi version.

Changes:

Updated JLine dependency from jline:jline:2.14.6 to org.jline:jline:3.27.1 and Jansi from 1.18 to 2.4.1
Migrated console infrastructure from JLine 2 API (ConsoleReader, Terminal, Completer) to JLine 3 API (LineReader, Terminal, Completer)
Retained JLine 2 as a transitional dependency for Groovy 4.x's groovysh module compatibility, marked with TODO comments for removal when upgrading to Groovy 5

Reviewed changes

Copilot reviewed 36 out of 36 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
dependencies.gradle	Updates JLine version to 3.27.1, Jansi to 2.4.1, adds jline2 version variable for backward compatibility
grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java	Migrates from JLine 2 ConsoleReader to JLine 3 LineReader, updates terminal creation and history handling
grails-bootstrap/src/main/groovy/grails/build/logging/GrailsEclipseConsole.java	Updates terminal creation to use JLine 3 TerminalBuilder
grails-bootstrap/src/main/groovy/org/grails/build/interactive/CandidateListCompletionHandler.java	Converts from JLine 2 CompletionHandler to JLine 3 Completer interface
grails-shell-cli/src/main/groovy/org/grails/cli/GrailsCli.groovy	Updates interactive mode handling, terminal access, and history navigation for JLine 3
grails-shell-cli/src/main/groovy/org/grails/cli/profile/commands/*.groovy	Updates all command completers to use JLine 3 Completer signature with Candidate objects
grails-shell-cli/src/main/groovy/org/grails/cli/interactive/completers/*.{java,groovy}	Migrates all completer implementations to JLine 3 API, replacing CharSequence with Candidate
grails-shell-cli/src/test/groovy/org/grails/cli/interactive/completers/RegexCompletorSpec.groovy	Updates tests to use JLine 3 API with ParsedLine and Candidate
grails-console/build.gradle, gradle/docs-dependencies.gradle	Adds both JLine 3 and JLine 2 dependencies with TODO comments
build-logic/plugins/src/main/groovy/org/apache/grails/buildsrc/SbomPlugin.groovy	Updates license mapping for JLine 3.27.1 to BSD-3-Clause
Multiple build.gradle files	Updates JLine dependency references from `jline:jline` to `org.jline:jline`

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

...s-bootstrap/src/main/groovy/org/grails/build/interactive/CandidateListCompletionHandler.java

grails-shell-cli/src/main/groovy/org/grails/cli/profile/commands/CreateAppCommand.groovy

...s-shell-cli/src/main/groovy/org/grails/cli/profile/commands/ArgumentCompletingCommand.groovy

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

grails-forge/gradle.properties

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

Closes #13752 - Update jline from 2.14.6 to 3.30.6 (org.jline:jline) - Update jansi from 1.18 to 2.4.2 - Migrate all CLI code from JLine 2 API to JLine 3 API: - ConsoleReader -> LineReader/Terminal - jline.console.completer.Completer -> org.jline.reader.Completer - complete(buffer, cursor, candidates) -> complete(reader, line, candidates) - CharSequence candidates -> Candidate objects - Keep JLine 2 (jline:jline:2.14.6) for groovy-groovysh compatibility (Groovy 4.x groovysh requires JLine 2; Groovy 5.x uses JLine 3) - Add TODO comments for JLine 2 removal when upgrading to Groovy 5 - Add JLine 3.30.6 license mapping in SbomPlugin (BSD-3-Clause) - Update RegexCompletorSpec tests for JLine 3 API - Fix history handling to properly attach to LineReader - Fix completion candidates to use full names instead of suffixes - Remove unused imports and fields - Use AggregateCompleter to support multiple completers - Fix readLine method signature for JLine 3 API - Sync jansi version in grails-forge to 2.4.2

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

grails-console/build.gradle

gradle/docs-dependencies.gradle

grails-gradle/gradle/docs-config.gradle

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

Copilot

Pull request overview

Copilot reviewed 44 out of 44 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java

grails-shell-cli/src/main/groovy/org/grails/cli/GrailsCli.groovy

GrailsConsole improvements: - Use updateCompleter() with LineReaderImpl.setCompleter() instead of rebuilding the entire LineReader when completers are added - Add dedicated initializeHistory() method that properly attaches DefaultHistory to the LineReader after construction - CandidateListCompletionHandler: Auto-complete common prefix in buffer GrailsCli improvements: - Replace manual terminal attribute manipulation and input polling with JLine 3's native Terminal.Signal.INT handler for CTRL+C cancellation - This is the idiomatic way to handle interrupts in JLine 3 Test coverage: - Add comprehensive tests for GrailsConsole completer management - Add tests for CandidateListCompletionHandler - Add tests for all CLI completers: StringsCompleter, RegexCompletor, ClosureCompleter, SortedAggregateCompleter, EscapingFileNameCompletor, SimpleOrFileNameCompletor, and CommandCompleter

Copilot

Pull request overview

Copilot reviewed 44 out of 44 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

grails-shell-cli/src/main/groovy/org/grails/cli/profile/commands/HelpCommand.groovy

Copilot AI review requested due to automatic review settings January 30, 2026 23:57

github-project-automation bot added this to Apache Grails Jan 30, 2026

Copilot started reviewing on behalf of jamesfredley January 30, 2026 23:58 View session

jamesfredley self-assigned this Jan 30, 2026

Copilot AI reviewed Jan 31, 2026

View reviewed changes

jamesfredley force-pushed the issue-13752-upgrade-jansi-jline branch from 958bfea to 5d68523 Compare January 31, 2026 00:09

jamesfredley changed the title ~~Upgrade JLine to 3.27.1 and Jansi to 2.4.1~~ Upgrade JLine to 3.30.6 and Jansi to 2.4.2 Jan 31, 2026

jamesfredley force-pushed the issue-13752-upgrade-jansi-jline branch from 5d68523 to 57e5cbe Compare January 31, 2026 00:24

jamesfredley linked an issue Jan 31, 2026 that may be closed by this pull request

Console and Cli rewrite for org.jline:jline:3.0.0-3.27.1+ #13752

Open

jamesfredley requested a review from Copilot January 31, 2026 00:27

Copilot started reviewing on behalf of jamesfredley January 31, 2026 00:27 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java Show resolved Hide resolved

grails-forge/gradle.properties Outdated Show resolved Hide resolved

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java Outdated Show resolved Hide resolved

jamesfredley force-pushed the issue-13752-upgrade-jansi-jline branch from 57e5cbe to b4e78a0 Compare January 31, 2026 00:45

jamesfredley requested a review from Copilot January 31, 2026 00:47

Copilot started reviewing on behalf of jamesfredley January 31, 2026 00:47 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

jamesfredley marked this pull request as draft January 31, 2026 01:11

jamesfredley requested a review from Copilot January 31, 2026 02:08

Copilot started reviewing on behalf of jamesfredley January 31, 2026 02:08 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

grails-bootstrap/src/main/groovy/grails/build/logging/GrailsConsole.java Outdated Show resolved Hide resolved

grails-shell-cli/src/main/groovy/org/grails/cli/GrailsCli.groovy Outdated Show resolved Hide resolved

jamesfredley force-pushed the issue-13752-upgrade-jansi-jline branch from 2074cbf to d86a398 Compare January 31, 2026 03:04

jamesfredley requested a review from Copilot January 31, 2026 03:05

Copilot started reviewing on behalf of jamesfredley January 31, 2026 03:06 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

grails-shell-cli/src/main/groovy/org/grails/cli/profile/commands/HelpCommand.groovy Show resolved Hide resolved

jamesfredley marked this pull request as ready for review January 31, 2026 03:44

jamesfredley added 3 commits January 30, 2026 23:08

Simplify HelpCommand completion logic for JLine 3

0cf49b2

Merge branch '8.0.x' into issue-13752-upgrade-jansi-jline

637ea00

Merge branch '8.0.x' into issue-13752-upgrade-jansi-jline

a512c1b

jamesfredley added the relates-to:v8 Grails 8 label Feb 3, 2026

jamesfredley moved this to In Progress in Apache Grails Feb 5, 2026

jamesfredley added this to the grails:8.0.0-M1 milestone Feb 5, 2026

Merge branch '8.0.x' into issue-13752-upgrade-jansi-jline

65da396

Uh oh!

Conversation

jamesfredley commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Commits

Changes

Dependency Updates

JLine 3 Migration

Performance & UX Improvements

Groovy 4.x Compatibility

Files Modified

New Test Coverage (~100+ test cases)

Testing Verification

Stats

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jamesfredley commented Jan 30, 2026 •

edited

Loading