Skip to content
internal/prose
Updated
On this page

The shared unit-pickers behind every summary selfdoc emits: a whole first sentence or paragraph, never truncated mid-word and never given punctuation.

#internal/prose

#internal/prose

Package prose holds the shared unit-pickers that extract complete linguistic units from text.

Every summary selfdoc emits (bullet text, frontmatter "description", llms.txt and Atom-feed entries, auto-extracted meta descriptions) is a complete linguistic unit: a whole first sentence or a whole first paragraph. There are no character caps, no ellipses and no synthesized punctuation -- the text is never truncated mid-word and never gains a period it did not already have.

Two granularities: [FirstSentence] returns the first sentence of the first paragraph, and [FirstParagraph] returns the whole first paragraph with its soft-wrapped lines joined into one line.

[JoinWrappedLines] normalizes source-wrapped prose (Go, JSDoc and KDoc doc comments wrap at about 75 columns) by joining soft-wrapped lines within a paragraph while leaving code blocks, list items and doctest lines verbatim.

#FirstParagraph

Go go
func FirstParagraph(text string) string

FirstParagraph returns the first paragraph of text as a single joined line.

Leading blank lines are skipped and the paragraph ends at the next blank line. Soft-wrapped physical lines within the paragraph are joined with a single space, so the result is one complete linguistic unit. No caps, no ellipsis, no synthesized punctuation.

#FirstSentence

Go go
func FirstSentence(text string) string

FirstSentence returns the first sentence of the first paragraph of text.

The sentence includes its terminating ".", "!" or "?". When the paragraph contains no sentence terminator the whole paragraph is returned unchanged -- a complete unit is always emitted and punctuation is never synthesized.

#JoinWrappedLines

Go go
func JoinWrappedLines(text string) string

JoinWrappedLines joins soft-wrapped physical lines within the paragraphs of text.

Doc comments (Go, JSDoc, KDoc) wrap at about 75 columns, so a single sentence spans several physical lines. This joins those lines within a paragraph so downstream unit-pickers see whole sentences. Preserved verbatim:

- blank-line paragraph breaks - fenced code blocks (``` and ~~~) - indented preformatted blocks (the Go doc convention) - list items ("-", "*", "+", "1.") - doctest lines (">>>" and "...") - ATX headings, which end the paragraph above and start nothing: a heading joined to the sentence under it becomes part of the heading

Idempotent: joining already-joined prose is a no-op.

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • rlsbl Release orchestration and project scaffolding CLI that bumps versions, validates a structured JSONL changelog, tags only the commit CI verified, and publishes to npm, PyPI, Go and more
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search