Skip to content

docs: 更新开源依赖引用列表 #2140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 10, 2025
Merged

docs: 更新开源依赖引用列表 #2140

merged 3 commits into from
May 10, 2025

Conversation

DreamAwakenFateBroke
Copy link
Collaborator

@DreamAwakenFateBroke DreamAwakenFateBroke commented May 10, 2025

Fixes #1746

Proposed Changes

  1. ...
  2. ...
  3. ...

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as either enhancement, bug, documentation or dependencies
  • Verify design and implementation

Summary by Sourcery

Update the project's open-source dependency list and documentation

New Features:

  • Add new dependencies like cssfx, commons-imaging, image4j, teenyHttpd, icns, and jSerialComm

Documentation:

  • Update the list of open-source dependencies in README.md
  • Modify the sidebar documentation structure

Chores:

  • Update dependency versions
  • Modify dependency configuration in DependencyInfo.java

Summary by CodeRabbit

  • 文档

    • 更新了依赖列表,新增多个依赖项并移除 tess4j,优化了表格格式。
    • 侧边栏“示例”更名为“程序”,并移除了 Cg 子栏目及其链接。
    • 删除了部分介绍和开发文档内容,调整了部分章节标题。
  • 其他

    • 更新了部分依赖项的使用状态,不影响功能表现。
    • 对部分配置文件进行了格式微调,无用户可见变化。

Copy link

sourcery-ai bot commented May 10, 2025

Reviewer's Guide

This pull request updates project documentation by adding new entries to the open-source dependency list in docs/README.md and reorganizing the sidebar in docs/_sidebar.md. It also modifies how the commons-email dependency is handled by setting its include flag to false in core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java, and includes updates to IDE dictionary files.

File-Level Changes

Change Details Files
Expanded the list of open-source dependencies in the documentation.
  • Added seven new libraries to the dependency table, including their versions and descriptions.
docs/README.md
Restructured the documentation sidebar.
  • Renamed the 'Examples' menu item to 'Programs'.
  • Removed the 'Cg' example and its associated link from the sidebar.
docs/_sidebar.md
Adjusted a core dependency's inclusion status.
  • Changed the 'include' flag for the 'commons-email' dependency from true to false.
core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java
Updated IDE-specific dictionary configuration.
  • Modified project dictionary files used by the IDE.
.idea/dictionaries

Assessment against linked issues

Issue Objective Addressed Explanation

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

quine-bot bot commented May 10, 2025

👋 Figuring out if a PR is useful is hard, hopefully this will help.

  • @DreamAwakenFateBroke has been on GitHub since 2022 and in that time has had 49 public PRs merged
  • Don't you recognize them? They've been here before 🎉
  • Here's a good example of their work: javafxTool (Javafx scaffolding, built on JDK17 + JavaFX21 + controlsfx 11.x.x + Maven)
  • From looking at their profile, they seem to be good with Java and FreeMarker.

Their most recently public accepted PR is: #2133

Copy link

Thank you for following naming conventions! 😻

Copy link

vercel bot commented May 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
javafx-tool ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 10, 2025 9:34am

Copy link

coderabbitai bot commented May 10, 2025

Walkthrough

本次变更主要包括三个方面:调整了依赖信息中的使用标记,扩充并重新排版了文档中的依赖列表,以及更新了文档侧边栏的结构和内容。此外,对部分配置文件进行了格式微调。

Changes

文件/分组 变更摘要
.idea/dictionaries 在 XML 文件末尾添加了换行符。
core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java 将 "org.apache.commons:commons-email" 1.6.0 的 inUsed 标记由 true 改为 false。
docs/README.md 增加并重新排版了依赖列表,新增多个依赖,移除 tess4j,调整表头格式。
docs/_sidebar.md “Examples” 改为 “Programs”,移除了 “Cg” 子栏目及其介绍链接。
docs/cg/Into.md, docs/develop/Into.md 删除了 docs/cg/Into.mddocs/develop/Into.md 两个介绍文件。
docs/develop/Interface.md 删除了文档末尾的三个章节标题:版本更新、freemarker、groovy。

Sequence Diagram(s)

(本次变更未涉及控制流或新功能的调整,无需生成时序图。)

Assessment against linked issues

Objective Addressed Explanation
开发文档补充(#1746

Suggested labels

dependencies

Suggested reviewers

  • DreamAwakenFateBroke

Poem

小兔挥笔写新篇,
依赖列表更齐全。
侧边栏里换新颜,
格式微调更自然。
文档补充乐无边,
咔咔咔,代码兔又向前! 🐇✨

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added documentation Improvements or additions to documentation core IDEA labels May 10, 2025
Copy link
Contributor

mergify bot commented May 10, 2025

Thanks for opening this pull request!
Please check out the Contributing Guidelines.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @DreamAwakenFateBroke - I've reviewed your changes - here's some feedback:

  • New dependencies are listed in docs/README.md (e.g., cssfx, commons-imaging); consider also adding their details to DependencyInfo.java if it serves as a programmatic reference for all dependencies.
  • commons-email is now marked as unused in DependencyInfo.java; verify if it should still be listed as 'used software' in docs/README.md.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
docs/README.md (1)

9-10: 校对依赖列表表头对齐格式
表格分隔符行已调整,请在多终端/多渲染器(GitHub、VSCode 插件等)下检查 Markdown 渲染结果,确保列宽及对齐符合预期。

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82c4a11 and 3924b10.

📒 Files selected for processing (4)
  • .idea/dictionaries (1 hunks)
  • core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java (1 hunks)
  • docs/README.md (1 hunks)
  • docs/_sidebar.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: build (21, macos-latest, false)
  • GitHub Check: build (21, windows-latest, false)
  • GitHub Check: build (21, ubuntu-latest, false)
  • GitHub Check: build (17, macos-latest, false)
  • GitHub Check: build (17, windows-latest, false)
  • GitHub Check: build (17, ubuntu-latest, false)
  • GitHub Check: qodana
  • GitHub Check: StepSecurity Harden-Runner
  • GitHub Check: Summary
🔇 Additional comments (2)
.idea/dictionaries (1)

6-6: 文件末尾添加新行符合编辑器规范
在 XML 文件末尾添加换行符有助于跨编辑器和工具的一致处理,建议保留此更改。

docs/_sidebar.md (1)

12-17: 更新侧边栏:将 “Examples” 重命名为 “Programs” 并移除 “Cg” 子项
已按 PR 目标将 “Examples” 模块更名为 “Programs”,并移除了 “Cg” 子菜单入口。请确认侧边栏缩进和链接格式正确,侧边栏渲染无误。

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

13-13: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


14-14: Unordered list indentation
Expected: 4; Actual: 8

(MD007, ul-indent)


15-15: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


16-16: Unordered list indentation
Expected: 4; Actual: 8

(MD007, ul-indent)

Copy link
Contributor

github-actions bot commented May 10, 2025

Qodana Community for JVM

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

Close #1746

Signed-off-by: IfGuestInDream <ifGuestInDream@163.com>
Close #1746

Signed-off-by: IfGuestInDream <ifGuestInDream@163.com>
Close #1746

Signed-off-by: IfGuestInDream <ifGuestInDream@163.com>
Copy link

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (1)
docs/README.md (1)

9-10: 校验表格头部格式及依赖版本

表格头部分隔线对齐良好,结构清晰。

  • 请核对新增依赖(如 cssfxcommons-imagingicnsimage4jjSerialCommteenyHttpd)的版本号是否与官方仓库一致。
  • 建议按字母或逻辑分组对依赖列表排序以提升可读性。
🧹 Nitpick comments (1)
docs/README.md (1)

5-5: 调整 controlsfx 版本标识以保持一致性

已将简介中 controlsfx11.x.x 简化为 11。建议:

  • 若项目仅面向 11.x 版本,可保留通用描述;
  • 若希望精确反映实际使用版本,可改为 controlsfx 11.2.2 与表格保持一致。
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3de98cf and de6cd99.

📒 Files selected for processing (7)
  • .idea/dictionaries (1 hunks)
  • core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java (1 hunks)
  • docs/README.md (1 hunks)
  • docs/_sidebar.md (1 hunks)
  • docs/cg/Into.md (0 hunks)
  • docs/develop/Interface.md (0 hunks)
  • docs/develop/Into.md (0 hunks)
💤 Files with no reviewable changes (3)
  • docs/develop/Interface.md
  • docs/cg/Into.md
  • docs/develop/Into.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • .idea/dictionaries
  • core/src/main/java/com/tlcsdm/core/util/DependencyInfo.java
  • docs/_sidebar.md
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: qodana
  • GitHub Check: build (21, windows-latest, false)
  • GitHub Check: build (21, ubuntu-latest, false)
  • GitHub Check: build (17, windows-latest, false)
  • GitHub Check: build (21, macos-latest, false)
  • GitHub Check: build (17, ubuntu-latest, false)
  • GitHub Check: build (17, macos-latest, false)
  • GitHub Check: StepSecurity Harden-Runner
  • GitHub Check: Summary

@unknowIfGuestInDream unknowIfGuestInDream merged commit c8f21aa into master May 10, 2025
32 checks passed
@unknowIfGuestInDream unknowIfGuestInDream deleted the docupd branch May 10, 2025 11:11
@coderabbitai coderabbitai bot mentioned this pull request May 11, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core documentation Improvements or additions to documentation IDEA size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] 开发文档补充
2 participants