Skip to content

T8 - #1900

Merged
nmaguiar merged 18 commits into
masterfrom
t8
Sep 23, 2026
Merged

T8#1900
nmaguiar merged 18 commits into
masterfrom
t8

Conversation

@nmaguiar

Copy link
Copy Markdown
Collaborator

This pull request introduces several documentation improvements and updates to OpenAF, focusing on enhanced explanations for installation, update, and shebang script features, as well as new and updated documentation for the interactive console and bundled assets. The changes also clarify the update process, improve CLI flag descriptions, and update licensing and third-party dependency records.

Documentation enhancements and new guides:

  • Added a comprehensive guide for the interactive console (oafc/openaf-console), including usage, built-in commands, aliases, and profile/history file support. (docs/console.md)
  • Linked the new console documentation from the main index and CLI reference. (docs/index.md, docs/cli.md) [1] [2]

Improvements to CLI flag and wrapper script documentation:

  • Expanded CLI flag descriptions, including detailed usage for --install, --update, and --sb, and clarified the generated wrapper scripts table with notes on script generation and usage. (docs/cli.md) [1] [2] [3]
  • Added a new section explaining shebang script generation and invocation, including interpreter selection by file extension and correct handling for new and existing files. (docs/cli.md)
  • Documented the update process in detail, including backup, download, repack, and JRE refresh steps, as well as offline/restricted mode behavior. (docs/cli.md)

Java shared archive and performance documentation:

  • Added a new guide on shared archive coverage and the --repack process, explaining archive generation, validation, fallback behavior, and performance impact. (docs/cds.md)
  • Updated build instructions to reference the new shared archive repacking workflow and documentation. (BUILD.md)

Third-party and asset updates:

  • Updated the JLine license and dependency record to reflect the move to version 4.4.3, with legacy compatibility adapters from 2.14.6, and clarified licensing and file locations. (LICENSES.txt)
  • Added documentation for the updated bundled highlight.js asset, detailing the version bump, included languages, validation steps, and reproduction instructions. (docs/highlight-js.md)

Build and codebase maintenance:

  • Added a new instrumentation wrapper to the build script's module map. (buildos.js)

- Update cli.md and index.md
- Add console.md
- Refactor genSB.js and openafconsole.js for better console integration
- Update js/openaf.js and AFBase.java with new logic
- Minor adjustments to AFCmdBase.java
- Expand test coverage in autoTestAll.Format.js
- Update oafp.js and openaf.js to refine core functionality
- Expand autoTestAll.Format tests and configuration
- Update js/openaf.js with new formatting capabilities
- Refine tests/autoTestAll.Format.js and tests/autoTestAll.Format.yaml to cover new behavior
Expand the AI wrapper (js/owrap.ai.js) with substantial new
functionality and update the core script (js/openaf.js) with
supporting changes for the new wrapper features.
Upgrade bundled dependencies to their latest releases:
- h2 2.4.240 -> 2.5.250
- jetty 12.1.12 -> 12.1.13 (client, http, io, util, websocket)
- kotlin-stdlib 2.4.0 -> 2.4.20
- okio 3.18.1 -> 3.18.2

Update pom.xml and pom.json to match the new jar versions.
Add js/repackCDS.js implementing CDS functionality and register it in js/openaf.js. Refactor js/repack.js to share common logic. Include docs/cds.md documentation and add autoTestAll.CDS.{js,yaml} tests wired into autoTestAll.allJobs.yaml.
Update the Channels owrap implementation and extend the Channels autoTest suite with new test cases covering the changed behavior.
Refine the Channels wrapper in js/owrap.ch.js and extend the autoTestAll.Channels test suite with new cases covering the updated wrapper behavior.
Streamline the channels, dev and server wrapper modules in js/, reducing overall code size (116 insertions, 162 deletions) across the three files.
Add js/owrap.instrumentation.js with instrumentation hooks and wire it
into the oJob, obj, and server wrappers. Register the new module in
openaf.js and buildos.js, document usage in docs/instrumentation.md,
and add autoTestAll.Instrumentation tests to the test suite.
Replace the bundled jline-2.14.6.jar with the JLine 4.4.3 jars
(native, reader, terminal, terminal-jni) and add a legacy jline 2.x
compatibility layer under src/jline (ConsoleReader, history and
completer classes) so existing code keeps working on top of JLine 4.

Update the repack logic (OAFRepack, js/repack.js, js/opack.js,
js/genScripts.js) and build metadata (pom.xml, pom.json,
versionsAndDeps.json, LICENSES.txt) for the new jars, extend the
Console plugin and completer, and refresh the Console documentation.

Add a Console test suite (autoTestAll.Console.{js,yaml}, PTY-based
console tests, and Java compatibility/repack tests) to cover the
migration.
- Update js/owrap.obj.js with object wrapping logic
- Add comprehensive tests in tests/autoTestAll.Obj.js and tests/autoTestAll.Obj.yaml
- Update BUILD.md and docs/testing.md with relevant documentation
Refresh the bundled highlight.js syntax highlighter (js/highlight.js) and add its accompanying documentation (docs/highlight-js.md).

Upgrade SLF4J API and NOP binding jars from 2.0.18 to 2.0.19 and update pom.xml/pom.json to reference the new version.
- Update java-util to 4.111.0
- Update json-io to 4.111.0
- Update pom.json and pom.xml
- Refine ConsoleReader.java and add ConsoleCompatibilityTest.java
@nmaguiar nmaguiar self-assigned this Sep 23, 2026
@nmaguiar nmaguiar added bug enhancement documentation dependencies Pull requests that update a dependency file labels Sep 23, 2026
@nmaguiar
nmaguiar merged commit f164ab4 into master Sep 23, 2026
1 check passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Continuous Enhancement Sep 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug dependencies Pull requests that update a dependency file documentation enhancement

Projects

Development

Successfully merging this pull request may close these issues.

1 participant