under_score

dummdidumm · dummdidumm · commit c1e57a2f8339 · 2024-12-12T10:09:53.000+01:00
diff --git a/apps/svelte.dev/src/lib/server/content.ts b/apps/svelte.dev/src/lib/server/content.ts
@@ -19,7 +19,7 @@ const assets = import.meta.glob<string>(
 	}
 );
 
-export const documentsContent = import.meta.glob<string>('../../../content/**/*.md', {
+export const documents_content = import.meta.glob<string>('../../../content/**/*.md', {
 	eager: true,
 	query: '?raw',
 	import: 'default'
@@ -148,15 +148,15 @@ const DOCUMENTATION_NAMES: Record<string, string> = {
 	cli: 'Svelte CLI'
 };
 
-export function getDocumentationTitle(type: string): string {
+export function get_documentation_title(type: string): string {
 	return `This is the developer documentation for ${DOCUMENTATION_NAMES[type]}.`;
 }
 
-export function getDocumentationStartTitle(type: string): string {
+export function get_documentation_start_title(type: string): string {
 	return `# Start of ${DOCUMENTATION_NAMES[type]} documentation`;
 }
 
-export function filterDocsByPackage(
+export function filter_docs_by_package(
 	allDocs: Record<string, string>,
 	type: string
 ): Record<string, string> {
@@ -189,7 +189,7 @@ const defaultOptions: MinimizeOptions = {
 	normalizeWhitespace: false
 };
 
-function removeQuoteBlocks(content: string, blockType: string): string {
+function remove_quote_blocks(content: string, blockType: string): string {
 	return content
 		.split('\n')
 		.reduce((acc: string[], line: string, index: number, lines: string[]) => {
@@ -212,22 +212,22 @@ function removeQuoteBlocks(content: string, blockType: string): string {
 		.join('\n');
 }
 
-function minimizeContent(content: string, options?: Partial<MinimizeOptions>): string {
+function minimize_content(content: string, options?: Partial<MinimizeOptions>): string {
 	// Merge with defaults, but only for properties that are defined
 	const settings: MinimizeOptions = options ? { ...defaultOptions, ...options } : defaultOptions;
 
 	let minimized = content;
 
 	if (settings.removeLegacy) {
-		minimized = removeQuoteBlocks(minimized, 'LEGACY');
+		minimized = remove_quote_blocks(minimized, 'LEGACY');
 	}
 
 	if (settings.removeNoteBlocks) {
-		minimized = removeQuoteBlocks(minimized, 'NOTE');
+		minimized = remove_quote_blocks(minimized, 'NOTE');
 	}
 
 	if (settings.removeDetailsBlocks) {
-		minimized = removeQuoteBlocks(minimized, 'DETAILS');
+		minimized = remove_quote_blocks(minimized, 'DETAILS');
 	}
 
 	if (settings.removePlaygroundLinks) {
@@ -251,7 +251,7 @@ function minimizeContent(content: string, options?: Partial<MinimizeOptions>): s
 	return minimized;
 }
 
-function shouldIncludeFileLlmDocs(filename: string, ignore: string[] = []): boolean {
+function should_include_file_llm_docs(filename: string, ignore: string[] = []): boolean {
 	const shouldIgnore = ignore.some((pattern) => minimatch(filename, pattern));
 	if (shouldIgnore) {
 		if (dev) console.log(`❌ Ignored by pattern: ${filename}`);
@@ -268,7 +268,7 @@ interface GenerateLlmContentOptions {
 	package?: string;
 }
 
-export function generateLlmContent(
+export function generate_llm_content(
 	docs: Record<string, string>,
 	options: GenerateLlmContentOptions = {}
 ): string {
@@ -280,10 +280,10 @@ export function generateLlmContent(
 	}
 
 	let currentSection = '';
-	const paths = sortDocumentationPaths(Object.keys(docs));
+	const paths = sort_documentation_paths(Object.keys(docs));
 
 	for (const path of paths) {
-		if (!shouldIncludeFileLlmDocs(path, ignore)) continue;
+		if (!should_include_file_llm_docs(path, ignore)) continue;
 
 		// If a specific package is provided, only include its docs
 		if (pkg) {
@@ -293,7 +293,7 @@ export function generateLlmContent(
 			const docType = packages.find((p) => path.includes(`/docs/${p}/`));
 			if (!docType) continue;
 
-			const section = getDocumentationStartTitle(docType);
+			const section = get_documentation_start_title(docType);
 			if (section !== currentSection) {
 				if (currentSection) content += '\n';
 				content += `${section}\n\n`;
@@ -302,26 +302,26 @@ export function generateLlmContent(
 		}
 
 		content += `## ${path.replace('../../../content/', '')}\n\n`;
-		const docContent = minimizeOptions ? minimizeContent(docs[path], minimizeOptions) : docs[path];
+		const docContent = minimizeOptions ? minimize_content(docs[path], minimizeOptions) : docs[path];
 		content += docContent;
 		content += '\n';
 	}
 
 	return content;
 }
 
-function getDocumentationSectionPriority(path: string): number {
+function get_documentation_section_priority(path: string): number {
 	if (path.includes('/docs/svelte/')) return 0;
 	if (path.includes('/docs/kit/')) return 1;
 	if (path.includes('/docs/cli/')) return 2;
 	return 3;
 }
 
-export function sortDocumentationPaths(paths: string[]): string[] {
+export function sort_documentation_paths(paths: string[]): string[] {
 	return paths.sort((a, b) => {
 		// First compare by section priority
-		const priorityA = getDocumentationSectionPriority(a);
-		const priorityB = getDocumentationSectionPriority(b);
+		const priorityA = get_documentation_section_priority(a);
+		const priorityB = get_documentation_section_priority(b);
 		if (priorityA !== priorityB) return priorityA - priorityB;
 
 		// Get directory paths
diff --git a/apps/svelte.dev/src/routes/docs/[...path]/llms.txt/+server.ts b/apps/svelte.dev/src/routes/docs/[...path]/llms.txt/+server.ts
@@ -2,10 +2,10 @@ import type { RequestHandler } from './$types';
 import type { EntryGenerator } from './$types';
 import { error } from '@sveltejs/kit';
 import {
-	documentsContent,
-	filterDocsByPackage,
-	generateLlmContent,
-	getDocumentationTitle,
+	documents_content,
+	filter_docs_by_package,
+	generate_llm_content,
+	get_documentation_title,
 	packages
 } from '$lib/server/content';
 
@@ -22,14 +22,14 @@ export const GET: RequestHandler = async ({ params }) => {
 		error(404, 'Not Found');
 	}
 
-	const filteredDocs = filterDocsByPackage(documentsContent, packageType);
+	const filteredDocs = filter_docs_by_package(documents_content, packageType);
 
 	if (Object.keys(filteredDocs).length === 0) {
 		error(404, 'No documentation found for this package');
 	}
 
-	const PREFIX = `<SYSTEM>${getDocumentationTitle(packageType)}</SYSTEM>`;
-	const content = `${PREFIX}\n\n${generateLlmContent(filteredDocs)}`;
+	const PREFIX = `<SYSTEM>${get_documentation_title(packageType)}</SYSTEM>`;
+	const content = `${PREFIX}\n\n${generate_llm_content(filteredDocs)}`;
 
 	return new Response(content, {
 		status: 200,
diff --git a/apps/svelte.dev/src/routes/llms-full.txt/+server.ts b/apps/svelte.dev/src/routes/llms-full.txt/+server.ts
@@ -1,11 +1,11 @@
 import type { RequestHandler } from './$types';
-import { documentsContent, generateLlmContent } from '$lib/server/content';
+import { documents_content, generate_llm_content } from '$lib/server/content';
 
 const PREFIX =
 	'<SYSTEM>This is the full developer documentation for Svelte and SvelteKit.</SYSTEM>';
 
 export const GET: RequestHandler = async () => {
-	const content = `${PREFIX}\n\n${generateLlmContent(documentsContent)}`;
+	const content = `${PREFIX}\n\n${generate_llm_content(documents_content)}`;
 
 	return new Response(content, {
 		status: 200,
diff --git a/apps/svelte.dev/src/routes/llms.txt/+server.ts b/apps/svelte.dev/src/routes/llms.txt/+server.ts
@@ -1,11 +1,11 @@
 import type { RequestHandler } from './$types';
-import { documentsContent, generateLlmContent } from '$lib/server/content';
+import { documents_content, generate_llm_content } from '$lib/server/content';
 
 const PREFIX =
 	'<SYSTEM>This is the abridged developer documentation for Svelte and SvelteKit.</SYSTEM>';
 
 export const GET: RequestHandler = async () => {
-	const content = `${PREFIX}\n\n${generateLlmContent(documentsContent, {
+	const content = `${PREFIX}\n\n${generate_llm_content(documents_content, {
 		ignore: [
 			// Svelte ignores
 			'../../../content/docs/svelte/07-misc/04-custom-elements.md',
