Skip to content

Adopt semantic line breaks; update tooling and dependencies - #46

Merged
morisil merged 1 commit into
mainfrom
docs/semantic-line-breaks
Aug 1, 2026
Merged

Adopt semantic line breaks; update tooling and dependencies#46
morisil merged 1 commit into
mainfrom
docs/semantic-line-breaks

Conversation

@morisil

@morisil morisil commented Aug 1, 2026

Copy link
Copy Markdown
Member

Documentation

Document the semantic line breaks convention in README.md and CLAUDE.md,
including how to enable Markdown soft wrapping in IntelliJ IDEA and VS Code,
and rewrap the existing prose in README.md and DEVELOPMENT.md accordingly.

Tooling and dependencies

  • Gradle wrapper 9.5.19.6.1
  • Kotlin 2.4.02.4.10
  • versions plugin 0.54.00.58.0
  • maven-publish plugin 0.36.00.37.0
  • JReleaser plugin 1.24.01.25.0
  • regenerated kotlin-js-store/yarn.lock

🤖 Generated with Claude Code

Document the semantic line breaks convention in README.md and CLAUDE.md,
including how to enable Markdown soft wrapping in IntelliJ IDEA and VS Code,
and rewrap the existing prose in README.md and DEVELOPMENT.md accordingly.

Update Gradle to 9.6.1, Kotlin to 2.4.10, the versions plugin to 0.58.0,
the maven-publish plugin to 0.37.0, the JReleaser plugin to 1.25.0,
and regenerate kotlin-js-store/yarn.lock.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@claude

claude Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review

Mostly a low-risk docs + dependency bump PR. A couple of things worth a look:

Structural: new convention doc lands in the "removable" zone of README.md

README.md has [//]: # (TODO everything starting from here can be removed in your project) right before ## Usage (README.md:32). The new ## Documentation conventions section (README.md:57) is added after that marker, alongside Usage/How?/Development. Since the semantic-line-breaks convention is meant to persist in derived projects (it's also codified in CLAUDE.md), a project generated from this template and following the TODO instruction would delete its only human-facing explanation of the convention (IDE soft-wrap setup, etc.), while CLAUDE.md still references README.md#markdown-soft-wrapping-in-the-ide. Consider moving this section above the TODO marker, or excluding it explicitly from "everything starting from here."

Style: new CLAUDE.md entry doesn't follow the file's own concision rule

CLAUDE.md's "Rules for editing this file" says: "Keep entries concise: one line per lesson, grouped under a heading if a theme emerges." The new ## Conventions / ### Markdown authoring block is two multi-line paragraphs — noticeably more verbose than the terse bullet style used everywhere else in the file. Not wrong to document (the "no line-length limit, never reflow" rule is genuinely non-obvious and worth flagging so an agent doesn't "fix" it), but worth tightening to match the file's stated style, or explicitly noting that longer entries are fine when the theme warrants a subsection.

Dependency/tooling bumps

Gradle 9.5.1→9.6.1, Kotlin 2.4.0→2.4.10, versions plugin 0.54.0→0.58.0, maven-publish 0.36.0→0.37.0, JReleaser 1.24.0→1.25.0, and a regenerated kotlin-js-store/yarn.lock — these look like routine patch/minor bumps. Nothing alarming in the transitive dependency changes I spot-checked (e.g. the cookie bump via engine.io lands on 0.7.2, which is past the cookie OOB-character advisory fix). Since these touch the wrapper and Kotlin/JS lockfile, it'd be good to confirm CI (build + JS tests) is green on this branch before merging — I didn't have permission to check gh pr checks from here.

Everything else

The semantic-line-breaks rewraps in DEVELOPMENT.md/README.md read cleanly and the anchor link README.md#markdown-soft-wrapping-in-the-ide correctly matches the new ### Markdown soft wrapping in the IDE heading. No functional code changed, so no test coverage gap here.

@morisil
morisil merged commit dd1b19f into main Aug 1, 2026
2 checks passed
@morisil
morisil deleted the docs/semantic-line-breaks branch August 1, 2026 20:35
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