v3: comments say what the code can't — the documentation pass wanted JSDoc on every export and every field of an exported interface, which filled the code with restatements ("The dump.", "Whether it is loading.", "The props of X.", "Renders the X.") and module docs that told a reader nothing ("The hot and new feeds, and the props every main feed of the index takes."); some were wrong as well as vague. Every comment in api/, shared/ and src/ is rewritten under one rule, now stated in the README's "Comments" section: every module and export still has a JSDoc, and it gives context (who uses it and where), usage (what a caller must know: a precondition, what it leaves to the caller, a side effect) or its place in the chain (where its input comes from, where its output goes); a field, parameter, private function or local gets one only when it adds to its parent's, and context about a whole type goes on the type; a type's doc is phrased from the value's side ("Returned to Y by X when Z", "Passed to Y by X"); full sentences, as short as they can be, no label-colon-list; // goes wherever the code isn't obvious and says why, and the section banners and narration go. Every claim was checked against the code, which turned up some forty comments that were wrong: DumpCard's claimed it was only used by the hot and new feeds, the WebSocket welcome claimed to be a socket's first message (presence comes first), UpdateUserRequest said null removes a description (it keeps it), deletedDumpIds leaves out that it also holds dumps made private, THEME_COLOR claimed to mirror index.html's, and the like. The routers' JSDoc now says where they are mounted and what becomes of a thrown APIException. doc-lint.ts lets a field without a doc through; a module or export without one still fails. No code changes; 204 backend and 628 frontend tests pass, and doc:lint, deno check, deno lint and tsc are clean.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
/**
|
||||
* Turning a Bandcamp page into a queue for the site's own player.
|
||||
* Turns a Bandcamp page into a queue of streams for the site's own player.
|
||||
* `usePlayRichContent` calls it when a Bandcamp link is played in native mode,
|
||||
* and `streamSources.ts` again when the streams' signed URLs expire.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
@@ -8,23 +10,25 @@ import { API_URL } from "../../config/api.ts";
|
||||
import type { PlayerItem } from "../../contexts/player/PlayerContext.ts";
|
||||
import type { Tralbum, TralbumTrack } from "../../../shared/player.ts";
|
||||
|
||||
/** What the queue's items carry besides the tracks. */
|
||||
/**
|
||||
* Passed to {@link resolveBandcampQueue} by its callers and copied onto every
|
||||
* item of the queue, since the server's tracklist knows nothing of the dump.
|
||||
*/
|
||||
export interface BandcampContext {
|
||||
/** The page of the dump the release was posted in. */
|
||||
dumpHref?: string;
|
||||
/** Kept on every item so playback can fall back to the iframe later. */
|
||||
/** Lets PlayerProvider fall back to Bandcamp's iframe if the streams fail. */
|
||||
embedUrl?: string;
|
||||
/** Used only if the page carries no album art of its own. */
|
||||
fallbackArtworkUrl?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the Bandcamp page `pageUrl` into a playable queue, its items
|
||||
* carrying `ctx`. `force` skips the server's cache, for re-resolving after a
|
||||
* signature expires.
|
||||
* Resolves the Bandcamp page `pageUrl` into one `stream` item per streamable
|
||||
* track, through `GET /api/bandcamp/tracks`, each carrying `ctx`. `force`
|
||||
* bypasses the server's cache, for re-resolving once the signed URLs expire.
|
||||
*
|
||||
* @throws {Error} On any failure, no streamable track included — callers treat
|
||||
* that as "fall back to the embed".
|
||||
* @throws {Error} When the request fails or the page has no streamable track.
|
||||
* Callers then fall back to the embed.
|
||||
*/
|
||||
export async function resolveBandcampQueue(
|
||||
pageUrl: string,
|
||||
@@ -50,7 +54,7 @@ export async function resolveBandcampQueue(
|
||||
kind: "stream",
|
||||
streamUrl: t.streamUrl,
|
||||
type: "bandcamp",
|
||||
// The row names the track; the artist rides along on the subtitle line.
|
||||
// The header and the tracklist name the track; the artist goes below.
|
||||
title: t.title,
|
||||
subtitle: album.artist,
|
||||
duration: t.duration,
|
||||
|
||||
Reference in New Issue
Block a user