Skip to content

simplify syncing logic #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2024
Merged

simplify syncing logic #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 12 additions & 31 deletions apps/svelte.dev/scripts/sync-docs/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ interface Package {
pkg: string;
docs: string;
process_modules: (modules: Modules, pkg: Package) => Promise<Modules>;
write: (modules: Modules) => Promise<void>;
}

const dirname = fileURLToPath(new URL('.', import.meta.url));
Expand Down Expand Up @@ -42,18 +41,6 @@ const packages: Package[] = [
}

return modules;
},
write: async (modules: Modules) => {
const files = glob(`${DOCS}/svelte/**/*.md`);

for (const file of files) {
const content = await replace_export_type_placeholders(
readFileSync(file, 'utf-8'),
modules
);

writeFileSync(file, content);
}
}
},
{
Expand Down Expand Up @@ -92,9 +79,6 @@ const packages: Package[] = [
});
}

return modules;
},
write: async (modules) => {
// TODO JSdoc points to kit.svelte.dev structure, rewrite those for now
for (const module of modules) {
replace_strings(module, (str) =>
Expand All @@ -118,7 +102,8 @@ const packages: Package[] = [
);
}

const svelte_kit_types = modules.find((m) => m.name === '@sveltejs/kit')!.types!;
const svelte_kit_module = modules.find((m) => m.name === '@sveltejs/kit');
const svelte_kit_types = svelte_kit_module!.types!;
const config = svelte_kit_types.find((t) => t.name === 'Config')!;
const kit_config = svelte_kit_types.find((t) => t.name === 'KitConfig')!;
const full_config = { ...config };
Expand All @@ -131,20 +116,9 @@ const packages: Package[] = [
config.comment = kit_config.comment =
'See the [configuration reference](/docs/kit/configuration) for details.';

const kit_files = glob(`${DOCS}/kit/**/*.md`);

for (const file of kit_files) {
const content = await replace_export_type_placeholders(
readFileSync(file, 'utf-8'),
!file.includes('configuration')
? modules
: modules.map((m) =>
m.name === '@sveltejs/kit' ? { ...m, types: [full_config, full_kit_config] } : m
)
);
svelte_kit_module!.types = [full_config, full_kit_config];

writeFileSync(file, content);
}
return modules;
}
}
];
Expand All @@ -171,5 +145,12 @@ for (const pkg of packages) {

const modules = await pkg.process_modules(await read_types(`${pkg.local}/${pkg.pkg}/`, []), pkg);
modules.sort((a, b) => (a.name! < b.name! ? -1 : 1));
await pkg.write(modules);

const files = glob(`${DOCS}/${pkg.name}/**/*.md`);

for (const file of files) {
const content = await replace_export_type_placeholders(readFileSync(file, 'utf-8'), modules);

writeFileSync(file, content);
}
}
Loading