Files
gerbeur/shared/mention.ts
khannurien f3f07ed1e3
All checks were successful
Build and Publish Docker Image / build-and-push (push) Successful in 49s
Build and Deploy Static Documentation Site / build-and-push (push) Successful in 22s
v3: every doc opens with the role, then the mechanism, then the details — the docs were written bottom-up: what a thing does first ("Declares the three contexts WSProvider fills…"), details that only make sense once its purpose is known next, and the reason it exists last ("…so that a feed doesn't re-render"), so a reader had nothing to hang the first sentences on. The README's rule caused it, since a module doc "opened with what the module does"; it now opens with the module's role in the app, and the value-side phrasing of a type ("Returned to Y by X") comes once the role is said, with WSContext as the before and after. WSContext.ts is rewritten that way throughout, and so are the docs elsewhere that buried their purpose in a trailing "so that" (the migrations, og, image-proxy, public-address, useFading, useFeedCache, the drafts), opened on a generic verb that hid it ("Holds", "Declares", "Loads", "Defines", "Types": the contexts and providers, the shared types, the models, the hooks), or were label fragments ("The page of a dump…", "A row of tabs."). A function whose verb is its action ("Stores session"), a props or result type, and a protocol message ("Sent by X when Y") already say their role and are left as they are. Only comments changed, and the catalogs only move their references; deno fmt, deno lint and doc:lint are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-29 21:42:08 +00:00

34 lines
1.3 KiB
TypeScript

/**
* Makes the server notify the same users the chat highlights and the editor
* suggests, by defining once what counts as an @mention.
*
* @module
*/
/**
* Matches an @username, with the name as its first group. The `@` must not
* follow a word character, so an email address mentions no one. Nor may it
* follow `[` or `(`, which leaves out a Markdown link's text or URL starting
* with `@`, and also a plain `(@name)`. The editor's suggestions match its
* source at the caret; the rest goes through {@link mentionedUsernames}.
* `Markdown` links mentions with a looser pattern of its own, on text already
* parsed, where code and URLs are out of the way.
*/
export const MENTION_RE: RegExp = /(?<![[(\w])@(\w+)/g;
/**
* Returns the names `body` mentions, in lower case, each once. Code, fenced
* or inline, and URLs mention no one, as `Markdown` shows them. The server
* notifies by it, and the chat highlights and chimes by it.
*/
export function mentionedUsernames(body: string): string[] {
const prose = body
// A fence left open runs to the end, as Markdown renders it.
.replace(/```[\s\S]*?(?:```|$)/g, " ")
.replace(/`[^`\n]*`/g, " ")
.replace(/https?:\/\/\S+/g, " ");
return [
...new Set([...prose.matchAll(MENTION_RE)].map((m) => m[1].toLowerCase())),
];
}