Docs & rules

jline/jline3GitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

1 stale name in these docs.

master632c696Last read Oct 2

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

1 stale name

25 docs

jline/jline3Open repository

Stale names in these docs1

Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

Goneorg.jline.builtins.TerminalDemo
Several demo applications are provided in the TerminalDemo class:
org.jline.builtins declares nothing by this name.
View on GitHub

jline/jline3 — documented rules

28 of 28 rules, printed October 14, 2026.

	The sentence in your docs
Read Oct 2	From the prompt object, use the `getPromptBuilder()` method to create the builder for all subsequent UI elements you want to use.	ConsolePrompt has a `getPromptBuilder` method	Holds
Read Oct 2	The `Terminal` interface represents the terminal device.	Terminal is a contract	Holds
Read Oct 2	The `LineReader` interface provides line editing capabilities.	LineReader is a contract	Holds
Read Oct 2	The `Highlighter` interface provides syntax highlighting.	Highlighter is a contract	Holds
Read Oct 2	The `LineReader` builds on top of the Terminal to provide:	LineReader depends on Terminal	Holds
Read Oct 2	The Telnet server creates a new `Terminal` instance for each client connection, allowing remote users to interact with your application as if they were using a local terminal.	Telnet depends on Terminal	Holds
Read Oct 2	From the prompt object, use the `getPromptBuilder()` method to create the builder for all subsequent UI elements.	ConsolePrompt has a `getPromptBuilder` method	Holds
Read Oct 2	ConsoleEngine - Extends the CommandRegistry interface.	ConsoleEngine extends CommandRegistry	Holds
Read Oct 2	SystemRegistry - Extends the CommandRegistry interface.	SystemRegistry extends CommandRegistry	Holds
Read Oct 2	A `CommandGroup` organizes commands for discovery. Unlike the old `CommandRegistry`, it has no execution or completion concerns — those belong to the `CommandDispatcher`.	CommandDispatcher depends on CommandGroup	Holds
Read Oct 2	The `PipelineParser` is extensible — register custom operators via its constructor, or subclass and override `matchOperator()` for full control.	PipelineParser has a `matchOperator` method	Holds
Read Oct 2	The `AliasManager` interface and `DefaultAliasManager` implementation provide a command alias system with `$1`/`$2`/`$@` parameter substitution and optional file persistence.	DefaultAliasManager implements AliasManager	Holds
Read Oct 2	The `JobManager` and `Job` interfaces provide job control for managing foreground, background, and suspended commands. 2 rules from this sentence	JobManager is a contract	Holds
Read Oct 2		Job is a contract	Holds
Read Oct 2	`AttributedStyle` supports: `bold()`, `faint()`, `italic()`, `underline()`, `blink()`, `inverse()`, `conceal()`, `crossedOut()` 8 rules from this sentence	AttributedStyle has a `bold` method	Holds
		AttributedStyle has a `faint` method	Holds
		AttributedStyle has an `italic` method	Holds
		AttributedStyle has an `underline` method	Holds
		AttributedStyle has a `blink` method	Holds
		AttributedStyle has an `inverse` method	Holds
		AttributedStyle has a `conceal` method	Holds
		AttributedStyle has a `crossedOut` method	Holds
Read Oct 2	The `jline-terminal` module contains `AttributedString`, `AttributedStyle`, and `AttributedStringBuilder` in the `org.jline.utils` package. 3 rules from this sentence	AttributedString is in org.jline.utils	Holds
		AttributedStyle is in org.jline.utils	Holds
		AttributedStringBuilder is in org.jline.utils	Holds
Read Oct 2	The Telnet server includes a `ConnectionManager` that handles client connections:	Telnet depends on ConnectionManager	Holds
Read Oct 2	JLine provides a terminal abstraction using the `Terminal` interface which provides the following features:	Terminal is a contract	Holds
Read Oct 2	The easiest way to obtain such a `Terminal` object in JLine is by using the `TerminalBuilder` class:	TerminalBuilder depends on Terminal	Holds

28 rules from 9 docs

See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.