@xcwds/plugin-changelog

What's new for an @xcwds app on @xcwds/sveltekit: release notes on the settings page, a New badge on the ones the user hasn't seen yet, and a toast after an update that links to them.

// src/lib/changelog.ts: one entry per change people will notice, newest first
import type { ChangelogEntry } from '@xcwds/plugin-changelog';

export const changelog: ChangelogEntry[] = [
	{ id: 2, date: '2026-10-09', items: ['Timers keep ringing on every page.'] },
	{ id: 1, date: '2026-10-08', items: ['The first version.'] }
];

// xcwds.config.ts
import { defineConfig } from '@xcwds/core';
import changelog from '@xcwds/plugin-changelog';
import settings from '@xcwds/plugin-settings';
import shell from '@xcwds/plugin-shell';
import update from '@xcwds/plugin-update';
import { changelog as entries } from './src/lib/changelog.js';

export default defineConfig({
	brand,
	plugins: [shell({ sections }), settings(), update(), changelog({ entries })]
});

/* src/app.css, after Tailwind and the shell's styles */
@import '@xcwds/plugin-changelog/styles.css';

Options

entries: { id, date, items } newest first, with whole-number ids that grow (checked when the config loads). Keep them in their own module, as above: the config is plain data, so it takes the entries rather than a path to them.
show: how many entries What's new lists. Defaults to 10.
storageKey: where the newest entry seen is saved. Defaults to app:changelog:seen; set it to keep a key an app already uses.

What it does

A fresh install (or cleared data) badges nothing and saves nothing: until What's new is opened, the newest entry counts as seen. After an update, entries newer than the ones the old version had are badged until What's new shows them. The old version carries its newest id across with @xcwds/plugin-update's handover; when it carried none (it predates this plugin), only the newest entry counts as new.
After an update, app.toast (from @xcwds/plugin-shell) says "App updated." with a link to What's new when there is something new, and "App updated to the latest version." otherwise.
With @xcwds/plugin-settings, What's new is a section of the settings page (after About), at #whats-new. Without it, place <WhatsNew /> from @xcwds/plugin-changelog/WhatsNew.svelte inside <App> yourself.
app.changelog has entries, latest, seen(), markSeen() and subscribe(listener).

API

From the package's types and doc comments.

Options (ChangelogOptions)

entries? ChangelogEntry[]

The notes, newest first. Keep them in their own module and import it into xcwds.config.ts (entries: changelog), so each change adds one entry in one place.

entries.id number
entries.date string
entries.items string[]

show? number

How many entries What's new lists. Defaults to 10.

storageKey? string

Where the newest entry seen is saved, as a full key starting with the storage prefix. Defaults to app:changelog:seen.

Decorators

app.changelog? AppChangelog

From @xcwds/plugin-changelog.

app.changelog.entries readonly ChangelogEntry[]: The entries What's new lists (the newest show), newest first.
app.changelog.latest number: The newest entry's id, or 0.
app.changelog.seen () => number: The newest entry id the user has seen; entries above it are new.
app.changelog.markSeen () => void: Marks every entry seen (What's new does when it shows).
app.changelog.subscribe (listener: (seen: number) => void) => () => void: Calls listener now and whenever seen() changes; returns a function that stops it.

Edit this page on GitHub