summaryrefslogtreecommitdiff
path: root/apps/web/src/changelog/utils.ts
blob: 682d376a8df894faf41bc162ca08e2d1cb1f0ea5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
import { allChangelogs } from "content-collections";

export type Change = { type: string; text: string };
export type Release = (typeof allChangelogs)[number];

type ChangeSectionConfig = {
	title: string;
	order: number;
	collapsible?: boolean;
};

const knownSectionConfigs: Record<string, ChangeSectionConfig> = {
	new: { title: "Features", order: 0 },
	improved: { title: "Improvements", order: 1 },
	fixed: { title: "Fixes", order: 2 },
	breaking: { title: "Breaking Changes", order: 3 },
	technical: {
		title: "Technical details",
		order: 4,
		collapsible: true,
	},
};

function getSectionConfig({ type }: { type: string }): ChangeSectionConfig {
	return (
		knownSectionConfigs[type] ?? {
			title: type.charAt(0).toUpperCase() + type.slice(1),
			order: Number.MAX_SAFE_INTEGER,
		}
	);
}

export function getSectionTitle({ type }: { type: string }): string {
	return getSectionConfig({ type }).title;
}

export function isSectionCollapsible({ type }: { type: string }): boolean {
	return getSectionConfig({ type }).collapsible ?? false;
}

export function groupAndOrderChanges({ changes }: { changes: Change[] }) {
	const typeEncounterOrder = new Map<string, number>();
	const grouped = changes.reduce<Record<string, Change[]>>((acc, change) => {
		if (!typeEncounterOrder.has(change.type)) {
			typeEncounterOrder.set(change.type, typeEncounterOrder.size);
		}
		if (!acc[change.type]) acc[change.type] = [];
		acc[change.type].push(change);
		return acc;
	}, {});

	const orderedTypes = Object.keys(grouped).sort((left, right) => {
		const orderDifference =
			getSectionConfig({ type: left }).order -
			getSectionConfig({ type: right }).order;
		if (orderDifference !== 0) {
			return orderDifference;
		}
		return (
			(typeEncounterOrder.get(left) ?? Number.MAX_SAFE_INTEGER) -
			(typeEncounterOrder.get(right) ?? Number.MAX_SAFE_INTEGER)
		);
	});

	return { grouped, orderedTypes };
}

function isPublishedRelease({ published }: Release) {
	return published !== false;
}

export function getSortedReleases() {
	return allChangelogs
		.filter(isPublishedRelease)
		.sort((a, b) =>
			b.version.localeCompare(a.version, undefined, { numeric: true }),
		);
}

export function getReleaseByVersion({ version }: { version: string }) {
	return getSortedReleases().find((release) => release.version === version);
}