fix(registry): emit pyproject hints as standalone comments for tomlkit 0.15

[mattmillerai]

ELI-5

comfy node init writes a starter pyproject.toml with a couple of commented-out
"here's what you could put here" hints. It built those hints by handing tomlkit a
multi-line string. tomlkit 0.15.1 started rejecting that, so the command crashed —
and since tomlkit was unpinned, CI picked up the new release and the build check
went red on main and therefore on every open PR.

This writes each hint line as its own comment instead, which tomlkit is happy with,
and pins tomlkit so a future release can't break us silently again.

What was broken

Item.comment() now validates its argument and raises
ValueError("Comment cannot contain line breaks") on any \n (tomlkit/items.py:504).
Two call sites passed multi-line strings, so every call to create_comfynode_config()
raised — comfy node init was broken at runtime, not just in tests.

Reproduced on clean origin/main @ a732f5c with tomlkit 0.15.1: 9 failed (8 in
test_config_parser.py, 1 in test_node_init.py), matching the report exactly.

What changed

• _add_commented_hint() emits a hint one standalone tomlkit.comment() per line.
  The helper takes the block and splits it, so the hint text stays verbatim and the
  shape that caused the bug is now structurally impossible to reintroduce.
• The classifiers hint moved into create_comfynode_config. initialize_project_config
  reparses that file and only rewrites values, so this is the only point where the hint
  can be placed under license and before the [project.urls] sub-table.
• Pinned tomlkit>=0.13,<0.16 (defense-in-depth, as the ticket suggested).
• Two regression tests covering both hints: rendered position, inertness, and that
  uncommenting actually parses.

Rendered output is byte-identical to the pre-break version except two dropped
trailing spaces and one blank line (artifacts of the old inline attachment). Verified by
diffing this branch's comfy node init output against origin/main's under tomlkit 0.13.2.

Judgment calls (flagging for review)

1. I did not use the fix the ticket proposed, because it doesn't hold up. The ticket
   suggested includes.comment('"requires-comfyui" = ...'). That renders inline:
   includes = [] # "requires-comfyui" = ... — but the stated intent (and the code's own
   comment, "uncommentable hint") is a hint beneath the field that a user can uncomment
   in place. Inline, it can't be. A standalone comment preserves the original behavior
   exactly; I went with that.

2. The ticket's root cause was incomplete — there is a second call site. It named only
   config_parser.py:74-76, but that one is in create_comfynode_config; the 9 failing
   tests actually die at line 250 in initialize_project_config, a 17-line commented-out
   classifiers block. Fixing only the reported lines would have left CI red. Both are fixed.

3. Placement is load-bearing, and the obvious fix is wrong. Naively appending the
   classifiers comment to the project table renders it after [project.urls] — so
   uncommenting it would define classifiers under [project.urls], the wrong table. The
   test asserts the ordering; I verified it fails against that mutation.

4. Verified across the whole pinned range, not just the version I had installed — the
   affected tests pass under tomlkit 0.13.0 / 0.13.2 / 0.14.0 / 0.15.1. (At 0.13.0 blank
   hint lines render # vs #; cosmetic only, and the tests are not overfit to it.)

5. Left alone (pre-existing, out of scope): the # Used by Comfy Registry comment
   renders inside [project.urls] rather than at the top of the file. Same class of
   placement bug, but it predates this change — I confirmed identical output on origin/main
   — so it isn't part of this fix. Happy to file it separately.

6. Did not regenerate uv.lock. uv lock wants to pull in 286 lines of unrelated churn
   (main's lock is already stale w.r.t. the bench extra). CI installs via pip install -e .
   and doesn't enforce the lock, so this is a no-op for the build; keeping the diff scoped.

Verification

• ruff check . — pass
• ruff format --check . — pass (235 files)
• pytest — 2575 passed, 37 skipped (the 9 previously-failing tests now green)
• End-to-end: ran initialize_project_config() in a scratch git repo and diffed the real
  emitted pyproject.toml against origin/main's.

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 11 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d68fddaf-fb5e-4781-a16f-8ca5240667e8

📥 Commits

Reviewing files that changed from the base of the PR and between 1c35a2c and 1c0b1eb.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (1)

• pyproject.toml

📝 Walkthrough

Walkthrough

The TOML configuration parser now emits standalone commented classifiers and ComfyUI compatibility hints that survive project initialization. Tests verify placement, whitespace handling, and parsing after uncommenting, while tomlkit is constrained to a supported version range.

Changes

TOML hint generation

Layer / File(s)	Summary
Hint generation and configuration integration comfy_cli/registry/config_parser.py, pyproject.toml	Adds _add_commented_hint, emits classifiers and compatibility hints during configuration creation, preserves them during initialization, and constrains the tomlkit version.
Hint rendering and uncommenting tests tests/comfy_cli/registry/test_config_parser.py	Verifies hint placement, absence from active tables, whitespace handling, and valid parsing after comment markers are removed.

Suggested reviewers: robinjhuang, bigcat88

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch matt/be-3290-tomlkit-comment-fix

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch matt/be-3290-tomlkit-comment-fix

---

_{Comment @coderabbitai help to get the list of available commands.}

[github-actions]

🔍 Cursor Review — Consolidated panel

Triggered by @mattmillerai.

Found 1 finding(s).

Severity	Count
🟢 Low	1

Panel: 5/8 reviewers contributed findings.

Reviewers that did not contribute: kimi-k2.5:adversarial (empty), claude-opus-4-8-thinking-xhigh:edge-case (parse_error), kimi-k2.5:edge-case (empty)

[bigcat88]

This is a second, independent fix for the same tomlkit-0.15 breakage as #533 (also yours), which I approved yesterday. I ran the full comfy node init flow on both branches — the generated pyproject.toml files are equivalent apart from whitespace, so functionally either works. But as-is this one can't merge:

1. uv.lock is not relocked for the new tomlkit>=0.13,<0.16 bound (inline comment below).
2. Two PRs fixing the same thing can't both land — whichever merges second conflicts. Since #533 is already approved and its output is slightly cleaner (no trailing whitespace on the # separator lines — this branch renders them as "# "), my suggestion: close this one in favor of #533, and if you want to keep the tomlkit<0.16 upper bound, land it as a tiny follow-up with the relock included.
3. The CRLF rationale for the last commit doesn't hold up empirically (inline comment below).

[mattmillerai]

Thanks @bigcat88 — addressed all three inline points in 4a5dd5f:

1. uv.lock relocked for the tomlkit>=0.13,<0.16 bound; uv lock --check passes now.
2. CRLF rationale dropped — you're right that CPython's universal-newlines reading makes the \r scenario impossible; reworded the comment/test to the real reason (stripping the literal's surrounding blank lines).
3. Trailing whitespace fixed — blank separator lines now render as a bare # via Trivia(comment_ws="", comment="#"), matching fix(registry): emit pyproject hint blocks as single-line tomlkit comments #533. Confirmed zero trailing-whitespace lines in the generated file.

On close-vs-keep: that's a call for the author, not something I'll decide here. The two PRs do overlap, but this one additionally pins the tomlkit<0.16 upper bound (with the relock now included, per your own suggestion). If #533 is the preferred vehicle, close this; if the upper bound is wanted, this branch is now technically clean to land. Leaving the decision to @mattmillerai.

[mattmillerai]

Since #533 has merged (it landed the equivalent hint-rendering fix, confirmed against origin/main — same _append_hint/bare-#-separator approach), reworked this branch down to exactly the tiny follow-up you suggested: only the tomlkit>=0.13,<0.16 pin in pyproject.toml + a relocked uv.lock. Dropped the now-redundant config_parser.py/test changes and rebased clean onto main — no more conflict. uv lock --check and the full test suite pass.