Skip to content

docs(lifecycle): reload results, partial-reload hook and loaded-module list (as of v6.3.0) - #107

Open
wisdommen wants to merge 2 commits into
alphafrom
docs/p17-fu-lifecycle
Open

wisdommen wants to merge 2 commits into
alphafrom
docs/p17-fu-lifecycle

Conversation

@wisdommen

@wisdommen wisdommen commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Documentation companion to UltiKits/UltiTools-Reborn#564 (unload and reload report the module's real state). This pull request targets alpha deliberately: it documents unreleased 6.3.0 behaviour, which reaches master with the release.

What changes

  • guide/quick-start.md (en + zh):
    • the framework logs a module's reload line after onReload() returns (the page said before);
    • new section "Reload results": the failure reply of /ul reload <name>, the summary reply of /ul reload, the partial-reload hook onReload(ReloadReport) with an inline example, reloadWithReport(), and the notice a per-module reload gives when the language setting changed on disk;
    • new section "Loaded-module list": getPluginList() returns an unmodifiable snapshot, and PluginManager.unregister(...) delists the module. (Releasing the module's configuration on unload is not part of UltiTools-Reborn#564; it moved to the framework's configuration-layer rework and will be documented with it.)
  • guide/advanced/module-versioning.md (en + zh): the unregisterSupersededVersions row states the full unload and that an unload failure is logged against the old version.

Prose and inline code only, each change marked "as of v6.3.0"; no new <<< reference into examples/, since the API is not in the released jar. Local checks: npm run build green, check:parity OK, check-container-length.sh clean, heading count 18/18.


中文摘要:本 PR 是框架 PR UltiKits/UltiTools-Reborn#564 的文档配套,面向 alpha(记录尚未发布的 6.3.0 行为)。快速开始页更正重载日志行的时机(在 onReload() 返回之后),新增「重载结果」与「已加载模块列表」两节;模块版本页说明被取代的旧版本走完整卸载流程。「已加载模块列表」一节只说明卸载时移出列表,释放配置的部分随框架配置层重构另行记录。仅文字与内联代码,不引用 examples/。

🤖 Generated with Claude Code

…e list, as of v6.3.0

Companion to the UltiTools-Reborn lifecycle pull request (framework issues 507, 506, 528, 509, 529, 502).

- quick-start (en + zh): the framework logs a module's reload line after onReload() returns, not
  before; new "Reload results" section -- failure and summary replies, onReload(ReloadReport) with
  an inline example, reloadWithReport(), and the changed-language notice of a per-module reload;
  new "Loaded-module list" section -- getPluginList() is an unmodifiable snapshot and unregister()
  delists and releases the module's configuration.
- module-versioning (en + zh): the superseded-version row states the full unload and that an
  unload failure is logged against the old version.

Prose and inline code only; no examples/ reference to an unreleased API.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-30T11:11:42.543113Z 2bbf23a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Deploying ultitools-dev-doc with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7a414c5
Status: ✅  Deploy successful!
Preview URL: https://ea66032a.ultitools-dev-doc.pages.dev
Branch Preview URL: https://docs-p17-fu-lifecycle.ultitools-dev-doc.pages.dev

View logs

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2bbf23a6db

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


A reload that completes only in part can say so without throwing. Override `onReload(ReloadReport report)` instead of `onReload()`, and record each part that did not reload with `report.partial(...)`:

```java

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Do not duplicate the Java example across locales

This fenced example is maintained separately from the corresponding Chinese block, whose message strings already differ, so subsequent API or example corrections can drift between locales and bypass the repository's shared-example checks. The documentation rules require Java examples to be included from one shared .java file using <<<; because CONTRIBUTING.md prohibits referencing this unreleased API from the currently compiled examples, defer the example until the API release or provide another single shared source rather than duplicating it inline.

AGENTS.md reference: AGENTS.md:L85-L85

Useful? React with 👍 / 👎.

…oved to the configuration-layer rework

Follows UltiKits/UltiTools-Reborn#564: the configuration-release half of framework issue 507 left that
pull request for the configuration-layer rework, so the "Loaded-module list" section (en + zh) no longer
says unregister() releases the module's configuration.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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.

1 participant